调用ListRules接口查询所有规则,可以结合Limit和NextToken进行翻页。

URI

/openapi/listRules

请求参数

名称 类型 是否必选 示例值 描述
EventBusName String default 更多信息,请参见使用限制
RuleNamePrefix String my 事件规则名称。更多信息,请参见使用限制
Limit String 10 限定每次返回的最大条数,可以和NextToken搭配使用实现翻页能力。
NextToken String 5 当指定Limit时,如果还有多余的返回值则会返回NextToken。

返回参数

名称 类型 示例值 描述
NextToken String 5 下次翻页请求的偏移量。如果翻页请求还有更多数据可以获取,则会返回NextToken。
Rules List<Rule> 查询到的规则。
EventBusName String default 事件总线的名称。
RuleARN String acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule1 事件规则的ARN,用于授权。
RuleName String myRule1 事件规则的名称。
Status String ENABLE 规则的状态。取值说明如下:
  • ENABLE:规则已启用。规则默认状态。
  • DISABLE:规则已禁用。
FilterPattern String
{\"source\":[\"acs.oss\"],\"type\":[\"oss:ObjectCreated:UploadPart\"]}
事件模式,JSON格式。取值说明如下:
  • stringEqual模式。
  • stringExpression模式 。

    每个field最多5个expression(map结构)。

每个field最多5个expression(map结构)。

Targets List<Target> 事件的投递目标。
Id String target1 自定义TargetId。
Type String http 目标Target类型。
Endpoint String http://www.example.com 投递端点链接。
PushRetryStrategy String BACKOFF_RETRY 推送重试策略。取值说明如下:
  • BACKOFF_RETRY:退避重试策略。重试3次,每次重试的间隔时间是10秒到20秒之间的随机值。
  • EXPONENTIAL_DECAY_RETRY:指数衰减重试。重试176次,每次重试的间隔时间指数递增至512秒,总计重试时间为1天;每次重试的具体间隔为:1,2,4,8,16,32,64,128,256,512,512...512秒(共167个512)。
ParamList List<Param> 事件传递的参数。
resourceKey String body 事件转换的资源参数。更多信息,请参见事件目标参数
form String TEMPLATE 事件转换的格式。更多信息,请参见事件目标参数
value String
{\"key\"=\"value\"}
事件转换的值。
template String The value of ${key} is ${value}! 模板样式。

示例

请求示例

POST /openapi/listRules HTTP/1.1
Host: 123456789098****.eventbridge.cn-hangzhou.aliyuncs.com
Date: Sat, 18 Apr 2020 05:30:41 GMT
x-eventbridge-version: 2020-04-01
Authorization: acs vZ3VL0SuJdHi****:Jo2PbTj****zYAYoYslKLvWzg=
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
    "EventBusName":"default",
    "RuleNamePrefix":"my",
    "Limit":"10",
    "NextToken":"5"
}

返回示例

HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 5E9A9081333245F1D800****
Date: Sat, 18 Apr 2020 05:30:41 GMT

{
    "NextToken":"5",
    "Rules":[
        {
            "EventBusName":"default",
            "RuleARN":"acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule1",
            "RuleName":"myRule1",
            "status":"ENABLE",
            "FilterPattern":"{\"source\":[\"acs.oss\"],\"type\":[\"oss:ObjectCreated:UploadPart\"]}",
            "Targets":[
                {
                    "Id":"target1",
                    "Type":"http",
                    "Endpoint":"http://www.example.com",
                    "PushRetryStrategy":"EXPONENTIAL_DECAY_RETRY"
                }
            ],
            "ResourceKeys":[
                {
                    "form":"CONSTANT",
                    "resourceKey":"url"
                },
                {
                    "form":"TEMPLATE",
                    "resourceKey":"body"
                }
            ]
        }
    ]
}