使用ListSubscriptionByTopic分页查询主题下的Subscription列表-轻量消息队列（原 MNS）-阿里云

调用ListSubscriptionByTopic接口列出某个主题下的Subscription列表，可分页获取数据。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

mns:ListSubscriptionByTopic

list

*Subscription

acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}/subscriptions

无

请求参数

名称	类型	必填	描述	示例值
TopicName	string	否	主题的名称。	test
PageNum	integer	否	分页页码，查询第几页的返回结果。取值范围：1~100000000。若您设置的参数值小于 1，则系统默认按照参数值为 1 处理；若您设置的参数值大于 100000000，则系统默认按照参数值为 100000000 处理。	1
PageSize	integer	否	分页大小，每页最多显示的返回结果数量。取值范围：10~50。若您设置的参数值小于 10，则系统默认按照参数值为 10 处理；若您设置的参数值大于 50，则系统默认按照参数值为 50 处理。	20
SubscriptionName	string	否	Subscription 的名称。	demo-subscription
EndpointType	string	否
EndpointValue	string	否

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID。	06273500-249F-5863-121D-74D51123****
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
PageData	array<object>	当前页返回结果。
	array<object>	数据项
SubscriptionName	string	Subscription 的名称。	MySubscription
TopicOwner	string	Subscription 订阅的主题所有者的 AccountId。	123456789098****
TopicName	string	Subscription 订阅的主题名称。	MyTopic
Endpoint	string	订阅的终端地址。	http://example.com
FilterTag	string	描述了该订阅中消息过滤的标签（仅标签一致的消息才会被推送）。	important
CreateTime	integer	Subscription 的创建时间，从 1970-01-01 00:00:00 到现在的。	1449554806
LastModifyTime	integer	最近一次修改 Subscription 属性信息的时间，从 1970-01-01 00:00:00 到现在的秒值。	1449554806
NotifyStrategy	string	向 Endpoint 推送消息错误时的重试策略。取值说明如下： BACKOFF_RETRY：退避重试。 EXPONENTIAL_DECAY_RETRY：指数衰减重试。	BACKOFF_RETRY
NotifyContentFormat	string	向 Endpoint 推送的消息内容格式。取值说明如下： XML JSON SIMPLIFIED	XML
DlqPolicy	object	死信策略
Enabled	boolean	是否开启死信消息投递	true
DeadLetterTargetQueue	string	死信消息投递目标队列	dead-letter-queue

示例

正常返回示例

JSON格式

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Size": 20,
    "Pages": 3,
    "Total": 130,
    "PageData": [
      {
        "SubscriptionName": "MySubscription",
        "TopicOwner": "123456789098****",
        "TopicName": "MyTopic",
        "Endpoint": "http://example.com",
        "FilterTag": "important\n",
        "CreateTime": 1449554806,
        "LastModifyTime": 1449554806,
        "NotifyStrategy": "BACKOFF_RETRY",
        "NotifyContentFormat": "XML",
        "DlqPolicy": {
          "Enabled": true,
          "DeadLetterTargetQueue": "dead-letter-queue"
        }
      }
    ]
  }
}

错误码

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

变更历史

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