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

Path - List

服务:

Storage Services

API 版本:

2023-08-03

列出给定文件系统中的路径及其属性。

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem

具有可选参数:

GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Azure 存储帐户名称。
dnsSuffix	path	True	string	Azure Data Lake Storage终结点的 DNS 后缀。
filesystem	path	True	string	文件系统标识符。 该值必须以字母或数字开头和结尾，并且必须仅包含字母、数字和短划线 ( ) 字符。 不允许连续短划线。 所有字母必须为小写。 该值必须包含 3 到 63 个字符。 正则表达式模式: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
recursive	query	True	boolean	如果为“true”，则列出所有路径;否则，仅列出文件系统根目录中的路径。 如果指定了“directory”，则列表将仅包含共享同一根路径。
resource	query	True	FilesystemResourceType	对于所有文件系统操作，该值必须为“filesystem”。
continuation	query		string	每次调用时返回的路径数是有限的。 如果要返回的路径数超过此限制，则会在响应标头 x-ms-continuation 中返回延续标记。 在响应中返回延续标记时，必须在列表操作的后续调用中指定该延续标记才能继续列出路径。 请注意，在响应标头 x-ms-continuation 中返回的继续标记必须先经过 URL 编码，然后才能用于后续调用。
directory	query		string	将结果筛选为指定目录中的路径。 如果目录不存在，则会发生错误。
maxResults	query		integer int32	一个可选值，该值指定要返回的最大项数。 如果省略或大于 5,000，响应将包含最多 5,000 项。
timeout	query		integer int32	可选的操作超时值（以秒为单位）。 时间段从服务收到请求时开始。 如果超时值在操作完成之前已过，则操作将失败。
upn	query		boolean	可选。 仅当为帐户启用分层命名空间时有效。 如果为“true”，则每个列表条目的所有者和组字段中返回的用户标识值将从 Azure Active Directory 对象 ID 转换为用户主体名称。 如果为“false”，则值将作为 Azure Active Directory 对象 ID 返回。 默认值为 false。 请注意，组和应用程序对象 ID 不会转换，因为它们没有唯一的友好名称。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string	在分析日志中记录用于故障排除和关联的 UUID。 正则表达式模式: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date		string	指定请求的协调世界时 (UTC)。 使用共享密钥授权时，这是必需的。
x-ms-version		string	指定用于处理请求的 REST 协议的版本。 使用共享密钥授权时，这是必需的。

响应

