VENTAS: 1-800-867-1389

List Queues

Actualizado: noviembre de 2013

Esta operación enumera todas las colas de la cuenta de almacenamiento especificada.

La solicitud List Queues se puede construir como sigue. 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

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

 

Método URI de solicitud Versión de HTTP

GET

http://127.0.0.1:10001/devstoreaccount1?comp=list

HTTP/1.1

Para obtener más información, vea About Development Storage.

Se pueden especificar los parámetros adicionales siguientes 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 elemento NextMarker en el cuerpo de respuesta si la lista devuelta no está completa. Este valor se puede utilizar como parámetro de consulta en una llamada subsiguiente para solicitar la parte siguiente de 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 no se especifica maxresults, el servidor devolverá hasta 5.000 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 del servicio Cola. A partir de esta versión, todos los nombres de los metadatos deben cumplir las convenciones de nomenclatura para los Identificadores de C#.

timeout

Opcional. El parámetro timeout se expresa en segundos. Para obtener más información, vea Establecer los tiempos de espera para las operaciones del servicio Cola.

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

 

Encabezado de solicitud Descripción

Authorization

Requerido. Especifica el esquema de autenticación, el nombre de la cuenta y la firma. Para obtener más información, vea Autenticación para los servicios de almacenamiento de Azure.

Date O bien x-ms-date

Requerido. Especifica la hora universal coordinada (UTC) para la solicitud. Para obtener más información, vea Autenticación para los servicios de almacenamiento de Azure.

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 Control de versiones de los servicios de almacenamiento de Azure.

x-ms-client-request-id

Opcional. Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 KB que se graba en los registros de análisis cuando el registro de análisis de almacenamiento está habilitado. Se recomienda encarecidamente usar este encabezado para correlacionar las actividades del lado cliente con las solicitudes recibidas por el servidor. Para obtener más información, vea Acerca del registro del análisis de almacenamiento y Registro de Windows Azure: usar registros para realizar el seguimiento de las solicitudes de almacenamiento.

En la sección Solicitud y respuesta de ejemplo de este tema encontrará una solicitud de ejemplo.

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.

Una operación correcta devuelve el código de estado 200 (Correcto).

Para obtener información acerca de los códigos de estado, vea Códigos de estado y de error.

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir otros encabezados HTTP estándar. Todos los encabezados estándar cumplen 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 utilizar para solucionar problemas relacionados con esta. Para obtener más información, vea Solucionar problemas relacionados con las operaciones de la API.

x-ms-version

Indica la versión del servicio Cola utilizada 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 generado por el servicio que indica la hora a la que se inició la respuesta.

El formato del cuerpo de respuesta es el siguiente. Tenga en cuenta que los elementos Prefix, Marker y MaxResults solo están presentes si se especificaron en el URI. El elemento NextMarker tiene un valor solo si los resultados de la lista no están completos.

En la versión 2013-08-15 y posteriores, el atributo AccountName para el elemento EnumerationResults ha cambiado de nombre y ahora se llama 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>
      …

En la sección Solicitud y respuesta de ejemplo de este tema encontrará una respuesta de ejemplo.

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

Si especifica un valor para el parámetro maxresults y el número de colas que se van a devolver supera este valor, o supera el valor predeterminado de maxresults, el cuerpo de respuesta contendrá un elemento NextMarker que indica la siguiente cola que se debe devolver en una solicitud subsiguiente. 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.

Este URI de ejemplo solicita la lista de colas para una cuenta, estableciendo en 3 el número máximo de resultados que se van a devolver para la operación inicial.

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 elemento NextMarker aparece a continuación del conjunto de colas e incluye el nombre de la próxima 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. El próximo conjunto de resultados se devuelve comenzando desde 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>

¿Te ha resultado útil?
(Caracteres restantes: 1500)
Gracias por sus comentarios
Mostrar:
© 2014 Microsoft