Listar Filas

Artigo
06/27/2023

Esta operação lista todas as filas numa conta de armazenamento específica.

Pedir

Pode construir o pedido da List Queues seguinte forma. É recomendado HTTPS. Substitua myaccount pelo nome da sua conta de armazenamento.

Método	URI do pedido	Versão HTTP
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

URI do serviço de armazenamento emulado

Quando fizer um pedido contra o serviço de armazenamento emulado, especifique o nome de anfitrião do emulador e a porta do Armazenamento de Filas do Azure como 127.0.0.1:10001, seguido do nome da conta de armazenamento emulada.

Método	URI do pedido	Versão HTTP
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Parâmetros do URI

Pode especificar os seguintes parâmetros adicionais no URI do pedido.

Parâmetro	Description
`prefix`	Filtra os resultados para devolver apenas filas com nomes que começam com o prefixo especificado.
`marker`	Um valor de cadeia que identifica a parte da lista a devolver com a operação de lista seguinte. A operação devolve um `NextMarker` elemento no corpo da resposta, se a lista devolvida não tiver sido concluída. Em seguida, pode utilizar este valor como parâmetro de consulta numa chamada subsequente para pedir a parte seguinte da lista de filas. O valor do marcador é opaco para o cliente.
`maxresults`	Especifica o número máximo de filas a devolver. Se `maxresults` não for especificado, o servidor devolverá até 5000 itens.
`include=metadata`	Opcional. Inclua este parâmetro para especificar que os metadados do contentor sejam devolvidos como parte do corpo da resposta. Tenha em atenção que os metadados pedidos com este parâmetro têm de ser armazenados de acordo com as restrições de nomenclatura impostas pela versão 2009-09-19 do Armazenamento de Filas. A partir desta versão, todos os nomes de metadados têm de cumprir as convenções de nomenclatura dos identificadores C#.
`timeout`	Opcional. O `timeout` parâmetro é expresso em segundos. Para obter mais informações, veja Setting timeouts for Queue Storage operations (Definir tempos limite para operações de Armazenamento de Filas).

Cabeçalhos do pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Cabeçalho do pedido	Description
`Authorization`	Obrigatório. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatório. Especifica a Hora Universal Coordenada (UTC) do pedido. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`x-ms-version`	Opcional. Especifica a versão da operação a utilizar para este pedido. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de carateres de 1 kibibyte (KiB) que é registado nos registos quando o registo é configurado. Recomendamos vivamente que utilize este cabeçalho para correlacionar as atividades do lado do cliente com os pedidos que o servidor recebe. Para obter mais informações, veja Monitorizar o Armazenamento de Filas do Azure.

Corpo do pedido

Nenhum.

Pedido de exemplo

Veja a secção "Pedido de exemplo e resposta" mais adiante neste artigo.

Resposta

A resposta inclui um código de estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta que contém a lista de filas.

Código de estado

Uma operação bem-sucedida devolve o código de estado 200 (OK). Para obter informações sobre códigos de estado, veja Códigos de estado e de erro.

Cabeçalhos de resposta

A resposta para esta operação inclui os seguintes cabeçalhos. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta	Descrição
`x-ms-request-id`	Este cabeçalho identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido. Para obter mais informações, veja Resolver problemas de operações da API.
`x-ms-version`	Indica a versão do Armazenamento de Filas utilizada para executar o pedido. Este cabeçalho é devolvido para pedidos feitos na versão 2009-09-19 e posterior.
`Date`	Um valor de data/hora UTC que indica a hora em que a resposta foi iniciada. O serviço gera este valor.
`x-ms-client-request-id`	Pode utilizar este cabeçalho para resolver problemas de pedidos e respostas correspondentes. O valor deste cabeçalho é igual ao valor do `x-ms-client-request-id` cabeçalho, se estiver presente no pedido. O valor é, no máximo, 1024 carateres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente no pedido, este cabeçalho não estará presente na resposta.

Corpo da resposta

O formato do corpo da resposta é o seguinte. Tenha em atenção que os Prefixelementos , Markere MaxResults só estão presentes se os tiver especificado no URI. O NextMarker elemento só tem um valor se os resultados da lista não estiverem concluídos.

Para a versão 2013-08-15 e posterior, o AccountName atributo para o EnumerationResults elemento foi mudado para ServiceEndpoint. Além disso, o Url elemento abaixo Queue foi removido.

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

O Metadata elemento só está presente se o include=metadata parâmetro tiver sido especificado no URI. Dentro do Metadata elemento, o valor de cada par nome-valor é listado num elemento correspondente ao nome do par.

Se um par nome-valor de metadados violar as restrições de nomenclatura impostas pela versão 2009-09-19, o corpo da resposta indica o nome problemático dentro de um x-ms-invalid-name elemento, conforme mostrado no seguinte fragmento XML:

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

Resposta de amostra

Veja a secção "Pedido de exemplo e resposta" mais adiante neste artigo.

Autorização

Apenas o proprietário da conta pode chamar esta operação.

Observações

Se especificar um valor para o maxresults parâmetro e o número de filas a devolver exceder este valor ou exceder o valor predefinido para maxresults, o corpo da resposta contém um NextMarker elemento. Este elemento indica a fila seguinte a devolver num pedido subsequente. Para devolver o próximo conjunto de itens, especifique o valor de como o parâmetro de NextMarker marcador no URI para o pedido subsequente.

Tenha em atenção que o valor de NextMarker deve ser tratado como opaco.

As filas são listadas por ordem alfabética no corpo da resposta.

Pedido de exemplo e resposta

Eis um URI de exemplo que pede a lista de filas de uma conta. Define os resultados máximos a devolver para a operação inicial como três.

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

O pedido é enviado com estes cabeçalhos:

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

O código de estado e os cabeçalhos de resposta são devolvidos da seguinte forma:

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

O XML de resposta para este pedido é o seguinte. Tenha em atenção que o NextMarker elemento segue o conjunto de filas e inclui o nome da fila seguinte a ser devolvida.

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

A operação de lista subsequente especifica o marcador no URI do pedido, da seguinte forma. O próximo conjunto de resultados é devolvido, começando pela fila especificada pelo marcador. Eis o URI para o pedido subsequente:

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

O corpo de resposta para esta operação é o seguinte:

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

Ver também

Autorizar pedidos para o Armazenamento do Azure
Códigos de estado e de erro
Códigos de erro do Armazenamento de Filas

Partilhar via