使用ListTopic接口列出帐号下的主题列表,可分页获取数据。

描述

该接口用于列出帐号下的主题列表,可分页获取数据。如果只是要获取特定的主题列表,在调用接口时指定x-mns-prefix参数,服务端将返回主题名称与前缀匹配的主题列表。

注意

:如果本次请求结果返回的主题总数超过本次请求的x-mns-ret-number参数值,返回的XML结果中包含的NextMarker表示下一页开始位置,在下一次请求时将该值赋予x-mns-marker参数以返回下一页的结果。

Request

Request的构造主要由以下几个部分组成:

  • 请求行

    GET /topics HTTP/1.1

  • 特有Request Header

参数名称 是否必选 说明
x-mns-marker 请求下一个分页的开始位置,从上次分页结果返回的NextMarker获取
x-mns-ret-number 单次请求结果的最大返回个数,1 - 1000 范围内的整数值,默认值为1000
x-mns-prefix 按照该前缀开头的主题名称进行查找

其它参数请参见公共参数

  • Request Body

Response

返回消息由返回状态行、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-ret-number:2
Host: $AccountId.mns.cn-hangzhou.aliyuncs.com
Date: Tue, 08 Dec 2015 05:59:22 GMT
Authorization: NS15B4D3461F177624206A:ytChIeJt2klpvFxGCgVsPNI015k=
x-mns-version: 2015-06-06
			

返回示例:

HTTP/1.1 200 OK
x-mns-request-id:566671BAB2B71C9C16000019 
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>