GetQueueAttributes

Written by

Yandex Cloud

Updated at October 4, 2024

Request
- Request parameters
Response
- Successful response fields
- GetQueueAttributes errors
Sample request
Response example

Method for getting attributes for the specified queue.

If the queue name ends with the .fifo suffix, the type of the requested queue is FIFO.

Request

Request parameters

Parameter	Type	Required parameter	Description
`QueueUrl`	string	Yes	URL of a queue.
`Attributes.N.*`	list of attributes	No	List of queue attributes.

Attributes

Queue attributes. Attributes are sent as a list. For more information about passing list parameters, see Using the API.

Attribute.N.Name (attribute)
Attribute.N.Value (attribute value)

Attribute	Description
`All`	Returns all attributes of a queue.
`ApproximateNumberOfMessages`	Returns the approximate number of enqueued messages that can be received.
`ApproximateNumberOfMessagesDelayed`	Returns the approximate number of messages in the queue that are delayed and not available for reading immediately.
`ApproximateNumberOfMessagesNotVisible`	Returns the approximate number of messages that are in flight: they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility timeout.
`CreatedTimestamp`	Returns the time stamp when the queue was created, in seconds (epoch time).
`DelaySeconds`	Number of seconds to delay the message from being available for processing.
`LastModifiedTimestamp`	Returns the time when the queue was last changed in seconds (epoch time).
`MaximumMessageSize`	Returns the maximum message size in bytes.
`MessageRetentionPeriod`	Returns the length of time, in seconds, for which a message is retained.
`QueueArn`	Queue ARN used in the `RedrivePolicy` attribute.
`ReceiveMessageWaitTimeSeconds`	Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.
`RedrivePolicy`	Redirect policy for moving messages to a dead-letter queue. The source queue and DLQ must be the same type: for FIFO queues, the DLQ must also be a FIFO queue. It includes these two parameters: `deadLetterTargetArn`: ARN of the DLQ the messages will be moved to. `maxReceiveCount`: Maximum number of attempts to read a message from a queue before redirecting it to the DLQ. When `ReceiveCount` exceeds `maxReceiveCount` for a given message, the message is moved to the DLQ.
`VisibilityTimeout`	Returns the visibility timeout for the queue, specified in seconds.

FIFO queue attributes

Attribute	Description
`FifoQueue`	Returns whether the queue is FIFO. To learn whether a queue is a FIFO queue, make sure its name ends with the `.fifo` suffix.
`ContentBasedDeduplication`	Returns whether content-based deduplication.

Non-supported attributes

Attribute	Type	Description
`KmsMasterKeyId`	string	Not supported in Yandex Message Queue.
`KmsDataKeyReusePeriodSeconds`	string	Not supported in Yandex Message Queue.

Response

Successful response fields

Field	Type	Description
`Attributes.N.*`	array	Array of queue attributes.

GetQueueAttributes errors

For a list of errors common for all methods, see Common errors.

HTTP code	Error ID	Description
400	`InvalidAttributeName`	The attribute name is invalid.

Sample request

Action=GetQueueAttributes
&Version=2012-11-05
&QueueUrl=https://message-queue.api.cloud.yandex.net/b1g8ad42m6he********/dj6000000000********/sample-queue
&AttributeName.1=All

For more information about forming requests, see General API request format.

Response example

<GetQueueAttributesResponse>
    <GetQueueAttributesResult>
        <Attribute>
            <Name>ApproximateNumberOfMessages</Name>
            <Value>0</Value>
        </Attribute>
        <Attribute>
            <Name>ApproximateNumberOfMessagesDelayed</Name>
            <Value>0</Value>
        </Attribute>
        <Attribute>
            <Name>ApproximateNumberOfMessagesNotVisible</Name>
            <Value>0</Value>
        </Attribute>
        <Attribute>
            <Name>CreatedTimestamp</Name>
            <Value>1548345183</Value>
        </Attribute>
        <Attribute>
            <Name>DelaySeconds</Name>
            <Value>0</Value>
        </Attribute>
        <Attribute>
            <Name>MaximumMessageSize</Name>
            <Value>262144</Value>
        </Attribute>
        <Attribute>
            <Name>MessageRetentionPeriod</Name>
            <Value>345600</Value>
        </Attribute>
        <Attribute>
            <Name>ReceiveMessageWaitTimeSeconds</Name>
            <Value>0</Value>
        </Attribute>
        <Attribute>
            <Name>VisibilityTimeout</Name>
            <Value>30</Value>
        </Attribute>
    </GetQueueAttributesResult>
    <ResponseMetadata>
        <RequestId>a69769e7-d07122f-147f09c0-e1f9d20-2e4fd5bae005ef4e6d639f79********</RequestId>
    </ResponseMetadata>
</GetQueueAttributesResponse>