ListTopic - Simple Message Queue (formerly MNS) - Alibaba Cloud Documentation Center

Queries the topics that belong to an Alibaba Cloud account. The topics are displayed by page.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageNum	long	No	The page number. Valid values: 1 to 100000000. If you set this parameter to a value smaller than 1, the value of this parameter is 1 by default. If you set this parameter to a value greater than 100000000, the value of this parameter is 100000000 by default.	1
PageSize	long	No	The number of entries per page. Value values: 10 to 50. If you set this parameter to a value smaller than 10, the value of this parameter is 10 by default. If you set this parameter to a value greater than 50, the value of this parameter is 50 by default.	20
TopicName	string	No	The name of the topic.	test

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	06273500-249F-5863-121D-74D51123****
Code	long	The response code.	200
Status	string	The response status.	Success
Message	string	The returned message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNum	long	The page number.	1
PageSize	long	The number of entries per page.	50
Total	long	The total number of entries returned.	130
PageData	array<object>	The data returned on the current page.
	object
TopicName	string	The name of the topic.	demo-topic
MessageCount	long	The number of messages in the topic.	0
MaxMessageSize	long	The maximum length of the message that is sent to the topic. Unit: bytes.	65536
MessageRetentionPeriod	long	The maximum duration for which a message is retained in the topic. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.	86400
CreateTime	long	The time when the subscription was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1449554962
LastModifyTime	long	The time when the subscription was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1449554962
LoggingEnabled	boolean	Indicates whether the logging feature is enabled. True False	True

Examples

Sample success responses

JSONformat

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 50,
    "Total": 130,
    "PageData": [
      {
        "TopicName": "demo-topic",
        "MessageCount": 0,
        "MaxMessageSize": 65536,
        "MessageRetentionPeriod": 86400,
        "CreateTime": 1449554962,
        "LastModifyTime": 1449554962,
        "LoggingEnabled": true,
        "TopicUrl": "",
        "TopicInnerUrl": "",
        "Tags": [
          {
            "TagKey": "",
            "TagValue": ""
          }
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-27	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-05-08	The response structure of the API has changed	View Change Details