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

获取文件元数据

Get File Metadata操作返回指定文件的所有用户定义元数据。

协议可用性

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

请求

按如下方式构建Get File Metadata请求。 建议使用 HTTPS。

方法 请求 URI HTTP 版本
GET https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata HTTP/1.1
GET https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata&sharesnapshot=<DateTime> HTTP/1.1

将请求 URI 中所示的路径组件替换为你自己的组件,如下所示:

路径组件 说明
myaccount 存储帐户的名称。
myshare 文件共享的名称。
mydirectorypath 可选。 目录的路径。
myfile 文件的名称。

有关路径命名限制的信息,请参阅 名称和引用共享、目录、文件和元数据

URI 参数

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

参数 说明
sharesnapshot 可选。 版本 2017-04-17 及更高版本。 参数sharesnapshot是一个不透明的 DateTime 值,如果存在,则指定要查询文件元数据的共享快照。
timeout 可选。 timeout 参数以秒表示。 有关详细信息,请参阅为Azure 文件存储操作设置超时

请求标头

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

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求
Datex-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制
x-ms-lease-id:<ID> 可选。 版本 2019-02-02 及更高版本。 如果指定了 标头,则仅当文件的租约当前处于活动状态且请求中指定的租约 ID 与文件的租约 ID 匹配时,才会执行该操作。 否则,操作将失败,状态代码为 412 (前置条件失败) 。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,其中包含 1 kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure 文件存储
x-ms-file-request-intent 如果 Authorization 标头指定 OAuth 令牌,则为必需。 可接受的值为 backup。 此标头指定Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action如果或包含在分配给使用 标头授权的标识的 RBAC 策略中,则应授予 或 Authorization 。 适用于版本 2022-11-02 及更高版本。
x-ms-allow-trailing-dot: { <Boolean> } 可选。 版本 2022-11-02 及更高版本。 布尔值指定是否应剪裁请求 URL 中存在的尾随点。 有关详细信息,请参阅 命名和引用共享、目录、文件和元数据

请求正文

无。

响应

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

状态代码

成功的操作将返回状态代码 202(已接受)。

有关状态代码的详细信息,请参阅 状态和错误代码

响应标头

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

响应标头 说明
Last-Modified 返回上次修改文件的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息,请参阅 在标头中表示日期/时间值。 修改文件或其属性的任何操作会更新上次修改时间。
x-ms-meta-name:value 一组包含文件元数据的名称-值对。
x-ms-type: <File> 返回 File 并留作将来使用。
x-ms-request-id 唯一标识发出的请求,并可用于对请求进行故障排除。 有关详细信息,请参阅 API 操作疑难解答
ETag ETag 包含一个值,你可以使用该值有条件地执行操作。 该值用引号引起来。
x-ms-version 用于执行请求的服务版本。
Datex-ms-date 由服务生成的 UTC 日期/时间值,指示启动响应的时间。
x-ms-client-request-id 此标头可用于对请求和相应的响应进行故障排除。 如果请求中存在标头, x-ms-client-request-id 并且该值包含的可见 ASCII 字符不超过 1,024 个,则此标头的值等于标头的值。 x-ms-client-request-id如果请求中不存在标头,则响应中不存在该标头。

响应正文

无。

示例响应

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
x-ms-type: File  
x-ms-meta-m1: v1  
x-ms-meta-m2: v2  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-version: 2015-02-21  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  

授权

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

另请参阅

Azure 文件存储上的操作