GetTopicAttributes - Simple Message Queue (formerly MNS)

Queries the attributes of a topic.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
mns:GetTopicAttributes	get	*Topic `acs:mns:{#regionId}:{#accountId}:/topics/{#TopicName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
TopicName	string	Yes	The name of the topic.	demo-topic

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 data returned.
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 topic was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1449554277
LastModifyTime	long	The time when the topic 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.	1449554460
LoggingEnabled	boolean	Indicates whether the logging feature is enabled. Valid values: True False	True
Tags	array<object>	The tags added to the resources.
Tags	object	The tag.
TagKey	string	The tag key.	tag1
TagValue	string	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": {
    "TopicName": "demo-topic",
    "MessageCount": 0,
    "MaxMessageSize": 65536,
    "MessageRetentionPeriod": 86400,
    "CreateTime": 1449554277,
    "LastModifyTime": 1449554460,
    "LoggingEnabled": true,
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "test"
      }
    ]
  }
}

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