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

You can call the ListTopic operation to query a paginated list of topics in your Alibaba Cloud account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mns:ListTopic

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNum	integer	No	The page number of the results to return. Valid values: 1 to 100,000,000. If you specify a value smaller than 1, the system uses 1. If you specify a value larger than 100,000,000, the system uses 100,000,000.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 10 to 50. If you specify a value smaller than 10, the system uses 10. If you specify a value larger than 50, the system uses 50.	20
TopicName	string	No	The name of the topic.	test
Tag	array<object>	No	A list of tags.
	object	No	The tag object.
Key	string	No	The key of the tag.	tag1
Value	string	No	The value of the tag.	test
TopicType	string	No	The type of the topic. Valid values: normal: a standard topic fifo: a first-in, first-out (FIFO) topic	normal

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	06273500-249F-5863-121D-74D51123****
Code	integer	The response code.	200
Status	string	The status of the response.	Success
Message	string	The response message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The response data.
PageNum	integer	The page number of the returned results.	1
PageSize	integer	The number of entries returned on each page.	50
Total	integer	The total number of entries.	130
PageData	array<object>	The entries returned on the current page.
	array<object>	The data item.
TopicName	string	The name of the topic.	demo-topic
MessageCount	integer	The number of messages in the topic.	0
MaxMessageSize	integer	The maximum size of a message body that can be sent to the topic, in bytes.	65536
MessageRetentionPeriod	integer	The maximum time to live (TTL) of a message in the topic. A message is deleted after this period of time passes, regardless of whether the message has been pushed to subscribers. Unit: seconds.	86400
CreateTime	integer	The time when the topic was created. This value is a UNIX timestamp that represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1449554962
LastModifyTime	integer	The time when the topic properties were last modified. This value is a UNIX timestamp that represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1449554962
LoggingEnabled	boolean	Indicates whether Log Management is enabled. True: enabled. False: disabled.	True
TopicUrl	string	The URL of the topic.	http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic
TopicInnerUrl	string	The URL of the topic for access from the internal network.	http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic
Tags	array<object>	A list of resource tags.
	object	The tag object.
TagKey	string	The key of the tag.	tag1
TagValue	string	The value of the tag.	test
TopicType	string	The type of the topic. Valid values: normal: a standard topic fifo: a FIFO topic	normal

Examples

Success response

JSON format

{
  "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": "http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic",
        "TopicInnerUrl": "http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic",
        "Tags": [
          {
            "TagKey": "tag1",
            "TagValue": "test"
          }
        ],
        "TopicType": "normal"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.