All Products
Search
Document Center

Simple Message Queue (formerly MNS):ListTopic

Last Updated:Jan 17, 2025

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mns:ListTopiclist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumlongNo

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
PageSizelongNo

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
TopicNamestringNo

The name of the topic.

test
Tagarray<object>No

The tags.

objectNo

The tag value.

KeystringNo

The tag key.

tag1
ValuestringNo

The tag value.

test

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

06273500-249F-5863-121D-74D51123****
Codelong

The response code.

200
Statusstring

The response status.

Success
Messagestring

The returned message.

operation success
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

PageNumlong

The page number.

1
PageSizelong

The number of entries per page.

50
Totallong

The total number of entries returned.

130
PageDataarray<object>

The data returned on the current page.

pageDataobject

The queried data.

TopicNamestring

The name of the topic.

demo-topic
MessageCountlong

The number of messages in the topic.

0
MaxMessageSizelong

The maximum length of the message that is sent to the topic. Unit: bytes.

65536
MessageRetentionPeriodlong

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
CreateTimelong

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
LastModifyTimelong

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
LoggingEnabledboolean

Indicates whether the logging feature is enabled.

  • True
  • False
True
TopicUrlstring

The URL of the message topic.

http:// 111111111****.mns.us-west-1.aliyuncs.com/topics/testTopic
TopicInnerUrlstring

The internal URL of the message topic. The internal URL can be accessed over an internal network.

http:// 111111111****.mns.us-west-1-internal.aliyuncs.com/topics/testTopic
Tagsarray<object>

The tags added to the resources.

Tagsobject

The tag.

TagKeystring

The tag key.

tag1
TagValuestring

The tag value.

test

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": "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"
          }
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-27The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-05-08The response structure of the API has changedView Change Details