Daftar Antrean

Artikel
06/27/2023

Operasi ini mencantumkan semua antrean di akun penyimpanan tertentu.

Minta

Anda dapat membuat List Queues permintaan sebagai berikut. HTTPS disarankan. Ganti myaccount dengan nama akun penyimpanan Anda.

Metode	Meminta URI	Versi HTTP
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

URI layanan penyimpanan yang ditimulasikan

Saat Anda membuat permintaan terhadap layanan penyimpanan yang ditimulasi, tentukan nama host emulator dan port Azure Queue Storage sebagai 127.0.0.1:10001, diikuti dengan nama akun penyimpanan yang ditimulasi.

Metode	Meminta URI	Versi HTTP
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan.

Parameter	Deskripsi
`prefix`	Memfilter hasil untuk mengembalikan hanya antrean dengan nama yang dimulai dengan awalan yang ditentukan.
`marker`	Nilai string yang mengidentifikasi bagian daftar yang akan dikembalikan dengan operasi daftar berikutnya. Operasi mengembalikan `NextMarker` elemen dalam isi respons, jika daftar yang dikembalikan tidak selesai. Anda kemudian dapat menggunakan nilai ini sebagai parameter kueri dalam panggilan berikutnya untuk meminta bagian berikutnya dari daftar antrean. Nilai penanda buram untuk klien.
`maxresults`	Menentukan jumlah maksimum antrean yang akan dikembalikan. Jika `maxresults` tidak ditentukan, server akan mengembalikan hingga 5.000 item.
`include=metadata`	Pilihan. Sertakan parameter ini untuk menentukan bahwa metadata kontainer dikembalikan sebagai bagian dari isi respons. Perhatikan bahwa metadata yang diminta dengan parameter ini harus disimpan sesuai dengan pembatasan penamaan yang diberlakukan oleh Queue Storage versi 2009-09-19. Dimulai dengan versi ini, semua nama metadata harus mematuhi konvensi penamaan untuk pengidentifikasi C#.
`timeout`	Pilihan. Parameter `timeout` dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Queue Storage.

Header permintaan

Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.

Meminta kop	Deskripsi
`Authorization`	Wajib diisi. Menentukan skema otorisasi, nama akun, dan tanda tangan. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage.
`Date` atau `x-ms-date`	Wajib diisi. Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage.
`x-ms-version`	Opsional. Menentukan versi operasi yang akan digunakan untuk permintaan ini. Untuk informasi selengkapnya, lihat Penerapan versi untuk layanan Azure Storage.
`x-ms-client-request-id`	Opsional. Menyediakan nilai buram yang dihasilkan klien dengan batas karakter 1 kibibyte (KiB) yang dicatat dalam log saat pengelogan dikonfigurasi. Kami sangat menyarankan Anda menggunakan header ini untuk menghubungkan aktivitas sisi klien dengan permintaan yang diterima server. Untuk informasi selengkapnya, lihat Memantau Azure Queue Storage.

Isi permintaan

Tidak ada.

Permintaan sampel

Lihat bagian "Sampel permintaan dan respons" nanti di artikel ini.

Respons

Respons mencakup kode status HTTP, sekumpulan header respons, dan isi respons yang berisi daftar antrean.

Kode status

Operasi yang berhasil mengembalikan kode status 200 (OK). Untuk informasi tentang kode status, lihat Kode status dan kesalahan.

Header respons

Respons untuk operasi ini mencakup header berikut. Respons juga dapat mencakup header HTTP standar tambahan. Semua header standar sesuai dengan spesifikasi protokol HTTP/1.1.

Header respons	Deskripsi
`x-ms-request-id`	Header ini secara unik mengidentifikasi permintaan yang dibuat, dan dapat digunakan untuk memecahkan masalah permintaan. Untuk informasi selengkapnya, lihat Pemecahan masalah operasi API.
`x-ms-version`	Menunjukkan versi Queue Storage yang digunakan untuk menjalankan permintaan. Header ini dikembalikan untuk permintaan yang dibuat terhadap versi 2009-09-19 dan yang lebih baru.
`Date`	Nilai tanggal/waktu UTC yang menunjukkan waktu di mana respons dimulai. Layanan menghasilkan nilai ini.
`x-ms-client-request-id`	Anda dapat menggunakan header ini untuk memecahkan masalah permintaan dan respons terkait. Nilai header ini sama dengan nilai `x-ms-client-request-id` header, jika ada dalam permintaan. Nilainya paling banyak 1024 karakter ASCII yang terlihat. `x-ms-client-request-id` Jika header tidak ada dalam permintaan, header ini tidak akan ada dalam respons.

Isi Respons

Format isi respons adalah sebagai berikut. Perhatikan bahwa Prefixelemen , Marker, dan MaxResults hanya ada jika Anda menentukannya pada URI. Elemen NextMarker memiliki nilai hanya jika hasil daftar tidak selesai.

Untuk versi 2013-08-15 dan yang lebih baru, AccountName atribut untuk EnumerationResults elemen telah diganti namanya menjadi ServiceEndpoint. Selain itu, elemen di Url bawah Queue telah dihapus.

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

Elemen Metadata hanya ada jika include=metadata parameter ditentukan pada URI. Metadata Dalam elemen , nilai setiap pasangan nama-nilai tercantum dalam elemen yang sesuai dengan nama pasangan.

Jika pasangan nama-nilai metadata melanggar pembatasan penamaan yang diberlakukan oleh versi 2009-09-19, isi respons menunjukkan nama yang bermasalah dalam elemen, seperti yang x-ms-invalid-name ditunjukkan dalam fragmen XML berikut:

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

Respons sampel

Lihat bagian "Sampel permintaan dan respons" nanti di artikel ini.

Authorization

Hanya pemilik akun yang dapat memanggil operasi ini.

Keterangan

Jika Anda menentukan nilai untuk maxresults parameter, dan jumlah antrean yang akan dikembalikan melebihi nilai ini, atau melebihi nilai default untuk maxresults, isi respons berisi NextMarker elemen . Elemen ini menunjukkan antrean berikutnya untuk kembali pada permintaan berikutnya. Untuk mengembalikan kumpulan item berikutnya, tentukan nilai NextMarker sebagai parameter penanda pada URI untuk permintaan berikutnya.

Perhatikan bahwa nilai NextMarker harus diperlakukan sebagai buram.

Antrean tercantum dalam urutan alfabet dalam isi respons.

Sampel permintaan dan respons

Berikut adalah sampel URI yang meminta daftar antrean untuk akun. Ini mengatur hasil maksimum yang akan dikembalikan untuk operasi awal menjadi tiga.

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

Permintaan dikirim dengan header ini:

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

Kode status dan header respons dikembalikan sebagai berikut:

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

XML respons untuk permintaan ini adalah sebagai berikut. Perhatikan bahwa NextMarker elemen mengikuti set antrean, dan menyertakan nama antrean berikutnya yang akan dikembalikan.

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

Operasi daftar berikutnya menentukan penanda pada URI permintaan, sebagai berikut. Kumpulan hasil berikutnya dikembalikan, dimulai dengan antrean yang ditentukan oleh penanda. Berikut adalah URI untuk permintaan berikutnya:

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

Isi respons untuk operasi ini adalah sebagai berikut:

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

Lihat juga

Mengotorisasi permintaan ke Azure Storage
Status dan kode galat
Kode kesalahan Queue Storage