名称	类型	说明
200 OK	PathList	正常 标头 Date: string ETag: string Last-Modified: string x-ms-request-id: string x-ms-version: string x-ms-continuation: string x-ms-encryption-scope: string
Other Status Codes	DataLakeStorageError	出现了错误。 下面列出了可能的 HTTP 状态、代码和消息字符串： 400 错误请求，ContentLengthMustBeZero，“内容长度请求标头必须为零。 400 错误请求，InvalidAuthenticationInfo，“身份验证信息未以正确的格式提供。 检查 Authorization 标头的值。” 400 错误请求，InvalidFlushPosition，“上传的数据不是连续的，或者位置查询参数值不等于追加上传的数据后的文件长度。” 400 错误请求，InvalidHeaderValue，“其中一个 HTTP 标头的值的格式不正确。” 400 错误请求，无效HttpVerb，“指定的 HTTP 谓词无效 - 服务器无法识别它。” 400 错误请求，InvalidInput，“其中一个请求输入无效。” 400 错误请求，InvalidPropertyName，“属性名称不能为空。” 400 错误请求，InvalidPropertyName，“属性名称包含无效字符。” 400 错误请求，InvalidQueryParameterValue，“请求 URI 中指定的某个查询参数的值无效。 400 错误请求，InvalidResourceName，“指定的资源名称包含无效字符。” 400 错误请求，InvalidSourceUri，“源 URI 无效。 400 错误请求，InvalidUri，“请求 URI 无效。 400 错误请求，MissingRequiredHeader，“未指定此请求必需的 HTTP 标头。” 400 错误请求，MissingRequiredQueryParameter，“未指定此请求必需的查询参数。” 400 错误请求，MultipleConditionHeadersNotSupported，“不支持多个条件标头。 400 错误请求，OutOfRangeInput，“其中一个请求输入超出范围。 400 错误请求，OutOfRangeQueryParameterValue，“请求 URI 中指定的查询参数之一超出了允许的范围。 400 错误请求，UnsupportedHeader，“不支持请求中指定的标头之一。” 400 错误请求，UnsupportedQueryParameter，“不支持请求 URI 中指定的查询参数之一。 400 错误请求，UnsupportedRestVersion，“指定的 Rest 版本不受支持。 403 禁止，AccountIsDisabled，“指定的帐户已禁用。 403 禁止，AuthorizationFailure，“此请求无权执行此操作。” 403 禁止，InsufficientAccountPermissions，“正在访问的帐户没有足够的权限来执行此操作。” 404 Not Found， FilesystemNotFound， “指定的文件系统不存在。 404 未找到，PathNotFound，“指定的路径不存在。 404 Not Found， RenameDestinationParentPathNotFound， “目标路径的父目录不存在。 404 找不到，ResourceNotFound，“指定的资源不存在。 404 Not Found， SourcePathNotFound， “重命名操作的源路径不存在。 405 方法不允许，不支持HttpVerb，“资源不支持指定的 HTTP 谓词。 409 Conflict，DestinationPathIsBeingDeleted，“指定的目标路径标记为要删除”。 409 Conflict， DirectoryNotEmpty，“递归查询参数值必须为 true 才能删除非空目录。” 409 冲突，FilesystemAlreadyExists，“指定的文件系统已存在。” 409 Conflict， FilesystemBeingDeleted， “指定的文件系统正在删除。 409 Conflict， InvalidDestinationPath，“指定的路径或路径的元素存在，并且其资源类型对于此操作无效。”* 409 冲突，InvalidFlushOperation，“资源是由 Blob 服务 API 创建或修改的，不能由Data Lake Storage服务 API 写入。 409 冲突，InvalidRenameSourcePath，“源目录不能与目标目录相同，目标不能是源目录的子目录。” 409 Conflict，InvalidSourceOrDestinationResourceType，“源和目标资源类型必须相同。 409 冲突，LeaseAlreadyPresent，“已经有一个租约存在。 409 Conflict， LeaseIdMismatchWithLeaseOperation，“指定的租约 ID 与具有指定租约操作的资源的租约 ID 不匹配。 409 Conflict， LeaseIsAlreadyBroken， “租约已被打破， 不能再次打破。 409 Conflict， LeaseIsBreakingAndCannotBeAcquired，“租约 ID 匹配，但租约当前处于中断状态，在中断之前无法获取。 409 Conflict， LeaseIsBreakingAndCannotBeChanged， “租约 ID 匹配，但租约当前处于中断状态，无法更改。 409 Conflict， LeaseIsBrokenAndCannotBeRenewed，“租约 ID 匹配，但租约已显式中断，无法续订。 409 Conflict，LeaseNameMismatch，“指定的租约名称与现有租约名称不匹配。 409 Conflict， LeaseNotPresentWithLeaseOperation， “租约 ID 不存在于指定的租用操作中。” 409 Conflict，PathAlreadyExists，“指定的路径已存在。 409 Conflict，PathConflict，“指定的路径或路径的元素存在，其资源类型对于此操作无效。” 409 Conflict，SourcePathIsBeingDeleted，“指定的源路径标记为要删除”。 409 Conflict，ResourceTypeMismatch，“请求中指定的资源类型与资源类型不匹配。” 412 先决条件失败，ConditionNotMet，“未满足使用 HTTP 条件标头 () 指定的条件。 412 先决条件失败，LeaseIdMismatch，“指定的租用 ID 与资源的租约 ID 不匹配。 412 先决条件失败，LeaseIdMissing，“当前资源上有租约，请求中未指定租约 ID。 412 先决条件失败，LeaseNotPresent，“资源当前没有租约。” 412 先决条件失败，LeaseLost，“已指定租约 ID，但资源的租约已过期。 412 先决条件失败，SourceConditionNotMet，“未满足使用 HTTP 条件标头 () 指定的源条件。 413 请求实体太大，RequestBodyTooLarge，“请求正文太大，超出允许的最大限制。 416 请求的范围不满足，InvalidRange，“指定的范围对于资源的当前大小无效。 500 内部服务器错误，InternalError，“服务器遇到内部错误。 请重试请求。” 500 内部服务器错误，OperationTimedOut，“操作无法在允许的时间内完成。 503 服务不可用，ServerBusy，“出口超出帐户限制。 503 服务不可用，ServerBusy，“入口超出帐户限制。 503 服务不可用，ServerBusy，“每秒操作数超过帐户限制。 503 服务不可用，ServerBusy，“服务器当前无法接收请求。 请重试请求。” 标头 x-ms-request-id: string x-ms-version: string

定义

名称	说明
DataLakeStorageError
Error	服务错误响应对象。
FilesystemResourceType	对于所有文件系统操作，该值必须为“filesystem”。
Path
PathList

DataLakeStorageError

名称	类型	说明
error	Error	服务错误响应对象。

Error

服务错误响应对象。

名称	类型	说明
code	string	服务错误代码。
message	string	服务错误消息。

FilesystemResourceType

对于所有文件系统操作，该值必须为“filesystem”。

名称	类型	说明
filesystem	string

Path

名称	类型	默认值	说明
contentLength	integer
etag	string
group	string
isDirectory	boolean	False
lastModified	string
name	string
owner	string
permissions	string
x-ms-encryption-context	string		如果设置了加密上下文属性值，它将返回设置值。 仅当为帐户启用分层命名空间时有效。
x-ms-encryption-key-sha256	string		服务器将回显客户提供的加密密钥的 SHA256，以验证操作中使用的密钥。
x-ms-encryption-scope	string		如果请求使用了加密范围，则客户端可确保使用加密范围成功加密请求的内容。
x-ms-server-encrypted: true/false	boolean		如果使用指定的算法成功加密请求的内容，则此标头的值设置为 true。

PathList

名称	类型	说明
paths	Path[]