消息服务的的Topic如何操作？

CreateTopic



描述


该接口用于创建一个新的主题。
主题名称是一个不超过256个字符的字符串，必须以字母或数字为首字符，剩余部分可以包含字母、数字和横划线(-)。

Request

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

• 
  请求行

  
  PUT /topics/$TopicName HTTP/1.1

• 
  特有Request Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Request Body

  
  Request Body为XML格式，XML中包含创建Topic的属性。

参数名称	说明	参数值	选项
MaximumMessageSize	发送到该 Topic 的消息体最大长度，单位为Byte	1024(1KB) - 65536(64KB)范围内的某个整数值，默认值为65536(64KB)	Optional
LoggingEnabled	是否开启日志管理功能，True表示启用，False表示停用	True/False，默认为False	Optional

Response

返回消息由返回状态行，HTTP头和消息体三部分组成。

• 
  HTTP Status Code

  
  HTTP/1.1 201 Created同一个所有者在同一个地域的主题不能重名，当出现创建重名的主题时，如果创建主题的属性与已经存在的主题属性相同，返回204（No Content）；否则返回409（Conflict）。

• 
  特有Response Header

参数名称	说明
Location	返回创建的TopicURL，格式如下：http://$AccountId.mns.<Region>.aliyuncs.com/topics/$TopicName

其余返回 Header 请参考 [backcolor=transparent]调用方式/公共参数

• Response Body

  
  无

Special Error

错误代码	错误消息	状态码
TopicAlreadyExist	The topic you want to create is already exists.	409
TopicNameLengthError	Topic name length is out of range, should be between 1 and 256.	400

[backcolor=transparent]请求示例：
[backcolor=transparent]


SetTopicAttributes



描述


该接口用于修改主题的属性。

Request

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

• 
  请求行

  
  PUT /topics/$TopicName?metaoverride=true HTTP/1.1

• 
  特有URI参数

  
  metaoverride=true 将会修改主题的属性

• 
  特有Request Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Request Body

  
  Request Body 为 XML 格式，XML 格式中包含设置主题的属性。

参数名称	说明	参数值	选项
MaximumMessageSize	发送到该 Topic 的消息体最大长度，单位为Byte	1024(1KB) - 65536(64KB)范围内的某个整数值	Optional
LoggingEnabled	是否开启日志管理功能，True表示启用，False表示停用	True/False	Optional

Response


返回消息由返回状态行、HTTP 头和消息体三部分组成

• 
  HTTP Status Code

  
  HTTP/1.1 204 No Content

• 
  特有Response Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Response Body

  
  无

Special Error

错误代码	错误消息	状态码
TopicNotExist	The topic you provided does not exist.	404

[backcolor=transparent]
[backcolor=transparent]请求示例：
[backcolor=transparent]


GetTopicAttributes



描述


该接口用于获取某个已创建主题的属性，返回属性除创建主题时的可设置属性外，还可以获取主题的消息最长存活时间、主题创建时间等。

Request

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

• 
  请求行

  
  GET /topics/$TopicName HTTP/1.1

• 
  特有 Request Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Request Body

  
  无

Response

返回消息由返回状态行、HTTP 头和消息体三部分组成

• 
  HTTP Status Code

  
  HTTP/1.1 200 OK

• 
  特有 Response Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Response Body

  
  返回的结果为 XML 格式，格式为：<TopicAttributes>Attribute Element List</TopicAttributes>

属性元素列表包括：

参数名称	说明
TopicName	主题名称
CreateTime	主题的创建时间，从 1970-1-1 00:00:00到现在的秒值
LastModifyTime	修改主题属性信息的最近时间，从 1970-1-1 00:00:00 到现在的秒值
MaximumMessageSize	发送到该主题的消息体最大长度，单位为 Byte
MessageRetentionPeriod	消息在主题中最长存活时间，从发送到该主题开始经过此参数指定的时间后，不论消息是否被成功推送给用户都将被删除，单位为秒
MessageCount	当前该主题中消息数目
LoggingEnabled	是否开启日志管理功能，True表示启用，False表示停用

Special Error

错误代码	错误消息	状态码
TopicNotExist	The topic you provided does not exist.	404

[backcolor=transparent]
[backcolor=transparent]请求示例：
[backcolor=transparent]


DeleteTopic



描述


该接口用于删除一个已创建的主题
[backcolor=transparent]Note：

1. [backcolor=transparent]使用者必须谨慎使用此接口，一旦删除成功，主题内所有消息也一并删除，不可恢复；所有订阅该主题的[backcolor=transparent] [backcolor=transparent]Subscription[backcolor=transparent] [backcolor=transparent]也一并被删除，不可恢复。

Request

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

• 
  请求行

  
  DELETE /topics/$TopicName HTTP/1.1

• 
  特有Request Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Request Body

  
  无

Response


返回消息由返回状态行、HTTP头和消息体三部分组成

• 
  HTTP Status Code

  
  HTTP/1.1 204 No Content如果主题不存在，返回 204，删除操作成功

• 
  特有 Response Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Response Body

  
  无

[backcolor=transparent]
[backcolor=transparent]请求示例：
[backcolor=transparent]


ListTopic



描述


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

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

Request

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

• 
  请求行

  
  GET /topics HTTP/1.1

• 
  特有 Request Header

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

其它参数请参考 [backcolor=transparent]调用方式/公共参数

• Request Body

  
  无

Response

返回消息由返回状态行、HTTP头和消息体三部分组成

• 
  HTTP Status Code

  
  HTTP/1.1 200 OK

• 
  特有 Response Header

  
  无，请参考 [backcolor=transparent]调用方式/公共参数

• 
  Response Body

  
  返回 XML 形式的结果，顶层 Topics 元素下包含多个 Topic 元素，Topic 元素中包含 TopicURL 元素，TopicURL 表示Topic 的 URL 访问地址。如果返回结果超过 x-mns-ret-number 的参数值，包含 NextMarker 元素表示下个分页的起始位置。

[backcolor=transparent]
[backcolor=transparent]请求示例：
[backcolor=transparent]