Get Share Stats
The Get Share Stats request retrieves statistics that are related to the share. Although this API is fully supported, it's a legacy management API. For this reason, we recommend that you use File Shares - Get, which is provided by the storage resource provider (Microsoft.Storage), instead.
To learn more about programmatically interacting with FileShare resources by using the storage resource provider, see Operations on Azure Files shares.
Protocol availability
| Enabled file share protocol | Available |
|---|---|
| SMB |  |
| NFS | |
Request
The Get Share Stats request may be constructed as follows. We recommend that you use HTTPS. Replace myaccount with the name of your storage account, and replace myshare with the name of your share.
| Method | Request URI | HTTP version |
|---|---|---|
| GET | https://myaccount.file.core.windows.net/myshare?restype=share&comp=stats |
HTTP/1.1 |
URI parameters
The following additional parameters can be specified in the request URI:
| Parameter | Description |
|---|---|
timeout |
Optional. The timeout parameter is expressed in seconds. For more information, see Set time-outs for Azure Files operations. |
Request headers
The required and optional request headers are described in the following table:
| Request header | Description |
|---|---|
Authorization |
Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage. |
Date or x-ms-date |
Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage. |
x-ms-version |
Required for all authorized requests. Version 2015-02-21 and later. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage services. |
x-ms-client-request-id |
Optional. Provides a client-generated, opaque value with a 1-kibibyte (KiB) character limit that's recorded in the logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives. For more information, see Monitor Azure Files. |
x-ms-lease-id:<ID> |
Optional. Version 2020-02-10 and later. If the header is specified, the operation is performed only if the file share's lease is currently active and the lease ID specified in the request matches the lease ID of the file share. If there's no match, the operation fails with status code 412 (Precondition Failed). |
Request body
None.
Response
The response includes and HTTP status code, a set of response headers, and a response body.
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 might also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
| Response header | Description |
|---|---|
Last-Modified |
Returns the date and time when the share was last modified. The date format follows RFC 1123. For more information, see Represent date/time values in headers. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share. |
ETag |
Contains a value that you can use to perform operations conditionally. The value is enclosed in quotation marks. |
x-ms-request-id |
Uniquely identifies the request that was made and can be used to troubleshoot the request. For more information, see Troubleshoot API operations. |
x-ms-version |
Indicates the Azure Files version that was used to execute the request. |
Date |
A UTC date/time value that's generated by the service, which indicates the time when the response was initiated. |
x-ms-client-request-id |
Can be used to troubleshoot requests and their corresponding responses. The value of this header is equal to the value of the x-ms-client-request-id header if it's present in the request and the value contains no more than 1,024 visible ASCII characters. If the x-ms-client-request-id header isn't present in the request, it won't be present in the response. |
Response body
The format of the response body is as follows:
<?xml version="1.0" encoding="utf-8"?>
<ShareStats>
<ShareUsageBytes>8189134192</ShareUsageBytes>
</ShareStats>
| Element | Description |
|---|---|
ShareUsageBytes |
The approximate size of the data stored on the share. Note that this value might not include all recently created or recently resized files. |
Authorization
Only the account owner may call this operation.
Remarks
Statistics for a share snapshot can't be retrieved. If an attempt is made to retrieve the share snapshot statistics, the service returns status code 400 (Invalid Query Parameter Value).
As of version 2018-11-09 the ShareUsage response element was replaced with ShareUsageBytes. ShareUsage is the approximate size of the data that's stored on the share, rounded up to the nearest gibibyte (GiB).