Elenca code

  • Articolo

Questa operazione elenca tutte le code in un determinato account di archiviazione.

Richiesta

È possibile costruire la List Queues richiesta come indicato di seguito. È consigliato il protocollo HTTPS. Sostituire myaccount con il nome dell'account di archiviazione.

Metodo URI richiesta Versione HTTP
GET https://myaccount.queue.core.windows.net?comp=list HTTP/1.1

URI del servizio di archiviazione emulato

Quando si effettua una richiesta con il servizio di archiviazione emulato, specificare il nome host dell'emulatore e la porta di archiviazione code di Azure come 127.0.0.1:10001, seguita dal nome dell'account di archiviazione emulato.

Metodo URI richiesta Versione HTTP
GET http://127.0.0.1:10001/devstoreaccount1?comp=list HTTP/1.1

Parametri dell'URI

È possibile specificare i parametri aggiuntivi seguenti nell'URI della richiesta.

Parametro Descrizione
prefix Filtra i risultati in modo che vengano restituite solo le code i cui nomi iniziano con il prefisso specificato.
marker Valore stringa che identifica la parte dell'elenco da restituire con l'operazione elenco successiva. L'operazione restituisce un NextMarker elemento all'interno del corpo della risposta, se l'elenco restituito non è stato completato. È quindi possibile usare questo valore come parametro di query in una chiamata successiva per richiedere la parte successiva dell'elenco di code.

Il valore marcatore risulta opaco al client.
maxresults Specifica il numero massimo di code da restituire. Se maxresults non è specificato, il server restituirà fino a 5.000 elementi.
include=metadata Facoltativa. Includere questo parametro per specificare che i metadati del contenitore vengano restituiti come parte del corpo della risposta.

Si noti che i metadati richiesti con questo parametro devono essere archiviati in conformità alle restrizioni di denominazione imposte dalla versione 2009-09-19 dell'archiviazione code. A partire da questa versione, tutti i nomi dei metadati devono rispettare le convenzioni di denominazione per gli identificatori C#.
timeout Facoltativa. Il parametro timeout viene espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni di archiviazione code.

Intestazioni della richiesta

Nella seguente tabella vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Intestazione della richiesta Descrizione
Authorization Obbligatorio. Specifica lo schema di autorizzazione, il nome dell'account e la firma. Per altre informazioni, vedere Autorizzare le richieste ad Archiviazione di Azure.
Date o x-ms-date Obbligatorio. Specifica la data per la richiesta nel fuso orario UTC (Coordinated Universal Time). Per altre informazioni, vedere Autorizzare le richieste ad Archiviazione di Azure.
x-ms-version Facoltativa. Specifica la versione dell'operazione da usare per questa richiesta. Per altre informazioni, vedere Controllo delle versioni per i servizi di archiviazione di Azure.
x-ms-client-request-id Facoltativa. Fornisce un valore opaco generato dal client con un limite di caratteri di 1 kibibyte (KiB) registrato nei log quando la registrazione è configurata. È consigliabile usare questa intestazione per correlare le attività lato client con le richieste ricevute dal server. Per altre informazioni, vedere Monitorare l'archiviazione code di Azure.

Testo della richiesta

Nessuno.

Richiesta di esempio

Vedere la sezione "Richiesta di esempio e risposta" più avanti in questo articolo.

Risposta

Nella risposta sono inclusi un codice di stato HTTP, un set di intestazioni della risposta e il corpo della risposta contenente l'elenco di code.

Codice stato

Un'operazione completata correttamente restituisce 200 (OK). Per informazioni sui codici di stato, vedere Codici di stato e di errore.

Intestazioni di risposta

Nella risposta per questa operazione sono incluse le intestazioni riportate di seguito; La risposta può includere anche intestazioni HTTP aggiuntive e standard. Tutte le intestazioni standard sono conformi alla specifica del protocollo HTTP/1.1.

Intestazione risposta Descrizione
x-ms-request-id Questa intestazione identifica in modo univoco la richiesta effettuata e può essere usata per la risoluzione dei problemi della richiesta. Per altre informazioni, vedere Risoluzione dei problemi relativi alle operazioni api.
x-ms-version Indica la versione dell'archiviazione code usata per eseguire la richiesta. Questa intestazione viene restituita per le richieste effettuate nella versione 2009-09-19 e successive.
Date Valore di data/ora UTC che indica l'ora in cui è stata avviata la risposta. Il servizio genera questo valore.
x-ms-client-request-id È possibile usare questa intestazione per risolvere le richieste e le risposte corrispondenti. Il valore di questa intestazione è uguale al valore dell'intestazione x-ms-client-request-id , se presente nella richiesta. Il valore è al massimo 1024 caratteri ASCII visibili. Se l'intestazione x-ms-client-request-id non è presente nella richiesta, questa intestazione non sarà presente nella risposta.

Corpo della risposta

Il formato del corpo della risposta è quello indicato di seguito. Si noti che gli Prefixelementi , Markere MaxResults sono presenti solo se sono stati specificati nell'URI. L'elemento NextMarker ha un valore solo se i risultati dell'elenco non sono completati.

Per la versione 2013-08-15 e successiva, l'attributo per l'elemento AccountNameEnumerationResults è stato rinominato in ServiceEndpoint. Inoltre, l'elemento Url in Queue è stato rimosso.

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

L'elemento Metadata è presente solo se il parametro include=metadata è stato specificato nell'URI. Nell'elemento Metadata il valore di ogni coppia nome-valore è elencato in un elemento corrispondente al nome della coppia.

Se una coppia nome-valore dei metadati viola le restrizioni di denominazione imposte dalla versione 2009-09-19, il corpo della risposta indica il nome problematico in un elemento x-ms-invalid-name, come illustrato nel frammento XML seguente:

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

Risposta di esempio

Vedere la sezione "Richiesta di esempio e risposta" più avanti in questo articolo.

Autorizzazione

Solo il proprietario dell'account può chiamare questa operazione.

Commenti

Se si specifica un valore per il maxresults parametro e il numero di code da restituire supera questo valore o supera il valore predefinito per maxresults, il corpo della risposta contiene un NextMarker elemento. Questo elemento indica la coda successiva da restituire in una richiesta successiva. Per restituire il set successivo di elementi, specificare il valore NextMarker come parametro marcatore nell'URI per la richiesta successiva.

Si noti che il valore NextMarker deve essere considerato opaco.

Le code sono elencate in ordine alfabetico nel corpo della risposta.

Richiesta di esempio e risposta

Ecco un URI di esempio che richiede l'elenco di code per un account. Imposta i risultati massimi da restituire per l'operazione iniziale su tre.

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

La richiesta viene inviata con queste intestazioni:

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

Il codice di stato e le intestazioni della risposta vengono restituiti nel modo seguente:

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

L'XML della risposta per questa richiesta è il seguente. Si noti che l'elemento NextMarker segue il set di code e include il nome della coda successiva da restituire.

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

L'operazione elenco successiva specifica il marcatore nell'URI della richiesta, come illustrato di seguito. Il set successivo di risultati viene restituito, a partire dalla coda specificata dal marcatore. Di seguito è riportato l'URI per la richiesta successiva:

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

Il corpo della risposta per questa operazione è il seguente:

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

Vedi anche

Autorizzare le richieste ad Archiviazione di Azure
Stato e codici errore
Codici di errore di Archiviazione code