Use GetQueueAttributes to retrieve queue properties - Simple Message Queue (formerly MNS) - Alibaba Cloud - Simple Message Queue (formerly MNS)

Retrieves the attributes of a specified queue.

Operation description

Warning

To optimize service performance, Simple Message Queue will soon deprecate the return values of the following fields, which will default to 0:
- ActiveMessages
- InactiveMessages
- DelayMessages

Use the following methods to obtain alternatives:

Use the CloudMonitor OpenAPI to retrieve queue metrics. For more information, see CloudMonitor OpenAPI documentation.
CloudMonitor metrics documentation. The mapping of deprecated fields to alternative metrics is as follows:
- ActiveMessages → CloudMonitor metric NumberOfMessagesVisible
- InactiveMessages → CloudMonitor metric NumberOfMessagesInvisible
- DelayMessages → CloudMonitor metric NumberOfMessagesDelayed

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:GetQueueAttributes

get

*Queue

acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}

None

Request parameters

Parameter	Type	Required	Description	Example
QueueName	string	Yes	The name of the queue.	demo-queue
Tag	array<object>	No	The list of resource tags.
	object	No	The tag value that corresponds to the tag key.
Key	string	No	The tag key.	tag1
Value	string	No	The tag value.	test

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 response status.	Success
Message	string	The response message.	operation success
Success	boolean	Indicates whether the request is successful.	true
Data	object	The response data.
QueueName	string	The name of the queue.	demo-queue
CreateTime	integer	The time when the queue was created. The value is a UNIX timestamp in seconds in UTC.	1250700999
LastModifyTime	integer	The time when the queue attributes were last modified. The value is a UNIX timestamp in seconds in UTC.	1250700999
DelaySeconds	integer	The delay time for all messages sent to the queue. Messages sent to the queue can be consumed only after the delay time specified by this parameter elapses. Unit: seconds.	30
MaximumMessageSize	integer	The maximum length of the message body that can be sent to the queue. Unit: bytes.	65536
MessageRetentionPeriod	integer	The maximum retention period of messages in the queue. After the time specified by this parameter elapses from the time when a message is sent to the queue, the message is deleted regardless of whether it has been consumed. Unit: seconds.	65536
VisibilityTimeout	integer	The duration for which a message remains in the Inactive state after it is consumed from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.	60
PollingWaitSeconds	integer	The maximum waiting time for a ReceiveMessage request when the queue is empty. Unit: seconds.	0
ActiveMessages	integer	The approximate total number of messages in the Active state in the queue. Warning This field will be deprecated and default to 0. We recommend that you use the CloudMonitor API to obtain metrics.	0
InactiveMessages	integer	The approximate total number of messages in the Inactive state in the queue. Warning This field will be deprecated and default to 0. We recommend that you use the CloudMonitor API to obtain metrics.	0
DelayMessages	integer	The approximate total number of messages in the Delayed state in the queue. Warning This field will be deprecated and default to 0. We recommend that you use the CloudMonitor API to obtain metrics.	0
LoggingEnabled	boolean	Specifies whether the log management feature is enabled. True: Enabled. False: Disabled.	True
Tags	array<object>	The list of resource tags.
	object	The tag value that corresponds to the tag key.
TagKey	string	The tag key.	tag1
TagValue	string	The tag value.	test
DlqPolicy	object	The dead-letter queue policy.
Enabled	boolean	Specifies whether dead-letter message delivery is enabled.	true
DeadLetterTargetQueue	string	The destination queue for dead-letter message delivery.	deadLetterTargetQueue
MaxReceiveCount	string	The maximum number of delivery attempts for a message.	3
TenantRateLimitPolicy	object	The throttling policy.
Enabled	boolean	Specifies whether throttling is enabled. Valid values: true false	true
MaxReceivesPerSecond	integer	The maximum number of receives per second.	1000
QueueType	string	The queue type. Valid values: normal: Standard queue. fifo: FIFO queue.	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, only 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	Specifies 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": {
    "QueueName": "demo-queue",
    "CreateTime": 1250700999,
    "LastModifyTime": 1250700999,
    "DelaySeconds": 30,
    "MaximumMessageSize": 65536,
    "MessageRetentionPeriod": 65536,
    "VisibilityTimeout": 60,
    "PollingWaitSeconds": 0,
    "ActiveMessages": 0,
    "InactiveMessages": 0,
    "DelayMessages": 0,
    "LoggingEnabled": true,
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "test"
      }
    ],
    "DlqPolicy": {
      "Enabled": true,
      "DeadLetterTargetQueue": "deadLetterTargetQueue",
      "MaxReceiveCount": "3"
    },
    "TenantRateLimitPolicy": {
      "Enabled": true,
      "MaxReceivesPerSecond": 1000
    },
    "QueueType": "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.