큐 나열

아티클
06/27/2023

이 작업은 특정 스토리지 계정의 모든 큐를 나열합니다.

요청

다음과 같이 요청을 생성할 List Queues 수 있습니다. HTTPS를 사용하는 것이 좋습니다. myaccount를 스토리지 계정 이름으로 바꿉니다.

메서드	요청 URI	HTTP 버전
`GET`	`https://myaccount.queue.core.windows.net?comp=list`	HTTP/1.1

에뮬레이트된 스토리지 서비스 URI

에뮬레이트된 스토리지 서비스에 대해 요청할 때 에뮬레이터 호스트 이름 및 Azure Queue Storage 포트를 로 127.0.0.1:10001지정한 다음 에뮬레이트된 스토리지 계정 이름을 지정합니다.

메서드	요청 URI	HTTP 버전
`GET`	`http://127.0.0.1:10001/devstoreaccount1?comp=list`	HTTP/1.1

URI 매개 변수

요청 URI에 다음 추가 매개 변수를 지정할 수 있습니다.

매개 변수	Description
`prefix`	이름이 지정된 접두사로 시작하는 큐만 반환하도록 결과를 필터링합니다.
`marker`	다음 목록 작업으로 반환할 목록 부분을 식별하는 문자열 값입니다. 반환된 `NextMarker` 목록이 완료되지 않은 경우 작업은 응답 본문 내의 요소를 반환합니다. 그런 다음, 후속 호출에서 이 값을 쿼리 매개 변수로 사용하여 큐 목록의 다음 부분을 요청할 수 있습니다. 마커 값은 클라이언트에 불투명합니다.
`maxresults`	반환할 최대 큐 수를 지정합니다. 를 지정하지 않으면 `maxresults` 서버는 최대 5,000개 항목을 반환합니다.
`include=metadata`	선택 사항입니다. 컨테이너의 메타데이터가 응답 본문의 일부로 반환되도록 하려면 이 매개 변수를 포함합니다. 이 매개 변수로 요청된 메타데이터는 2009-09-19 버전의 Queue Storage에 의해 부과된 명명 제한에 따라 저장되어야 합니다. 이 버전부터 모든 메타데이터 이름은 C# 식별자에 대한 명명 규칙을 준수해야 합니다.
`timeout`	선택 사항입니다. `timeout` 매개 변수는 초 단위로 표시됩니다. 자세한 내용은 Queue Storage 작업에 대한 시간 제한 설정을 참조하세요.

요청 헤더

다음 표에서는 필수 요청 헤더와 선택적 요청 헤더에 대해 설명합니다.

요청 헤더	Description
`Authorization`	필수 요소. 권한 부여 체계, 계정 이름 및 서명을 지정합니다. 자세한 내용은 Azure Storage에 대한 요청 권한 부여를 참조하세요.
`Date` 또는 `x-ms-date`	필수 요소. 요청에 대한 UTC(협정 세계시)를 지정합니다. 자세한 내용은 Azure Storage에 대한 요청 권한 부여를 참조하세요.
`x-ms-version`	선택 사항입니다. 이 요청에 사용할 작업의 버전을 지정합니다. 자세한 내용은 Azure Storage 서비스에 대한 버전 관리를 참조하세요.
`x-ms-client-request-id`	선택 사항입니다. 로깅이 구성될 때 로그에 기록되는 1키비바이트(KiB) 문자 제한으로 클라이언트에서 생성된 불투명 값을 제공합니다. 이 헤더를 사용하여 클라이언트 쪽 활동과 서버가 수신하는 요청의 상관 관계를 지정하는 것이 좋습니다. 자세한 내용은 Azure Queue Storage 모니터링을 참조하세요.

요청 본문

없음

샘플 요청

이 문서의 뒷부분에 있는 "샘플 요청 및 응답" 섹션을 참조하세요.

응답

응답에는 HTTP 상태 코드, 응답 헤더 집합 및 큐 목록을 포함하는 응답 본문이 포함되어 있습니다.

상태 코드

