调用ListTopic接口查询阿里云账号下的主题列表,可分页获取数据。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见授权策略和示例。
Name | Value |
---|---|
API | ListTopic |
RAM授权操作 | mns:ListTopic |
资源 | acs:mns:$region:$accountid:/topics |
使用说明
如果只需要获取特定的主题列表,在调用接口时指定x-mns-prefix
参数,服务端将返回主题名称与前缀匹配的主题列表。
注意 如果本次请求结果返回的主题总数超过本次请求的
x-mns-ret-number
参数值,返回的XML结果中包含的NextMarker
表示下一页开始位置,在下一次请求时将该值赋予x-mns-marker
参数以返回下一页的结果。
请求消息
请求消息由请求行、HTTP头和消息体三部分组成:
- 请求行
GET /topics HTTP/1.1
- 特有Request Header
参数名称 类型 是否必选 示例值 描述 x-mns-marker Integer 否 10 请求下一个分页的开始位置,从上次分页结果返回的 NextMarker
获取。x-mns-ret-number Integer 否 2 单次请求结果的最大返回个数。 取值范围:1~1000。
x-mns-prefix String 否 topic 按照该前缀开头的主题名称进行查找。 其它参数,请参见公共参数。
- Request Body
无。
返回消息
返回消息由返回状态行、HTTP头和消息体三部分组成:
- HTTP Status Code
HTTP/1.1 200 OK
- 特有Response Header
无。
- Response Body
返回XML形式的结果,顶层
Topics
元素下包含多个Topic
元素,Topic
元素中包含TopicURL
元素,TopicURL
表示Topic的URL访问地址。如果返回结果超过x-mns-ret-number
的参数值,包含NextMarker
元素表示下个分页的起始位置。
示例
请求示例:
GET /topics HTTP/1.1
x-mns-marker: 10
x-mns-ret-number:2
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Tue, 08 Dec 2015 05:59:22 GMT
Authorization: NS15B4D3461F177624206A:ytChIeJt2klpvFxGCgVsPNI0****
x-mns-version: 2015-06-06
返回示例:
HTTP/1.1 200 OK
x-mns-request-id:566671BAB2B71C9C1600****
x-mns-version: 2015-06-06
<?xml version="1.0" encoding="utf-8"?>
<Topics xmlns="http://mns.aliyuncs.com/doc/v1/">
<Topic>
<TopicURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/topics/$TopicName1</TopicURL>
</Topic>
<Topic>
<TopicURL>http://$AccountId.mns.cn-hangzhou.aliyuncs.com/topics/$TopicName2</TopicURL>
</Topic>
<NextMarker>OTczNjU4MTcvYmRwejd6NXluby8yNjg0Mi9UZXN0VG9waWMtMy8w</NextMarker>
</Topics>
错误码
本操作无特有的错误,主要是权限验证类和参数设置类错误。更多信息,请参见错误码。