Перечисление очередей

Статья
06/27/2023

Эта операция выводит список всех очередей в определенной учетной записи хранения.

Запрос

Запрос можно создать List Queues следующим образом. Рекомендуется использовать протокол HTTPS. Замените myaccount именем своей учетной записи хранения.

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

URI эмулированной службы хранилища

При выполнении запроса к эмулированной службе хранилища укажите имя узла эмулятора и порт хранилища очередей Azure в качестве 127.0.0.1:10001, за которым следует эмулированное имя учетной записи хранения.

Метод	Универсальный код ресурса (URI) запроса	параметр "Версия HTTP"
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Параметры URI

В URI запроса можно указать следующие дополнительные параметры.

Параметр	Описание
`prefix`	Фильтрует результаты для возвращения только очередей с именами, начинающимися с указанного префикса.
`marker`	Строковое значение, которое определяет часть списка для возвращения со следующей операцией списка. Операция возвращает `NextMarker` элемент в теле ответа, если возвращенный список не был завершен. Затем это значение можно использовать в качестве параметра запроса в последующем вызове, чтобы запросить следующую часть списка очередей. Значение маркера непрозрачно для клиента.
`maxresults`	Указывает максимальное количество возвращаемых очередей. Если `maxresults` параметр не указан, сервер вернет до 5000 элементов.
`include=metadata`	Необязательный элемент. Включите этот параметр для указания того, что метаданные контейнера должны быть возвращены в тексте ответа. Обратите внимание, что метаданные, запрашиваемые с этим параметром, должны храниться в соответствии с ограничениями именования, установленными версией хранилища очередей 2009-09-19. Начиная с этой версии все имена метаданных должны соответствовать соглашениям об именовании для идентификаторов C#.
`timeout`	Необязательный элемент. Параметр `timeout` указывается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций хранилища очередей.

Заголовки запросов

В следующей таблице перечислены обязательные и необязательные заголовки запросов.

Заголовок запроса	Описание
`Authorization`	Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure.
`Date` или `x-ms-date`	Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure.
`x-ms-version`	Необязательный элемент. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure.
`x-ms-client-request-id`	Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в статье Мониторинг хранилища очередей Azure.

Текст запроса

Нет.

Пример запроса

См. раздел "Пример запроса и ответа" далее в этой статье.

Ответ

Ответ включает код состояния HTTP, набор заголовков ответа и текст ответа, содержащий список очередей.

Код состояния

Успешная операция возвращает код состояния 200 (ОК). Сведения о кодах состояния см. в разделе Коды состояния и ошибок.

Заголовки ответов

Ответ для этой операции включает следующие заголовки. Ответ также может содержать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.

Заголовок ответа	Описание
`x-ms-request-id`	Этот заголовок однозначно идентифицирует выполненный запрос и может использоваться для устранения неполадок с запросом. Дополнительные сведения см. в разделе Устранение неполадок операций API.
`x-ms-version`	Указывает версию хранилища очередей, используемой для выполнения запроса. Этот заголовок возвращается для запросов к версии 2009-09-19 и более поздним версиям.
`Date`	Значение даты и времени в формате UTC, указывающее время, в которое был инициирован ответ. Служба создает это значение.
`x-ms-client-request-id`	Этот заголовок можно использовать для устранения неполадок с запросами и соответствующими ответами. Значение этого заголовка равно значению заголовка `x-ms-client-request-id` , если он присутствует в запросе. Значение равно не более 1024 видимых символов ASCII. Если заголовок `x-ms-client-request-id` отсутствует в запросе, этот заголовок не будет присутствовать в ответе.

Текст ответа

Формат текста ответа следующий. Обратите внимание, что Prefixэлементы , Markerи MaxResults присутствуют только в том случае, если они указаны в URI. Элемент NextMarker имеет значение, только если результаты списка не завершены.

