动作

查询规则引擎的动作。注意动作只能由 emqx 提供,不能添加。

GET api/v4/actions/{action_name}

获取某个动作的详情,包括动作名字、参数列表等。

Path Parameters:

NameTypeRequiredDescription
action_nameStringFalse可选,动作名。如不指定 action_name 则
以数组形式返回当前支持的所有动作。

Success Response Body (JSON):

NameTypeDescription
codeInteger0
dataObject规则对象
- data.typesString指示当前动作从属于那些资源类型
- data.titleObject动作的简述,中英文。
- data.paramsObject动作的参数列表。参数以 key-value 形式表示。
详情可参看后面的示例
- data.descriptionObject动作的描述信息,中英文。
- data.appString动作的提供者

Examples:

查询 inspect 动作的详情:

  1. $ curl --basic -u admin:public 'http://localhost:8081/api/v4/actions/inspect'
  2. {"data":{"types":[],"title":{"zh":"检查 (调试)","en":"Inspect (debug)"},"params":{},"name":"inspect","for":"$any","description":{"zh":"检查动作参数 (用以调试)","en":"Inspect the details of action params for debug purpose"},"app":"emqx_rule_engine"},"code":0}

查询当前所有的动作:

  1. $ curl --basic -u admin:public 'http://localhost:8081/api/v4/actions'
  2. {"data":[{"types":[],"title":{"zh":"空动作 (调试)","en":"Do Nothing (debug)"},"params":{},"name":"do_nothing","for":"$any","description":{"zh":"此动作什么都不做,并且不会失败 (用以调试)","en":"This action does nothing and never fails. It's for debug purpose"},"app":"emqx_rule_engine"}, ...],"code":0}