GetRule - 获取一个事件规则的详细信息

获取一个事件规则的详细信息。

接口说明

获取一个事件规则的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eventbridge:GetRuleget
*Rule
acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/rule/{#RuleName}

请求参数

名称类型必填描述示例值
EventBusNamestring

事件总线的名称。

default
RuleNamestring

规则名称。

ram-changes

返回参数

名称类型描述示例值
object
Messagestring

错误信息。

The event rule not existed!
RequestIdstring

阿里云为该请求生成的唯一标识符。

2BC1857D-E633-5E79-B2C2-43EF5F7730D8
Dataobject

返回结果。

Statusstring

规则的状态。取值说明如下: ENABLE:规则已启用。规则默认状态。 DISABLE:规则已禁用。

ENABLE
EventBusNamestring

事件总线的名称。

Housekeeping-Bus
RuleARNstring

规则 ARN。

acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3
Descriptionstring

规则说明。

test
Targetsarray<object>

事件目标列表。

Targetsobject

事件目标。

DetailMapobject

详细信息

Typestring

事件目标类型。更多信息,请参见事件目标参数

acs.mns.queue
Endpointstring

投递端点链接。

acs:mns:cn-hangzhou:123456789098****:queues/myqueue
ParamListarray<object>

事件目标的参数列表。

ParamListobject

事件目标的参数。

Valuestring

事件目标参数的值。

{\"key\"=\"value\"}
Templatestring

事件目标参数模板样式。

The value of ${key} is ${value}!
Formstring

事件目标参数的格式。更多信息,请参见使用限制

TEMPLATE
ResourceKeystring

事件目标的资源参数。更多信息,请参见使用限制

body
PushSelectorstring

发布选择器

PARAM_TRANSFORMER
Idstring

自定义事件目标 Id。

Mlm123456JHd2RsRoKw
DeadLetterQueueobject

死信队列

Arnstring

查询到的死信队列在阿里云上的统一资源标识(ARN)。

acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source
PushRetryStrategystring

推送重试策略。取值说明如下: 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)。

BACKOFF_RETRY
ErrorsTolerancestring

容错策略。取值说明如下: ALL:允许容错。允许异常容错,当异常发生时不会阻塞执行,超过重试策略后会根据配置将消息投递至死信队列或直接丢弃。 NONE:禁止容错。不允许容错,当异常发生并超过重试策略配置时会阻塞执行。

ALL
FilterPatternstring

事件模式,JSON 格式。取值说明如下: stringEqual 模式。 stringExpression 模式 。 每个 field 最多 5 个 expression(map 结构)。

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

{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}
CreatedTimestamplong

创建时间(时间戳)

1607071602000
RuleNamestring

规则名称。

ramrolechange-fc
Codestring

接口返回码:Success:表示成功。 其它:表示错误码。错误码详情,请参见错误码。

Success
Successboolean

操作成功返回 true。

true

示例

正常返回示例

JSON格式

{
  "Message": "The event rule not existed!",
  "RequestId": "2BC1857D-E633-5E79-B2C2-43EF5F7730D8",
  "Data": {
    "Status": "ENABLE",
    "EventBusName": "Housekeeping-Bus",
    "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
    "Description": "test",
    "Targets": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Type": "acs.mns.queue",
        "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
        "ParamList": [
          {
            "Value": "{\\\"key\\\"=\\\"value\\\"}",
            "Template": "The value of ${key} is ${value}!",
            "Form": "TEMPLATE",
            "ResourceKey": "body"
          }
        ],
        "PushSelector": "PARAM_TRANSFORMER",
        "Id": "Mlm123456JHd2RsRoKw\n",
        "DeadLetterQueue": {
          "Arn": "acs:eventbridge:cn-hangzhou:164901546557****:eventbus/my-event-bus/eventsource/myRocketMQ.source"
        },
        "PushRetryStrategy": "BACKOFF_RETRY",
        "ConcurrentConfig": {
          "Concurrency": 0
        },
        "ErrorsTolerance": "ALL"
      }
    ],
    "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}",
    "CreatedTimestamp": 1607071602000,
    "RuleName": "ramrolechange-fc"
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code错误码错误信息
403ServiceNotEnableService not enable

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情