共用方式為

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 參數

名稱 位於 必要 類型 Description
accountName
 path True

string

Azure 記憶體帳戶名稱。
dnsSuffix
 path True

string

Azure Data Lake Storage 端點的 DNS 後綴。
filesystem
 path True

string

文件系統標識碼。 值必須以字母或數字開頭和結尾，而且必須只包含字母、數位和虛線 ( ) 字元。 不允許連續的虛線。 所有字母都必須是小寫。 值必須介於 3 到 63 個字元之間。

Regex 模式: ^[$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 物件識別碼轉換成用戶主體名稱。 如果為 「false」，則會以 Azure Active Directory 物件標識碼的形式傳回這些值。 預設值為 false。 請注意，群組和應用程式對象標識碼不會轉譯，因為它們沒有唯一的易記名稱。

要求標頭

名稱 必要 類型 Description
x-ms-client-request-id

string

分析記錄中記錄的 UUID，用於疑難解答和相互關聯。

Regex 模式: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

指定要求的「國際標準時間」(UTC)。 使用共用密鑰授權時，這是必要的。
x-ms-version

string

指定用於處理要求的 REST 通訊協定版本。 使用共用密鑰授權時，這是必要的。

回應

名稱 類型 Description
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：「Content-Length 要求標頭必須是零」。
  • 400 不正確的要求，InvalidAuthenticationInfo：「驗證資訊的格式不正確。 檢查 Authorization 標頭的值。」
  • 400 不正確的要求，InvalidFlushPosition：「上傳的數據不連續，或位置查詢參數值不等於附加上傳的數據之後檔案的長度。」
  • 400 不正確的要求，InvalidHeaderValue：「其中一個 HTTP 標頭的值的格式不正確」。
  • 400 不正確的要求，Invalid 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 找不到，FilesystemNotFound：「指定的文件系統不存在」。
  • 404 找不到，PathNotFound，「指定的路徑不存在」。
  • 404 找不到，RenameDestinationParentPathNotFound：「目的地路徑的父目錄不存在」。
  • 404 找不到，ResourceNotFound，「指定的資源不存在」。
  • 404 找不到 SourcePathNotFound：「重新命名作業的來源路徑不存在」。
  • 405 方法不允許，不支援 HttpVerb：「資源不支援指定的 HTTP 動詞。」
  • 409 Conflict， DestinationPathIsBeingDeleted：「指定的目的地路徑標示為要刪除」。
  • 409 Conflict，DirectoryNotEmpty：「遞歸查詢參數值必須是 true，才能刪除非空白目錄。」
  • 409 Conflict， FilesystemAlreadyExists，「指定的文件系統已經存在」。
  • 409 Conflict， FilesystemBeingDeleted，「正在刪除指定的文件系統」。
  • 409 Conflict、InvalidDestinationPath、「指定的路徑或路徑的專案存在，且其資源類型對這項作業無效」。* 409 Conflict，InvalidFlushOperation：「資源是由 Blob 服務 API 建立或修改，無法由 Data Lake Storage 服務 API 寫入。」
  • 409 Conflict、InvalidRenameSourcePath：「來源目錄不能與目的地目錄相同，也無法將目的地做為來源目錄的子目錄」。
  • 409 Conflict、InvalidSourceOrDestinationResourceType：「來源和目的地資源類型必須相同」。
  • 409 Conflict， LeaseAlreadyPresent，「已經有租用存在」。
  • 409 Conflict， LeaseIdMismatchWithLeaseOperation：「指定的租用標識符與具有指定租用作業的資源租用標識符不符」。
  • 409 Conflict，LeaseIsAlreadyBroken：「租用已中斷，無法再次中斷」。
  • 409 Conflict， LeaseIsBreakingAndCannotBeAcquired：「租用標識符相符，但租用目前處於中斷狀態，且在中斷之前無法取得」。
  • 409 Conflict、 LeaseIsBreakingAndCannotBeChanged：「租用標識符相符，但租用目前處於中斷狀態且無法變更」。
  • 409 Conflict、LeaseIsBrokenAndCannotBeRenewed：「租用標識符相符，但租用已明確中斷，且無法更新」。
  • 409 Conflict， LeaseNameMismatch，「指定的租用名稱不符合現有的租用名稱」。
  • 409 Conflict， LeaseNotPresentWithLeaseOperation：「租用標識符不存在於指定的租用作業中」。
  • 409 Conflict，PathAlreadyExists，「指定的路徑已經存在」。
  • 409 Conflict、PathConflict、「指定的路徑或路徑的專案存在，且其資源類型對這項作業無效」。
  • 409 Conflict，SourcePathIsBeingDeleted：「指定的來源路徑標示為要刪除」。
  • 409 Conflict，ResourceTypeMismatch：「要求中指定的資源類型不符合資源的類型」。
  • 412 前置條件失敗，ConditionNotMet：「不符合使用 HTTP 條件式標頭指定的條件 () 」。
  • 412 前置條件失敗，LeaseIdMismatch：「指定的租用標識碼不符合資源的租用標識符」。
  • 412 前置條件失敗，LeaseIdMissing：「資源目前有租用，且要求中未指定租用標識符」。
  • 412 前置條件失敗，LeaseNotPresent：「資源目前沒有租用」。
  • 412 前置條件失敗，LeaseLost，「已指定租用標識符，但資源的租用已過期」。
  • 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

定義

名稱 Description
DataLakeStorageError
Error

服務錯誤回應物件。
FilesystemResourceType

所有文件系統作業的值都必須是 「filesystem」。
Path
PathList

DataLakeStorageError

名稱 類型 Description
error

Error

服務錯誤回應物件。

Error

服務錯誤回應物件。

名稱 類型 Description
code

string

服務錯誤碼。
message

string

服務錯誤訊息。

FilesystemResourceType

所有文件系統作業的值都必須是 「filesystem」。

名稱 類型 Description
filesystem

string

Path

名稱 類型 預設值 Description
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

名稱 類型 Description
paths

Path[]