使用GetRule获取规则的详细信息。

URI

/openapi/getRule

请求参数

名称 类型 是否必选 示例值 描述
EventBusName String default 事件总线(EventBus)名称。详情请参见使用限制
RuleName String myRule3 事件规则名称。详情请参见使用限制

返回参数

名称 类型 示例值 描述
EventBusName String default 事件总线(EventBus)名称。
RuleARN String acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3 规则ARN。
RuleName String myRule3 规则名称。
Description String test 规则描述。
Status String ENABLE 规则的状态。取值说明如下:
  • ENABLE:规则已启用。规则默认状态。
  • DISABLE:规则已禁用。
FilterPattern String {\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]} 事件过滤模式。
Targets List<Target> 如示例 事件目标。
表 1. Targets数据结构列表
字段名 字段类型 是否必选 示例值 描述
Id String 1234 自定义TargetId。
Type String http 目标Target类型,请参见产品功能
Endpoint String http://www.myhost.com 投递端点链接。
PushSelector String DATA_OF_EVENT 投递事件时的字段选择器。取值说明如下:
  • MATCHED_EVENT:投递完整事件。
  • DATA_OF_EVENT:投递部分字段。
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)。

示例

请求示例

POST /openapi/getRule 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: EVENTBRIDGE vZ3VL0SuJdHiEmvU:Jo2PbTj******zYAYoYslKLvWzg=
Content-Type: text/xml;charset=UTF-8
Content-Length: 26

{
    "EventBusName": "default",
    "RuleName": "myRule3"
}

返回示例

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

{
    "EventBusName": "default",
    "Description: "test",
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
    "RuleName": "myRule3",
    "Status": "ENABLE",
    "FilterPattern": "{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}",
    "Targets": [{
        "Id": "1234",
        "Type": "http",
        "Endpoint": "http://www.myhost.com",
        "PushSelector": "DATA_OF_EVENT",
        "PushRetryStrategy": "BACKOFF_RETRY"
    }]
}