文档

ListRules - 查询一个事件总线的所有规则

更新时间:
一键部署

查询一个事件总线的所有规则。

接口说明

查询一个事件总线的所有规则。

调试

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

授权信息

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

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

请求参数

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

规则名称前缀。

test
Limitinteger

限定每次返回的最大条数,可以和 NextToken 搭配使用实现翻页能力。

注意 每次返回的最大条数不超过 100。

50
NextTokenstring

当指定 Limit 时,如果还有多余的返回值则会返回 NextToken。

1000
EventBusNamestring

事件总线的名称。

default

返回参数

名称类型描述示例值
object
Messagestring

错误信息。

Specified parameter Limit is not valid.
RequestIdstring

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

C7043799-F4DA-5290-9249-97C35987****
Dataobject

返回数据。

NextTokenstring

如果还有多余的返回值则会返回 NextToken。

1000
Totalinteger

总条数。

6
Rulesobject []

规则列表。

DetailMapobject

详细信息。

Statusstring

规则的状态。取值说明如下:

  • ENABLE:规则已启用。规则默认状态。

  • DISABLE:规则已禁用。

ENABLE
EventBusNamestring

事件总线的名称。

demo
RuleARNstring

规则 ARN。

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

规则描述。

demo
Targetsobject []

事件目标列表。

Typestring

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

acs.mns.queue
Endpointstring

投递端点链接。

acs:mns:cn-hangzhou:123456789098****:queues/myqueue
Idstring

自定义事件目标 Id。

Mlm123456JHd2Rs****
PushSelectorstring

发布选择器

PARAM_TRANSFORMER
ErrorsTolerancestring

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

ALL
FilterPatternstring

事件模式,JSON 格式。取值说明如下:

  • stringEqual 模式:每个 field 最多 5 个 expression(map 结构)。

  • stringExpression 模式:每个 field 最多 5 个 expression(map 结构)。

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

创建时间戳。

1607071602000
RuleNamestring

事件规则的名称

tf-testacc-rule
Codestring

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

Success
Successboolean

操作成功返回 true。

true

示例

正常返回示例

JSON格式

{
  "Message": "Specified parameter Limit is not valid.",
  "RequestId": "C7043799-F4DA-5290-9249-97C35987****",
  "Data": {
    "NextToken": "1000",
    "Total": 6,
    "Rules": [
      {
        "DetailMap": {
          "test": "test",
          "test2": 1
        },
        "Status": "ENABLE",
        "EventBusName": "demo",
        "RuleARN": "acs:eventbridge:cn-hangzhou:123456789098****:eventbus/default/rule/myRule3",
        "Description": "demo",
        "Targets": [
          {
            "Type": "acs.mns.queue\n",
            "Endpoint": "acs:mns:cn-hangzhou:123456789098****:queues/myqueue",
            "Id": "Mlm123456JHd2Rs****",
            "PushSelector": "PARAM_TRANSFORMER",
            "ErrorsTolerance": "ALL"
          }
        ],
        "FilterPattern": "{\\\"source\\\":[\\\"acs.oss\\\"],\\\"type\\\":[\\\"oss:BucketQueried:GetBucketStat\\\"]}\n",
        "CreatedTimestamp": 1607071602000,
        "RuleName": "tf-testacc-rule"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