文档

ListSubscriptionByTopic - 列出主题下的Subscription列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

主题的名称。

test
PageNumlong

分页页码,查询第几页的返回结果。 取值范围:1~100000000。 若您设置的参数值小于 1,则系统默认按照参数值为 1 处理;若您设置的参数值大于 100000000,则系统默认按照参数值为 100000000 处理。

1
PageSizelong

分页大小,每页最多显示的返回结果数量。 取值范围:10~50。 若您设置的参数值小于 10,则系统默认按照参数值为 10 处理;若您设置的参数值大于 50,则系统默认按照参数值为 50 处理。

20
SubscriptionNamestring

Subscription 的名称。

demo-subscription

返回参数

名称类型描述示例值
object
RequestIdstring

请求的 ID。

06273500-249F-5863-121D-74D51123****
Codelong

响应 code。

200
Statusstring

响应的状态。

Success
Messagestring

响应信息。

operation success
Successboolean

请求是否成功。

true
Dataobject

响应数据。

PageNumlong

分页页码,查询此页的返回结果。

1
PageSizelong

分页大小,每页最多显示的返回结果数量。

50
Sizelong

当前页结果数量。

20
Pageslong

总页数

3
Totallong

总结果数。

130
PageDataarray<object>

当前页返回结果。

object

数据项

SubscriptionNamestring

Subscription 的名称。

MySubscription
TopicOwnerstring

Subscription 订阅的主题所有者的 AccountId。

123456789098****
TopicNamestring

Subscription 订阅的主题名称。

MyTopic
Endpointstring

订阅的终端地址。

http://example.com
FilterTagstring

描述了该订阅中消息过滤的标签(仅标签一致的消息才会被推送)。

important
CreateTimelong

Subscription 的创建时间,从 1970-01-01 00:00:00 到现在的。

1449554806
LastModifyTimelong

最近一次修改 Subscription 属性信息的时间,从 1970-01-01 00:00:00 到现在的秒值。

1449554806
NotifyStrategystring

向 Endpoint 推送消息错误时的重试策略。取值说明如下:

  • BACKOFF_RETRY:退避重试。

  • EXPONENTIAL_DECAY_RETRY:指数衰减重试。

BACKOFF_RETRY
NotifyContentFormatstring

向 Endpoint 推送的消息内容格式。 取值说明如下:

  • XML

  • JSON

  • SIMPLIFIED

XML

示例

正常返回示例

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"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-31API 内部配置变更,不影响调用查看变更详情
2024-06-17API 内部配置变更,不影响调用查看变更详情