Для версии 2013-08-15 и более поздних версий AccountName атрибут элемента EnumerationResults был переименован в ServiceEndpoint. Кроме того, был удален элемент Url из Queue.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.queue.core.windows.net/">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Queues>  
    <Queue>  
      <Name>string-value</Name>  
      <Metadata>  
      <metadata-name>value</metadata-name>  
    <Metadata>  
    </Queue>  
  <NextMarker />  
</EnumerationResults>

Элемент Metadata присутствует, только если параметр include=metadata был указан в URI. В элементе Metadata значение для каждой пары "имя-значение" приводится с элементом, соответствующим имени в паре.

Если пара "имя-значение" метаданных нарушает ограничения, введенные в версии 2009-09-19, текст ответа показывает проблемное имя в элементе x-ms-invalid-name, как показано в следующем фрагменте XML.

  
…  
<Metadata>  
  <MyMetadata1>first value</MyMetadata1>  
  <MyMetadata2>second value</MyMetadata2>  
  <x-ms-invalid-name>invalid-metadata-name</x-ms-invalid-name>  
<Metadata>  
…

Пример ответа

См. раздел "Пример запроса и ответа" далее в этой статье.

Авторизация

Только владелец учетной записи может вызвать эту операцию.

Если задано значение параметра maxresults , а количество возвращаемых очередей превышает это значение или превышает значение по умолчанию для maxresults, текст ответа содержит NextMarker элемент . Этот элемент указывает следующую очередь, возвращаемую при последующем запросе. Чтобы вернуть следующий набор элементов, укажите значение NextMarker в качестве параметра маркера в URI в последующем запросе.

Обратите внимание, что значение NextMarker должно обрабатываться как непрозрачное.

Очереди в тексте ответа перечисляются в алфавитном порядке.

Пример запроса и ответа

Ниже приведен пример универсального кода ресурса (URI), который запрашивает список очередей для учетной записи. Он устанавливает максимальное количество возвращаемых результатов для начальной операции в три.

GET https://myaccount.queue.core.windows.net?comp=list&maxresults=3&include=metadata HTTP/1.1

Запрос отправлен с такими заголовками.

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 00:55:16 GMT  
Authorization: SharedKey myaccount:Q7tar7qqM2LD/Wey7OQNPP3hMNap9wjg+g9AlAYeFls=

Возвращены следующие код состояния и заголовки ответа.

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 00:56:38 GMT  
x-ms-version: 2013-08-15  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0

XML ответа для этого запроса будет следующим. Обратите внимание, что NextMarker элемент следует за набором очередей и включает имя возвращаемой очереди.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.queue.core.windows.net/">  
  <Prefix>q</Prefix>  
  <MaxResults>3</MaxResults>  
  <Queues>  
    <Queue>  
      <Name>q1</Name>  
      <Metadata>  
        <Color>red</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
    <Queue>  
      <Name>q2</Name>  
      <Metadata>  
        <Color>blue</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
    <Queue>  
      <Name>q3</Name>  
      <Metadata>  
        <Color>yellow</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
  </Queues>  
  <NextMarker>q4</NextMarker>  
</EnumerationResults>

Последующая операция для списка определяет маркер в URI запроса следующим образом. Возвращается следующий набор результатов, начиная с очереди, указанной маркером. Вот URI для последующего запроса.

https://myaccount.queue.core.windows.net?comp=list&maxresults=3&include=metadata&prefix=q&marker=q4

Текст ответа для этой операции будет таким:

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint="https://myaccount.queue.core.windows.net/">  
  <Prefix>q</Prefix>  
  <Marker>q4</Marker>  
  <MaxResults>3</MaxResults>  
  <Queues>  
    <Queue>  
      <Name>q4</Name>  
      <Metadata>  
        <Color>green</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
    <Queue>  
      <Name>q5</Name>  
      <Metadata>  
        <Color>violet</Color>  
        <SomeMetadataName>SomeMetadataValue</SomeMetadataName>  
      <Metadata>  
    </Queue>  
  </Queues>  
  <NextMarker />  
</EnumerationResults>

См. также раздел

Авторизация запросов к службе хранилища Azure
Коды состояний и ошибок
Коды ошибок хранилища очередей

Поделиться через