Enumeración de las colas

Artículo
06/27/2023

Esta operación enumera todas las colas de una cuenta de almacenamiento determinada.

Request

Puede construir la List Queues solicitud como se indica a continuación. Se recomienda HTTPS. Reemplace myaccount por el nombre de la cuenta de almacenamiento.

Método	URI de solicitud	Versión de HTTP
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

URI del servicio de almacenamiento emulado

Al realizar una solicitud en el servicio de almacenamiento emulado, especifique el nombre de host del emulador y el puerto de Azure Queue Storage como 127.0.0.1:10001, seguido del nombre de la cuenta de almacenamiento emulada.

Método	URI de solicitud	Versión de HTTP
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Parámetros de identificador URI

Puede especificar los siguientes parámetros adicionales en el URI de solicitud.

Parámetro	Descripción
`prefix`	Filtra los resultados para devolver solo las colas cuyo nombre empieza por el prefijo especificado.
`marker`	Valor de cadena que identifica la parte de la lista que se va a devolver con la siguiente operación de lista. La operación devuelve un `NextMarker` elemento dentro del cuerpo de la respuesta, si la lista devuelta no se completó. Después, puede usar este valor como parámetro de consulta en una llamada posterior para solicitar la siguiente parte de la lista de colas. El valor de marcador es opaco para el cliente.
`maxresults`	Especifica el número máximo de colas que se van a devolver. Si `maxresults` no se especifica , el servidor devolverá hasta 5000 elementos.
`include=metadata`	Opcional. Incluya este parámetro para especificar que los metadatos del contenedor se deben devolver como parte del cuerpo de respuesta. Tenga en cuenta que los metadatos solicitados con este parámetro deben almacenarse de acuerdo con las restricciones de nomenclatura impuestas por la versión 2009-09-19 de Queue Storage. A partir de esta versión, todos los nombres de metadatos deben cumplir las convenciones de nomenclatura de los identificadores de C#.
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para más información, consulte Configuración de tiempos de espera para las operaciones de Queue Storage.

Encabezados de solicitud

En la tabla siguiente se describen los encabezados de solicitud requeridos y opcionales.

Encabezado de solicitud	Descripción
`Authorization`	Necesario. Especifica el esquema de autorización, el nombre de la cuenta y la firma. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`Date` o `x-ms-date`	Necesario. Especifica la hora universal coordinada (UTC) de la solicitud. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`x-ms-version`	Opcional. Especifica la versión de la operación que se utiliza para esta solicitud. Para obtener más información, vea Versiones de los servicios de Azure Storage.
`x-ms-client-request-id`	Opcional. Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 kibibyte (KiB) que se registra en los registros cuando se configura el registro. Se recomienda encarecidamente usar este encabezado para correlacionar las actividades del lado cliente con las solicitudes que recibe el servidor. Para más información, consulte Supervisión de Azure Queue Storage.

Cuerpo de la solicitud

Ninguno.

Solicitud de ejemplo

Consulte la sección "Solicitud de ejemplo y respuesta" más adelante en este artículo.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta que contiene la lista de colas.

status code

Una operación correcta devuelve el código de estado 200 Correcto. Para obtener información sobre los códigos de estado, vea Códigos de estado y de error.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir encabezados HTTP adicionales y estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta	Descripción
`x-ms-request-id`	Este encabezado identifica de forma única la solicitud que se realizó y se puede usar para solucionar problemas de la solicitud. Para más información, consulte Solución de problemas de operaciones de API.
`x-ms-version`	Indica la versión de Queue Storage usada para ejecutar la solicitud. Este encabezado se devuelve para las solicitudes realizadas en la versión 2009-09-19 y versiones posteriores.
`Date`	Valor de fecha y hora UTC que indica la hora a la que se inició la respuesta. El servicio genera este valor.
`x-ms-client-request-id`	Puede usar este encabezado para solucionar problemas de solicitudes y respuestas correspondientes. El valor de este encabezado es igual al valor del `x-ms-client-request-id` encabezado, si está presente en la solicitud. El valor es como máximo 1024 caracteres ASCII visibles. Si el `x-ms-client-request-id` encabezado no está presente en la solicitud, este encabezado no estará presente en la respuesta.

Response body

El formato del cuerpo de la respuesta es el siguiente. Tenga en cuenta que los Prefixelementos , Markery MaxResults solo están presentes si los especificó en el URI. El NextMarker elemento solo tiene un valor si los resultados de la lista no están completos.

Para la versión 2013-08-15 y posteriores, se ha cambiado el nombre del AccountName atributo del EnumerationResults elemento a ServiceEndpoint. Además, se ha quitado el elemento Url de 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>

El elemento Metadata está presente solo si se especificó el parámetro include=metadata en el URI. Dentro del elemento Metadata, el valor de cada par nombre-valor aparece en un elemento que corresponde al nombre del par.

Si un par nombre-valor de metadatos infringe las restricciones de nomenclatura impuestas por la versión 2009-09-19, el cuerpo de respuesta indica el nombre problemático en un elemento x-ms-invalid-name, tal como se muestra en el fragmento XML siguiente:

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

Respuesta de muestra

Consulte la sección "Solicitud de ejemplo y respuesta" más adelante en este artículo.

Authorization

Solo el propietario de la cuenta puede llamar a esta operación.

Comentarios

Si especifica un valor para el maxresults parámetro y el número de colas que se van a devolver supera este valor o supera el valor predeterminado para maxresults, el cuerpo de la respuesta contiene un NextMarker elemento . Este elemento indica la siguiente cola que se va a devolver en una solicitud posterior. Para devolver el siguiente conjunto de elementos, especifique el valor de NextMarker como el parámetro de marcador en el URI para la solicitud siguiente.

Tenga en cuenta que el valor de NextMarker se debe tratar como opaco.

Las colas aparecen en orden alfabético en el cuerpo de respuesta.

Solicitud y respuesta de ejemplo

Este es un URI de ejemplo que solicita la lista de colas de una cuenta. Establece los resultados máximos que se devolverán para la operación inicial en tres.

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

La solicitud se envía con estos encabezados:

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

El código de estado y los encabezados de respuesta se devuelven de la forma siguiente:

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

El código XML de respuesta para esta solicitud es el siguiente. Tenga en cuenta que el NextMarker elemento sigue el conjunto de colas e incluye el nombre de la siguiente cola que se va a devolver.

<?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>

La subsiguiente operación de lista especifica el marcador en el URI de la solicitud, de la forma siguiente. Se devuelve el siguiente conjunto de resultados, empezando por la cola especificada por el marcador. Este es el URI para la solicitud siguiente:

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

El cuerpo de respuesta para esta operación es el siguiente:

<?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>

Consulte también

Autorización de solicitudes a Azure Storage
Estado y códigos de error
Códigos de error de Queue Storage