Call the ListTopic operation to query a paginated list of topics - Simple Message Queue (formerly MNS) - Alibaba Cloud - Simple Message Queue (formerly MNS)

Queries the topics under an Alibaba Cloud account. The query results can be paginated.

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 returned results. Valid values: 1 to 100000000. If the specified value is less than 1, the system defaults to 1. If the specified value is greater than 100000000, the system defaults to 100000000.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 10 to 50. If the specified value is less than 10, the system defaults to 10. If the specified value is greater than 50, the system defaults to 50.	20
TopicName	string	No	The name of the topic.	test
Tag	array<object>	No	The list of tags.
	object	No	The tag value corresponding to the tag key.
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: normal topic fifo: 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 is 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 results.	130
PageData	array<object>	The results 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 length of the message body that can be sent to the topic. Unit: bytes.	65536
MessageRetentionPeriod	integer	The maximum retention period of messages in the topic. After the specified period elapses from the time a message is sent to the topic, the message is deleted regardless of whether it is successfully pushed to users. Unit: seconds.	86400
CreateTime	integer	The time when the topic was created. The value is a UTC UNIX timestamp in seconds.	1449554962
LastModifyTime	integer	The time when the topic attributes were last modified. The value is a UTC UNIX timestamp in seconds.	1449554962
LoggingEnabled	boolean	Indicates whether the log management feature is enabled. Valid values: 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 internal URL of the topic.	http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic
Tags	array<object>	The list of resource tags.
	object	The tag value corresponding to the tag key.
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: normal topic fifo: FIFO topic	normal
EnableSSE	boolean	Specifies whether server-side encryption is enabled. Valid values: true and false.	true
SseType	string	The server-side encryption method. Valid values: SMQ and KMS.	KMS
SseAlgorithm	string	The server-side encryption algorithm. Currently, AES-256-GCM is supported. If this parameter is not specified, the default algorithm is used.	AES-256-GCM
KmsKeyId	string	The KMS key ID.	key-xxx
EncryptionEnabled	boolean	Indicates whether server-side encryption is enabled.	true

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",
        "EnableSSE": true,
        "SseType": "KMS",
        "SseAlgorithm": "AES-256-GCM",
        "KmsKeyId": "key-xxx",
        "EncryptionEnabled": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.