(FileREST API) 获取共享统计信息 - Azure 文件存储

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

项目
08/05/2023

请求 Get Share Stats 检索与共享相关的统计信息。尽管此 API 完全受支持，但它是旧版管理 API。出于此原因，建议改用存储资源提供程序提供的 “文件共享 - 获取”， (Microsoft.Storage) 。

若要详细了解如何使用存储资源提供程序以编程方式与FileShare资源交互，请参阅对Azure 文件存储共享的操作。

协议可用性

已启用文件共享协议	可用
SMB
NFS

请求

可以按如下方式构建Get Share Stats请求。建议使用 HTTPS。将 myaccount 替换为存储帐户的名称，将 myshare 替换为共享的名称。

方法	请求 URI	HTTP 版本
GET	`https://myaccount.file.core.windows.net/myshare?restype=share&comp=stats`	HTTP/1.1

URI 参数

可以在请求 URI 中指定以下附加参数：

参数	说明
`timeout`	可选。超时参数以秒表示。有关详细信息，请参阅为Azure 文件存储操作设置超时。

请求标头

下表描述了必需的和可选的请求标头：

请求标头	说明
`Authorization`	必需。指定授权方案、帐户名称和签名。有关详细信息，请参阅授权对 Azure 存储的请求。
`Date` 或 `x-ms-date`	必需。指定请求的协调世界时 (UTC)。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	对于所有已授权的请求是必需的。版本 2015-02-21 及更高版本。指定用于此请求的操作的版本。有关详细信息，请参阅 Azure 存储服务的版本控制。
`x-ms-client-request-id`	可选。提供客户端生成的不透明值，其中包含 1-kibite (KiB) 配置日志记录时记录在日志中的字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视Azure 文件存储。
`x-ms-lease-id:<ID>`	可选。版本 2020-02-10 及更高版本。如果指定了标头，则仅当文件共享的租约当前处于活动状态且请求中指定的租约 ID 与文件共享的租约 ID 匹配时，才会执行该操作。如果没有匹配项，则操作失败，状态代码为 412 (前置条件失败) 。

请求正文

无。

响应

响应包括 HTTP 状态代码、一组响应标头和响应正文。

状态代码

此操作成功后返回状态代码 200（正常）。

有关状态代码的信息，请参阅状态和错误代码。

响应头

此操作的响应包括以下标头。响应还可能包括其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
`Last-Modified`	返回上次修改共享的日期和时间。日期格式遵循 RFC 1123。有关详细信息，请参阅在标头中表示日期/时间值。修改共享或其属性的任何操作都将更新上次修改时间。对文件执行的操作不会影响共享的上次修改时间。
`ETag`	包含可用于有条件地执行操作的值。该值用引号引起来。
`x-ms-request-id`	唯一标识发出的请求，可用于对请求进行故障排除。有关详细信息，请参阅 API 操作疑难解答。
`x-ms-version`	指示用于执行请求的Azure 文件存储版本。
`Date`	由服务生成的 UTC 日期/时间值，指示启动响应的时间。
`x-ms-client-request-id`	可用于对请求及其相应响应进行故障排除。如果请求中存在标头， `x-ms-client-request-id` 并且该值包含的可见 ASCII 字符不超过 1，024 个，则此标头的值等于标头的值。 `x-ms-client-request-id`如果请求中不存在标头，则响应中不会显示该标头。

响应正文

响应正文的格式如下所示：

<?xml version="1.0" encoding="utf-8"?>  
<ShareStats>  
   <ShareUsageBytes>8189134192</ShareUsageBytes>  
</ShareStats>

元素	说明
`ShareUsageBytes`	存储在共享上的数据的大致大小。请注意，此值可能不包含最近创建的所有文件或最近调整大小的文件。

授权

只有帐户所有者可以调用此操作。

注解

无法检索共享快照的统计信息。如果尝试检索共享快照统计信息，该服务将返回状态代码 400 (无效查询参数值) 。

自版本 2018-11-09 起， ShareUsage 响应元素已替换为 ShareUsageBytes。 ShareUsage 是存储在共享上的数据的近似大小，向上舍入到最接近的 gib (GiB) 。

另请参阅

对 Azure 文件共享的操作

通过