资源

管理规则引擎的资源。资源是资源类型的实例，用于维护数据库连接等相关资源。

GET api/v4/resources/{resource_id}

获取指定的资源的详细信息。

Path Parameters:

NameTypeRequiredDescription
resource_idStringFalse可选，资源类型 ID。如不指定 resource_id 则
以数组形式返回当前所有的资源。

Success Response Body (JSON):

NameTypeDescription
codeInteger0
dataObject规则对象
- data.idString资源 ID
- data.typeString资源所从属的资源类型的名字。
- data.configObject资源的配置。参数以 key-value 形式表示。
详情可参看后面的示例
- data.statusArray资源的状态信息。详情请参看 Dashboard 上资源的状态。
- data.descriptionObject资源的描述信息，中英文。

POST /api/v4/resources

创建规则，返回资源 ID。

Parameters (json):

NameTypeRequiredDescription
typeStringTrue资源类型名。指定要使用哪个资源类型创建资源。
configObjectTrue资源参数。要跟对应的资源类型的 params 里指定的格式相一致。
descriptionStringFalse可选，资源描述

Success Response Body (JSON):

NameTypeDescription
codeInteger0
dataObject规则对象
- data.idString资源 ID
- data.typeString资源所从属的资源类型的名字。
- data.configObject资源的配置。参数以 key-value 形式表示。
详情可参看后面的示例
- data.descriptionObject资源的描述信息，中英文。

DELETE /api/v4/resources/{resource_id}

删除资源。

Parameters: 无

Success Response Body (JSON):

NameTypeDescription
codeInteger0

Examples:

创建一个 webhook 资源，webserver 的 URL 为 http://127.0.0.1:9910 ：

  1. $ curl -XPOST -d '{
  2.   "type": "web_hook",
  3.   "config": {
  4.       "url": "http://127.0.0.1:9910",
  5.       "headers": {"token":"axfw34y235wrq234t4ersgw4t"},
  6.       "method": "POST"
  7.   },
  8.   "description": "web hook resource-1"
  9. }' --basic -u admin:public 'http://localhost:8081/api/v4/resources'
  11. {"data":{"type":"web_hook","id":"resource:b12d3e44","description":"web hook resource-1","config":{"url":"http://127.0.0.1:9910","method":"POST","headers":{"token":"axfw34y235wrq234t4ersgw4t"}}},"code":0}

使用资源 ID 查询刚创建的资源：

  1. $ curl --basic -u admin:public 'http://localhost:8081/api/v4/resources/resource:b12d3e44'
  3. {"data":{"type":"web_hook","status":[{"node":"emqx@127.0.0.1","is_alive":false}],"id":"resource:b12d3e44","description":"web hook resource-1","config":{"url":"http://127.0.0.1:9910","method":"POST","headers":{"token":"axfw34y235wrq234t4ersgw4t"}}},"code":0}

查询当前已创建的所有的资源：

  1. $ curl --basic -u admin:public 'http://localhost:8081/api/v4/resources'
  3. {"data":[{"type":"web_hook","id":"resource:b12d3e44","description":"web hook resource-1","config":{"url":"http://127.0.0.1:9910","method":"POST","headers":{"token":"axfw34y235wrq234t4ersgw4t"}}}],"code":0}

删除资源:

  1. $ curl -XDELETE --basic -u admin:public 'http://localhost:8081/api/v4/resources/resource:b12d3e44'
  3. {"code":0}