你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
获取目录属性
该Get Directory Properties
操作返回指定目录的所有系统属性,还可用于检查目录是否存在。 返回的数据不包括目录或任何子目录中的文件。
协议可用性
已启用文件共享协议 | 可用 |
---|---|
SMB | |
NFS |
请求
可以按如下方式构建Get Directory Properties
请求。 建议使用 HTTPS。
方法 | 请求 URI | HTTP 版本 |
---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare/myparentdirectorypath/mydirectory?restype=directory |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare/ myparentdirectorypath/mydirectory?restype=directory&sharesnapshot=<DateTime> |
HTTP/1.1 |
将请求 URI 中显示的路径组件替换为自己的组件,如下所示:
路径组件 | 说明 |
---|---|
myaccount |
存储帐户的名称。 |
myshare |
文件共享的名称。 |
myparentdirectorypath |
可选。 父目录的路径。 |
mydirectory |
目录名。 |
有关路径命名限制的信息,请参阅 名称和引用共享、目录、文件和元数据。
URI 参数
可以在请求 URI 上指定以下附加参数:
参数 | 说明 |
---|---|
sharesnapshot |
可选。 版本 2017-04-17 及更高版本。 参数sharesnapshot 是一个不透明的 DateTime 值,如果存在,则指定用于查询目录属性的共享快照 |
timeout |
可选。
timeout 参数以秒表示。 有关详细信息,请参阅为Azure 文件存储操作设置超时。 |
请求标头
下表描述了必需的和可选的请求标头:
请求标头 | 说明 |
---|---|
Authorization |
必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求。 |
Date 或 x-ms-date |
必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求。 |
x-ms-version |
对于所有已授权的请求是必需的,对于匿名请求是可选的。 指定用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制。 |
x-ms-client-request-id |
可选。 提供客户端生成的不透明值,其中包含 1-kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure 文件存储。 |
x-ms-file-request-intent |
如果 Authorization 标头指定 OAuth 令牌,则为必需。 可接受的值为 backup 。 此标头指定Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action 如果或包含在分配给使用 标头授权的标识的 RBAC 策略中,则应授予 或 Authorization 。 适用于版本 2022-11-02 及更高版本。 |
x-ms-allow-trailing-dot: { <Boolean> } |
可选。 版本 2022-11-02 及更高版本。 布尔值指定是否应剪裁请求 URL 中存在的尾随点。 有关详细信息,请参阅 命名和引用共享、目录、文件和元数据。 |
请求正文
无。
示例请求
HEAD https://myaccount.file.core.windows.net/myshare/myparentdirectorypath/mydirectory?restype=directory HTTP/1.1
Request Headers:
x-ms-version: 2015-02-21
x-ms-date: <date>
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=
响应
响应包括 HTTP 状态代码和一组响应标头。
状态代码
此操作成功后返回状态代码 200(正常)。
有关状态代码的详细信息,请参阅 状态和错误代码。
响应头
此操作的响应包括以下标头。 该响应还可能包括其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范。
响应标头 | 说明 |
---|---|
ETag |
ETag 包含一个值,你可以使用该值有条件地执行操作。 该值用引号引起来。 |
Last-Modified |
返回上次修改目录的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息,请参阅 在标头中表示日期/时间值。 对目录中的文件执行的操作不会影响目录的上次修改时间。 |
x-ms-meta-name:value |
一组包含目录元数据的名称/值对。 |
x-ms-request-id |
返回请求的唯一标识符,这有助于对请求进行故障排除。 有关详细信息,请参阅 API 操作疑难解答。 |
x-ms-version |
指示用于执行请求的服务版本。 |
Date |
由服务生成的 UTC 日期/时间值,指示启动响应的时间。 |
x-ms-server-encrypted: true/false |
版本 2017-04-17 及更高版本。 如果使用指定的算法完全加密目录元数据,则此标头的值设置为 true 。 如果元数据未加密,则值设置为 false 。 |
x-ms-file-permission-key |
版本 2019-02-02 及更高版本。 目录权限的键。 |
x-ms-file-attributes |
版本 2019-02-02 及更高版本。 目录上的文件系统属性。 有关详细信息,请参阅 可用属性列表。 |
x-ms-file-creation-time |
版本 2019-02-02 及更高版本。 表示目录的创建时间属性的 UTC 日期/时间值。 |
x-ms-file-last-write-time |
版本 2019-02-02 及更高版本。 表示目录的上次写入时间属性的 UTC 日期/时间值。 |
x-ms-file-change-time |
版本 2019-02-02 及更高版本。 表示目录的更改时间属性的 UTC 日期/时间值。 |
x-ms-file-file-id |
版本 2019-02-02 及更高版本。 目录的文件 ID。 |
x-ms-file-parent-id |
版本 2019-02-02 及更高版本。 目录的父文件 ID。 |
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:
Transfer-Encoding: chunked
Date: <date>
ETag: "0x8CAFB82EFF70C46"
Last-Modified: <date>
x-ms-version: 2015-02-21
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
授权
只有帐户所有者可以调用此操作。
注解
如果指定的目录路径不存在,请求将失败,状态代码为 404 (找不到) 。