Esporta (0) Stampa
Espandi tutto

List Queues

Aggiornamento: novembre 2013

Tramite questa operazione è possibile elencare tutte le code in un determinato account di archiviazione.

La richiesta List Queues può essere costruita nel modo seguente. Si consiglia di utilizzare HTTPS. Sostituire myaccount con il nome dell'account di archiviazione:

 

Metodo URI della richiesta Versione HTTP

GET

https://myaccount.queue.core.windows.net?comp=list

HTTP/1.1

Quando si effettua una richiesta nel servizio di archiviazione emulato, specificare il nome host dell'emulatore e la porta del servizio di accodamento come 127.0.0.1:10001, seguiti dal nome dell'account di archiviazione emulato:

 

Metodo URI della richiesta Versione HTTP

GET

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

HTTP/1.1

Per altre informazioni, vedere About Development Storage.

Nell'URI della richiesta è possibile specificare i parametri aggiuntivi seguenti.

 

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 elemento NextMarker all'interno del corpo della risposta se l'elenco restituito non è completo. Questo valore può essere utilizzato 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 viene specificato, verranno restituiti fino a 5.000 elementi.

include=metadata

Facoltativo. 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 base alle restrizioni di denominazione imposte dalla versione 2009-09-19 del servizio di accodamento. A partire da questa versione, i nomi dei metadati devono essere conformi alle convenzioni di denominazione per gli identificatori C#.

timeout

Facoltativo. Il parametro timeout viene espresso in secondi. Per altre informazioni, vedere Impostazione di timeout per le operazioni del servizio di accodamento.

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

 

Intestazione della richiesta Descrizione

Authorization

Obbligatorio. Specifica lo schema di autenticazione, il nome dell'account e la firma. Per altre informazioni, vedere Autenticazione per i servizi di archiviazione di Azure.

Date o x-ms-date

Obbligatorio. Specifica l'ora UTC (Coordinated Universal Time) per la richiesta. Per altre informazioni, vedere Autenticazione per i servizi di archiviazione di Azure.

x-ms-version

Facoltativo. Specifica la versione dell'operazione da utilizzare per questa richiesta. Per altre informazioni, vedere Controllo delle versioni per i servizi di archiviazione di Azure.

x-ms-client-request-id

Facoltativo. Fornisce un valore opaco generato dal client con un limite di caratteri di 1 KB che viene registrato nei log di analisi quando la registrazione di Analisi archiviazione è abilitata. L'utilizzo di questa intestazione è consigliato per la correlazione tra le attività sul lato client e le richieste ricevute dal server. Per altre informazioni vedere Informazioni sulla registrazione di Analisi archiviazione e l'articolo relativo all'utilizzo di log per tenere traccia delle richiesta di archiviazione nella registrazione di Azure.

Per una richiesta di esempio, vedere la sezione Richiesta e risposta di esempio.

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.

Un'operazione completata correttamente restituisce il codice di stato 200 (OK).

Per informazioni sui codici di stato, vedere Codici ed errori di stato.

Nella risposta per questa operazione sono incluse le intestazioni riportate di seguito; inoltre, possono essere incluse intestazioni HTTP standard aggiuntive. Tutte le intestazioni standard sono conformi alla specifica del protocollo HTTP/1.1.

 

Intestazione della risposta Descrizione

x-ms-request-id

Questa intestazione identifica in modo univoco la richiesta effettuata e può essere utilizzata per risolvere i problemi relativi alla richiesta. Per altre informazioni, vedere Risoluzione dei problemi relativi alle operazioni dell'API.

x-ms-version

Indica la versione del servizio di accodamento utilizzata per eseguire la richiesta. Questa intestazione viene restituita per le richieste effettuate nella versione 2009-09-19 e successive.

Date

Valore data/ora UTC generato dal servizio che indica l'ora in cui è stata avviata la risposta.

Il formato del corpo della risposta è il seguente. Gli elementi Prefix, Marker e MaxResults sono presenti solo se sono stati specificati nell'URI. L'elemento NextMarker contiene un valore solo se i risultati dell'elenco non sono completi.

Per la versione 2013-08-15 e successive, l'attributo AccountName per l'elemento EnumerationResults è 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>
      …

Per una risposta di esempio, vedere la sezione Richiesta e risposta di esempio.

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

Se si specifica un valore per il parametro maxresults e il numero di code da restituire supera questo valore o il valore predefinito per maxresults, il corpo della risposta contiene un elemento NextMarker che indica la coda successiva da restituire su 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.

Di seguito è riportato un URI di esempio che richiede l'elenco di code per un account, impostando su 3 il numero massimo di risultati da restituire per l'operazione iniziale.

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>

Mostra:
© 2014 Microsoft