Get Queue Service Stats
Updated: August 4, 2015
The Get Queue Service Stats operation retrieves statistics related to replication for the Queue service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.
The Get Queue Service Stats request may be constructed as follows. HTTPS is recommended. Replace myaccount with the name of your storage account, and note that the -secondary suffix is required:
Note that the URI must always include the forward slash (/) to separate the host name from the path and query portions of the URI. In the case of this operation, the path portion of the URI is empty.
The following additional parameters may be specified on the request URI.
Optional. The timeout parameter is expressed in seconds.
The following table describes required and optional request headers.
Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the 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 Azure Storage Services.
Required for all authenticated requests. Specifies the version of the operation to use for this request. For more information, see Versioning for the File, Blob, Queue, and Table services in Azure.
Optional. Client generated opaque value with 1KB character limit that is recorded in the analytics logs when Storage Analytics Logging is enabled. The use of this header is highly recommended for correlating client side activities with requests received by the server. For more information see Azure Logging: Using Logs to Track Storage Requests.
The response includes an HTTP status code, a set of response headers, and a response body
A successful operation returns status code 200 (OK). When called on secondary location endpoint which is not enabled for secondary read, it will return Http status code of 403 with InsufficientAccountPermissions error.
For information about status codes, see Service Management Status and Error Codes.
The response for this operation includes the following headers. The response also includes additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
Specifies the version of the operation used for the response. For more information, see Versioning for the Blob, Queue, and Table services in Azure.
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?> <StorageServiceStats> <GeoReplication> <Status>live|bootstrap|unavailable</Status> <LastSyncTime>sync-time|<empty></LastSyncTime> </GeoReplication> </StorageServiceStats>
The following table describes the elements of the response body:
The status of the secondary location. Possible values are:
A GMT date/time value, to the second. All primary writes preceding this value are guaranteed to be available for read operations at the secondary. Primary writes after this point in time may or may not be available for reads.
The value may be empty if LastSyncTime is not available. This can happen if the replication status is bootstrap or unavailable.
Although geo-replication is continuously enabled, the LastSyncTime result may reflect a cached value from the service that is refreshed every few minutes.
Only the account owner may call this operation.
With geo-redundant replication, Azure Storage maintains your data durable in two locations. In both locations, Azure Storage constantly maintains multiple healthy replicas of your data.
The location where you read, create, update, or delete data is the primary storage account location. The primary location exists in the region you choose at the time you create an account via the Azure Management Azure Portal, for example, North Central US. The location to which your data is replicated is the secondary location. The secondary location is automatically determined based on the location of the primary; it is in a second data center that resides in the same region as the primary location. Read-only access is available from the secondary location, if read-access geo-redundant replication is enabled for your storage account. For more details about read-access geo-redundant replication, see the Azure Storage Team Blog.
To construct a request for a read operation against the secondary endpoint, append -secondary as a suffix to the account name in the URI that you use to read from Queue storage. For example, a secondary URI for the Peek Messages operation will be similar to https://myaccount-secondary.queue.core.windows.net/myqueue/messages?peekonly=true.
The following is a sample request for the Get Queue Service Stats operation:
GET http://myaccount-secondary.queue.core.windows.net/?restype=service&comp=stats HTTP/1.1
The request is sent with following headers:
x-ms-version: 2013-08-15 x-ms-date: Wed, 23 Oct 2013 22:08:44 GMT Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/E5Gy0fXvg=
The status code and response headers are returned as follows:
HTTP/1.1 200 OK Content-Type: application/xml Date: Wed, 23 Oct 2013 22:08:54 GMT x-ms-version: 2013-08-15 x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30 Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0
The response includes the following XML body:
<?xml version="1.0" encoding="utf-8"?> <StorageServiceStats> <GeoReplication> <Status>live</Status> <LastSyncTime> Wed, 23 Oct 2013 22:05:54 GMT</LastSyncTime> </GeoReplication> </StorageServiceStats>