ListQueues
ListQueues возвращает список ваших очередей в текущем регионе. Ответ включает не более 1000 результатов. Если вы укажете значение для необязательного QueueNamePrefix
параметра, будут возвращены только очереди с именем, которое начинается с указанного значения.
Метод поддерживает разбиение на страницы. Задайте параметр MaxResults
в запросе, чтобы указать максимальное количество результатов, возвращаемых в ответе. Если не установить MaxResults
, ответ будет содержать не более 1000 результатов. Если вы установили MaxResults
и есть дополнительные результаты для отображения, ответ будет содержать значение для NextToken
. Используйте NextToken
в качестве параметра в следующем запросе, listQueues
, чтобы получить следующую страницу результатов.
Параметр |
Тип |
Описание |
MaxResults |
Integer
|
Максимальное количество результатов для включения в ответ. Диапазон значений от 1 до 1000. Вы должны установить MaxResults, чтобы получить значение NextToken в ответе. |
NextToken
|
String
|
Токен разбиения на страницы для запроса следующего набора результатов.
|
QueueNamePrefix |
String |
Строка, используемая для фильтрации результатов списка. Возвращаются только те очереди, имя которых начинается с указанной строки. URL-адреса и имена очередей чувствительны к регистру. |
Следующие элементы возвращаются службой.
Параметр
|
Тип
|
Описание
|
NextToken |
String
|
Токен разбиения на страницы для включения в следующий запрос. Значение токена — null если нет дополнительных результатов для запроса или если вы не указали MaxResultsв запросе.
|
QueueUrl.N
|
Array
|
Список URL-адресов очереди, до 1000 записей или значение MaxResults, отправленное вами в запросе.
|
Следующий пример запроса запроса возвращает очереди, имена которых начинаются с буквы t. Структура AUTHPARAMS зависит от подписи запроса API.
Образец запроса
Пример запроса:
https://sqs.mcs.mail.ru/
?Action=ListQueues
&QueueNamePrefix=M
&Expires=2020-04-18T22:52:43PST
&Version=2012-11-05
&AUTHPARAMS
Образец ответа
Пример ответа:
<ListQueuesResponse>
<ListQueuesResult>
<QueueUrl>https://sqs.mcs.mail.ru/123456789012/MyQueue</QueueUrl>
<QueueUrl>https://sqs.mcs.mail.ru/123456789012/MyQueue</QueueUrl>
</ListQueuesResult>
<ResponseMetadata>
<RequestId>725275ae-0b9b-4762-b238-436d7c65a1ac</RequestId>
</ResponseMetadata>
</ListQueuesResponse>