Get Share Stats
Get Share Stats request retrieves statistics related to the share.
Get Share Stats request may be constructed as follows. HTTPS is recommended. Replace
myshare with the name of your storage account and share, respectively.
|Method||Request URI||HTTP Version|
The following additional parameters can be specified in the request URI.
||Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.|
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.|
||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. This operation is available only in versions 2015-02-21 and later.
For more information, see Versioning for the Azure Storage Services.
The response includes and HTTP status code, a set of response headers, and a response body.
A successful operation returns status code 200 (OK).
For information about status codes, see Status and Error Codes.
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.
||Returns the date and time the share was last modified. The date format follows RFC 1123. For more information, see Representation of 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.|
||The ETag contains a value that you can use to perform operations conditionally, in quotes.|
||This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.|
||Indicates the version of the File service used to execute the request.|
||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"?> <ShareStats> <ShareUsageBytes>8189134192</ShareUsageBytes> </ShareStats>
||The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.|
Only the account owner may call this operation.
Statistics for a share snapshot cannot be retrieved. If an attempt is made to retrieve share snapshot statistics, then the service returns status code 400 (InvalidQueryParameterValue).
Note that beginning with version 2018-11-09 the
ShareUsage response element was replaced with
ShareUsage is the approximate size of the data stored on the share, rounded up to the nearest GB.