Get Queue Metadata
Updated: September 13, 2011
The Get Queue Metadata operation retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs.
The Get Queue Metadata request may be constructed as follows. HTTPS is recommended.
| Method | Request URI | HTTP Version |
|---|---|---|
|
GET/HEAD |
|
HTTP/1.1 |
Emulated Storage Service URI
When making a request against the emulated storage service, specify the emulator hostname and Queue service port as 127.0.0.1:10001, followed by the emulated storage account name:
| Method | Request URI | HTTP Version |
|---|---|---|
|
GET/HEAD |
|
HTTP/1.1 |
For more information, see About Development Storage.
URI Parameters
The following additional parameters may be specified on the request URI.
| Parameter | Description |
|---|---|
|
timeout |
Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations. |
Request Headers
The following table describes required and optional request headers.
| Request Header | Description |
|---|---|
|
Authorization |
Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the Windows Azure Storage Services. |
|
Date or x-ms-date |
Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authentication for the Windows Azure Storage Services. |
|
x-ms-version |
Optional. Specifies the version of the operation to use for this request. For more information, see Versioning for the Blob, Queue, and Table services in Windows Azure. |
Request Body
None.
The response includes an HTTP status code and a set of response headers.
Status Code
A successful operation returns status code 200 (OK).
For information about status codes, see Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
| Response header | Description |
|---|---|
|
x-ms-approximate-messages-count:int-value |
The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. |
|
x-ms-meta-name:string-value |
A user-defined name/value pair. |
|
x-ms-request-id |
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations. |
|
x-ms-version |
Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and later. |
|
Date |
A UTC date/time value generated by the service that indicates the time at which the response was initiated. |
Response Body
None.
Sample Response
Response Status: HTTP/1.1 200 OK Response Headers: Transfer-Encoding: chunked x-ms-approximate-messages-count: 0 Date: Fri, 16 Sep 2011 01:27:38 GMT Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0
This operation can be performed by the account owner and by anyone with a shared access signature that has permission to perform this operation.
None.
