All Products
Search
Document Center

Simple Message Queue (formerly MNS):GetQueueAttributes

Last Updated:Jul 26, 2024

Queries the attributes of an existing queue.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
QueueNamestringYes

The name of the queue.

demo-queue

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 returned data.

QueueNamestring

The name of the queue.

demo-queue
CreateTimelong

The time when the queue was created.

1250700999
LastModifyTimelong

The time when the queue 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.

1250700999
DelaySecondslong

The period after which all messages sent to the queue are consumed. Unit: seconds.

30
MaximumMessageSizelong

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

65536
MessageRetentionPeriodlong

The maximum duration for which a message is retained in the queue. After the specified retention period ends, the message is deleted regardless of whether the message is received. Unit: seconds.

65536
VisibilityTimeoutlong

The duration for which a message stays in the Inactive state after the message is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.

60
PollingWaitSecondslong

The maximum duration for which long polling requests are held after the ReceiveMessage operation is called. Unit: seconds.

0
ActiveMessageslong

The total number of messages that are in the Active state in the queue. The value is an approximate number.

20
InactiveMessageslong

The total number of the messages that are in the Inactive state in the queue. The value is an approximate number.

0
DelayMessageslong

The total number of the messages that are in the Delayed state in the queue. The value is an approximate number.

0
LoggingEnabledboolean

Indicates whether the logging feature is enabled. Valid values:

  • True
  • False
True

Examples

Sample success responses

JSONformat

{
  "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": 20,
    "InactiveMessages": 0,
    "DelayMessages": 0,
    "LoggingEnabled": true,
    "Tags": [
      {
        "TagKey": "",
        "TagValue": ""
      }
    ]
  }
}

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