작업에 성공하면 상태 코드 200(정상)이 반환됩니다. 상태 코드에 대한 자세한 내용은 상태 및 오류 코드를 참조하세요.

응답 헤더

이 작업의 응답에는 다음과 같은 헤더가 포함됩니다. 응답에는 표준 HTTP 헤더가 추가로 포함될 수도 있습니다. 모든 표준 헤더는 HTTP/1.1 프로토콜 사양을 준수합니다.

응답 헤더	Description
`x-ms-request-id`	이 헤더는 만들어진 요청을 고유하게 식별하며 요청 문제 해결에 사용할 수 있습니다. 자세한 내용은 API 작업 문제 해결을 참조하세요.
`x-ms-version`	요청을 실행하는 데 사용되는 Queue Storage의 버전을 나타냅니다. 이 헤더는 2009-09-19 버전 이상에 대해 수행된 요청에 대해 반환됩니다.
`Date`	응답이 시작된 시간을 나타내는 UTC 날짜/시간 값입니다. 서비스에서 이 값을 생성합니다.
`x-ms-client-request-id`	이 헤더를 사용하여 요청 및 해당 응답 문제를 해결할 수 있습니다. 이 헤더의 값은 요청에 있는 경우 헤더 값 `x-ms-client-request-id` 과 같습니다. 값은 최대 1024자 표시 ASCII 문자입니다. 헤더가 `x-ms-client-request-id` 요청에 없는 경우 이 헤더는 응답에 존재하지 않습니다.

응답 본문

응답 본문의 형식은 다음과 같습니다. Prefix, Marker및 MaxResults 요소는 URI에 지정한 경우에만 존재합니다. NextMarker 요소에는 목록 결과가 완료되지 않은 경우에만 값이 있습니다.

버전 2013-08-15 이상에서는 AccountName 요소의 EnumerationResults 특성 이름이 로 변경 ServiceEndpoint되었습니다. 또한 Url 아래의 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>

Metadata 요소는 include=metadata 매개 변수가 URI에 지정된 경우에만 제공됩니다. Metadata 요소 내에서 각 이름-값 쌍의 값은 해당 쌍의 이름에 해당하는 요소 내에 나열됩니다.

메타데이터 이름-값 쌍이 2009-09-19 버전에 적용되는 명명 제한 사항을 위반할 경우, 다음 XML 형식에 표시된 것처럼 응답 본문에 x-ms-invalid-name 요소 내의 잘못된 이름이 표시됩니다.

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

샘플 응답

이 문서의 뒷부분에 있는 "샘플 요청 및 응답" 섹션을 참조하세요.

권한 부여

계정 소유자만 이 작업을 호출할 수 있습니다.

설명

매개 변수의 maxresults 값을 지정하고 반환할 큐 수가 이 값을 초과하거나 의 기본값 maxresults을 초과하는 경우 응답 본문에 요소가 포함됩니다 NextMarker . 이 요소는 후속 요청에서 반환할 다음 큐를 나타냅니다. 다음 항목 집합을 반환하려면 후속 요청의 URI에서 마커 매개 변수로 NextMarker 값을 지정합니다.

NextMarker 값은 불투명으로 처리해야 합니다.

큐는 응답 본문에서 알파벳 순서로 나열됩니다.

샘플 요청 및 응답

다음은 계정에 대한 큐 목록을 요청하는 샘플 URI입니다. 초기 작업에 대해 반환할 최대 결과를 3으로 설정합니다.

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

요청은 다음 헤더와 함께 전송됩니다.

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

상태 코드 및 응답 헤더는 다음과 같이 반환됩니다.

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은 다음과 같습니다. NextMarker 요소는 큐 집합을 따르고 반환할 다음 큐의 이름을 포함합니다.

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

후속 목록 작업은 다음과 같이 요청 URI의 마커를 지정합니다. 표식으로 지정된 큐부터 시작하여 다음 결과 집합이 반환됩니다. 다음은 후속 요청의 URI입니다.

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

이 작업의 응답 본문은 다음과 같습니다.

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

추가 정보

Azure Storage에 대한 요청 권한 부여
상태 및 오류 코드
Queue Storage 오류 코드