ListEventRules - 获取事件规则列表_轻量消息队列（原 MNS）(SMQ)-阿里云帮助中心

查询事件通知列表

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mns:ListEventRules

list

*Topic

acs:mns:{#regionId}:{#accountId}:/products/{#ProductName}/rules

无

请求参数

名称	类型	必填	描述	示例值
ProductName	string	否	事件通知云产品名称	oss
ResourceName	string	否	匹配规则中的资源名称，用于过滤规则，例：oss 中，此为 oss bucketName	test-bucket
RuleName	string	否	规则名称	rule-xsXDW
TopicName	string	否	主题的名称。	test-topic
Subscription	object	否	订阅端
EndpointType	string	否	接入点类型。取值： topic：主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。 queue：队列类型。直接投递到队列。可以减少链路路径，但后续不可增加新的订阅接收端。	topic
EndpointValue	string	否	接收终端实际值	test-topic
PageNum	integer	否	分页页码，查询第几页的返回结果。取值范围：1~100000。若您设置的参数值小于 1，则系统默认按照参数值为 1 处理；若您设置的参数值大于 100000，则系统默认按照参数值为 100000 处理。	1
PageSize	integer	否	分页大小，每页最多显示的返回结果数量。取值范围：10~50。若您设置的参数值小于 10，则系统默认按照参数值为 10 处理；若您设置的参数值大于 50，则系统默认按照参数值为 50 处理。	20
NextToken	string	否	已废弃字段。请使用 PageNum 分页查询。	cd7NlPlX4kgKCdsCWMiMR/+HnVzPLQ4/XLvjR64jZ7F9AQ+Mr3T59J6IVkuXeV3w
MaxResults	integer	否	已废弃字段。请使用 PageSize 分页查询	50

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID。	06273500-249F-5863-121D-74D51123E62C
Code	integer	响应 code。	200
Status	string	响应的状态。	Success
Message	string	响应信息。	operation success
Success	boolean	请求是否成功。	true
Data	object	响应数据。
PageNum	integer	分页页码，查询第几页的返回结果。	1
PageSize	integer	分页大小，每页最多显示的返回结果数量。	50
Size	integer	当前页结果数量。	20
Pages	integer	总页数	3
Total	integer	总结果数。	130
NextToken	string	已废弃字段。分页查询以 PageNum 为准	a88f58d504b8b4c4e0b5e8707e68181f
MaxResults	integer	已废弃字段。分页最大结果集以 Total 为准	1
PageData	array<object>	数据项
	object	数据项。
Endpoint	object	订阅的终端地址。
EndpointValue	string	接收终端实际值	test-topic
EndpointType	string	接入点类型。取值： topic：主题类型。主题支持投递到多个订阅接收端。后续也可以增加或删除订阅接收端。 queue：队列类型。直接投递到队列。可以减少链路路径，但后续不可增加新的订阅接收端。	topic
Subscriptions	array<object>	订阅端。限制最大返回条数 20，如果超过请使用订阅列表查询。
	object
EndpointValue	string	接收终端实际值	wyx-vp-complete-queue
EndpointType	string	接入点类型。	queue
DeliveryMode	string	已废弃字段	--
MatchRules	array	事件匹配规则,or 关系
	array	事件匹配规则,or 关系
	EventMatchRule	匹配规则，多个规则之间 or 关系	[[{\"MatchState\":true,\"Prefix\":\"cdhxdev1cdh-bba-dto-052901-sem-5seh/\",\"Suffix\":\"\"}]]
EventTypes	array	事件类型列表
	string	事件类型列表	["oss:ObjectCreated:CopyObject"]
RuleName	string	事件通知规则名称。	rule-xsXDW
TopicName	string	主题的名称。	demo-topic

示例

正常返回示例

JSON格式

{
  "RequestId": "06273500-249F-5863-121D-74D51123E62C",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Size": 20,
    "Pages": 3,
    "Total": 130,
    "NextToken": "a88f58d504b8b4c4e0b5e8707e68181f",
    "MaxResults": 1,
    "PageData": [
      {
        "Endpoint": {
          "EndpointValue": "test-topic",
          "EndpointType": "topic"
        },
        "Subscriptions": [
          {
            "EndpointValue": "wyx-vp-complete-queue",
            "EndpointType": "queue"
          }
        ],
        "DeliveryMode": "--",
        "MatchRules": [
          [
            {
              "MatchState": true,
              "Name": "testBucket/folder1/file1",
              "Prefix": "testBucket/prefix1xxx",
              "Suffix": "suffix/xxxx.test"
            }
          ]
        ],
        "EventTypes": [
          "[\"oss:ObjectCreated:CopyObject\"]"
        ],
        "RuleName": "rule-xsXDW",
        "TopicName": "demo-topic"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。