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

获取目录属性

Get Directory Properties作返回指定目录的所有系统属性,它还可用于检查目录是否存在。 返回的数据不包括目录或任何子目录中的文件。 在版本 2025-05-05 及更高版本中支持此作,以启用 NFS 协议的文件共享。

协议可用性

已启用文件共享协议 可用
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 存储的请求。
Datex-ms-date 必填。 指定请求的协调世界时(UTC)。 有关详细信息,请参阅 授权对 Azure 存储的请求。
x-ms-version 所有授权请求都是必需的。 指定要用于此请求的作的版本。 在版本 2025-05-05 及更高版本中支持此作,以启用 NFS 协议的文件共享。

有关详细信息,请参阅 azure 存储服务 版本控制。
x-ms-client-request-id 自选。 提供客户端生成的不透明值,该值具有配置日志记录时日志中记录的 1-kibibyte (KiB) 字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅 监视 Azure 文件
x-ms-file-request-intent 如果需要 Authorization 标头指定 OAuth 令牌。 可接受的值为 backup。 此标头指定,如果 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action 包含在分配给使用 Authorization 标头授权的标识的 RBAC 策略中,则应授予 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action。 适用于版本 2022-11-02 及更高版本。
x-ms-allow-trailing-dot: { <Boolean> } 自选。 版本 2022-11-02 及更高版本。 布尔值指定是否应剪裁请求 URL 中存在的尾随点。

如果目标位于启用了 NFS 协议的文件共享上,则默认支持尾随点,则忽略此标头。

有关详细信息,请参阅 命名和引用共享、目录、文件和元数据

仅 SMB 请求标头

没有。

仅 NFS 请求标头

没有。

请求正文

没有。

示例请求

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-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 标头的值,并且该值包含不超过 1,024 个可见 ASCII 字符。 如果请求中不存在 x-ms-client-request-id 标头,则响应中不存在该标头。

仅 SMB 响应标头

响应标头 描述
x-ms-file-permission-key 版本 2019-02-02 及更高版本。 目录权限的密钥。
x-ms-file-attributes 版本 2019-02-02 及更高版本。 目录中的文件系统属性。 有关详细信息,请参阅可用属性 列表。

仅 NFS 响应标头

响应标头 描述
x-ms-mode 版本 2025-05-05 及更高版本。 目录的模式。 请参阅 POSIX 文件权限(模式)
x-ms-owner 版本 2025-05-05 及更高版本。 目录所有者的用户标识符(UID)。
x-ms-group 版本 2025-05-05 及更高版本。 目录所有者的组标识符(GID)。
x-ms-file-file-type 版本 2025-05-05 及更高版本。 文件的类型,可能的值为:Directory

响应正文

没有。

示例响应

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  

授权

只有帐户所有者才能调用此作。

文件系统属性

属性 Win32 文件属性 定义
ReadOnly FILE_ATTRIBUTE_READONLY 只读文件。 应用程序可以读取文件,但无法写入文件或删除该文件。
隐藏 FILE_ATTRIBUTE_HIDDEN 文件已隐藏。 它不包括在普通目录列表中。
系统 FILE_ATTRIBUTE_SYSTEM 作系统使用部分或独占使用的文件。
没有 FILE_ATTRIBUTE_NORMAL 未设置其他属性的文件。 此属性仅在单独使用时才有效。
档案 FILE_ATTRIBUTE_ARCHIVE 作为存档文件的文件。 应用程序通常使用此属性标记文件以供备份或删除。
临时 FILE_ATTRIBUTE_TEMPORARY 用于临时存储的文件。
离线 FILE_ATTRIBUTE_OFFLINE 文件的数据不会立即可用。 此文件系统属性主要用于提供与 Windows 的兼容性。 Azure 文件不支持脱机存储选项。
NotContentIndexed FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 文件不会由内容索引服务编制索引。
NoScrubData FILE_ATTRIBUTE_NO_SCRUB_DATA 用户数据流不会由后台数据完整性扫描程序读取。 此文件系统属性主要用于提供与 Windows 的兼容性。

POSIX 文件权限(模式)

POSIX 文件权限可以用 12 位数字八进制格式或符号“rwx”格式进行数字指定。 例子:

  • “0644”或“rw-r--r--”:用户(文件所有者)具有读取、写入权限。 组具有读取权限。 其他人具有读取权限。
  • “0755”或“rwxr-xr-x”:用户(文件所有者)具有读取、写入和执行权限。 组具有读取和执行权限。 其他人具有读取和执行权限。

数字八进制格式

三个最低顺序八进制数表示所有者/用户、组和其他用户的权限,并使用八进制数(0-7)表示使用按位组合“4”(读取)、“2”(写入)、“1”(执行)。 最高阶八进制数(0-7)用于指示“4”(SetUID)、“2”(SetGID)、“1”(StickyBit)权限的组合。

格式 许可
0700 用户(文件所有者)具有读取、写入和执行权限。
0400 用户具有读取权限。
0200 用户具有写入权限。
0100 用户具有执行权限。
0070 组具有读取、写入和执行权限。
0040 组具有读取权限。
0020 组具有写入权限。
0010 组具有执行权限。
0007 其他人具有读取、写入和执行权限。
0004 其他人具有读取权限。
0002 其他人具有写入权限。
0001 其他人具有执行权限。
4000 在文件上设置有效的用户 ID。
2000 在文件上设置有效组 ID。
1000 设置为指示文件只能由文件所有者、目录所有者或根用户删除或重命名文件。

符号“rwx”格式

所有者/用户、组和其他用户的权限使用“r”(读取)、“w”(写入)和“x”(执行)字符的组合来指示。

格式 许可
rwx------ 用户(文件所有者)具有读取、写入和执行权限。
r-------- 用户具有读取权限。
-w------- 用户具有写入权限。
--x------ 用户具有执行权限。
---rwx--- 组具有读取、写入和执行权限。
---r----- 组具有读取权限。
----w---- 组具有写入权限。
-----x--- 组具有执行权限。
------rwx 其他人具有读取、写入和执行权限。
------r-- 其他人具有读取权限。
-------w- 其他人具有写入权限。
--------x 其他人具有执行权限。

言论

如果指定的目录路径不存在,则请求失败,状态代码为 404(找不到)。

另请参阅

目录上的