Path - List

  • リファレンス
Service:
Storage Services
API Version:
2023-08-03

特定のファイルシステム内のパスとそのプロパティを一覧表示します。

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
With optional parameters: 
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 Storage のアカウント名。
dnsSuffix
 path True

string

Azure Data Lake Storage エンドポイントの DNS サフィックス。
filesystem
 path True

string

ファイルシステム識別子。 値は、文字または数字で始まり、末尾に文字、数字、ダッシュ (-) 文字のみを含める必要があります。 連続するダッシュは使用できません。 すべての文字は小文字にする必要があります。 値は 3 ~ 63 文字にする必要があります。

Regex pattern: ^[$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 に継続トークンが返されます。 応答で継続トークンが返される場合、パスの一覧を続行するには、リスト操作の後続の呼び出しで継続トークンを指定する必要があります。
directory
 query

string

指定したディレクトリ内のパスに結果をフィルター処理します。 ディレクトリが存在しない場合、エラーが発生します。
maxResults
 query

integer

int32

返される項目の最大数を指定する省略可能な値。 省略した場合、または 5,000 を超える場合、応答には最大 5,000 個の項目が含まれます。
timeout
 query

integer

int32

オプションの操作タイムアウト値 (秒単位)。 期間は、サービスが要求を受信したときに開始されます。 操作が完了する前にタイムアウト値が経過すると、操作は失敗します。
upn
 query

boolean

省略可能。 アカウントに対して階層型名前空間が有効になっている場合にのみ有効です。 "true" の場合、各リスト エントリの所有者フィールドとグループ フィールドで返されるユーザー ID 値は、Azure Active Directory オブジェクト ID からユーザー プリンシパル名に変換されます。 "false" の場合、値は Azure Active Directory オブジェクト ID として返されます。 既定値は false です。 グループとアプリケーションのオブジェクト ID は一意のフレンドリ名を持たないため、変換されないことに注意してください。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string

トラブルシューティングと関連付けのために分析ログに記録された UUID。

Regex pattern: ^[{(]?[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

[OK]

Headers

  • 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 Bad Request、ContentLengthMustBeZero、"Content-Length 要求ヘッダーは 0 である必要があります。
  • 400 無効な要求、InvalidAuthenticationInfo、"認証情報が正しい形式で指定されていません。 Authorization ヘッダーの値を確認してください。"
  • 400 無効な要求、InvalidFlushPosition、"アップロードされたデータが連続していないか、位置クエリ パラメーターの値が、アップロードされたデータを追加した後のファイルの長さと等しくありません。"
  • 400 無効な要求、InvalidHeaderValue、"HTTP ヘッダーの 1 つの値が正しい形式ではありません。"
  • 400 無効な要求、InvalidHttpVerb、"指定された HTTP 動詞は無効です。サーバーによって認識されません。"
  • 400 無効な要求、InvalidInput、"要求入力の 1 つが無効です。
  • 400 無効な要求、InvalidPropertyName、"プロパティ名を空にすることはできません。"
  • 400 Bad Request、InvalidPropertyName、"プロパティ名に無効な文字が含まれています。"
  • 400 無効な要求、InvalidQueryParameterValue、"要求 URI で指定されたクエリ パラメーターの 1 つの値が無効です。
  • 400 無効な要求、InvalidResourceName、"指定されたリソース名に無効な文字が含まれています。
  • 400 無効な要求、InvalidSourceUri、"ソース URI が無効です。
  • 400 無効な要求、InvalidUri、"要求 URI が無効です。
  • 400 Bad Request、MissingRequiredHeader、"この要求に必須の HTTP ヘッダーが指定されていません。"
  • 400 Bad Request、MissingRequiredQueryParameter、"この要求に必須のクエリ パラメーターが指定されていません。
  • 400 無効な要求、MultipleConditionHeadersNotSupported、"複数の条件ヘッダーはサポートされていません"。
  • 400 Bad Request、OutOfRangeInput、"要求入力の 1 つが範囲外です。
  • 400 Bad Request、OutOfRangeQueryParameterValue、"要求 URI で指定されたクエリ パラメーターの 1 つが許容範囲外です。
  • 400 無効な要求、UnsupportedHeader、"要求で指定されたヘッダーの 1 つがサポートされていません。"
  • 400 無効な要求、UnsupportedQueryParameter、"要求 URI で指定されたクエリ パラメーターの 1 つがサポートされていません。"
  • 400 無効な要求、UnsupportedRestVersion、"指定された Rest バージョンはサポートされていません。
  • 403 Forbidden、AccountIsDisabled、"指定されたアカウントが無効になっています。"
  • 403 Forbidden、AuthorizationFailure、"この要求は、この操作を実行する権限がありません。
  • 403 Forbidden、InsufficientAccountPermissions、"アクセスされているアカウントには、この操作を実行するための十分なアクセス許可がありません。"
  • 404 Not Found, FilesystemNotFound, "指定されたファイルシステムは存在しません。"
  • 404 Not Found, PathNotFound, "指定されたパスが存在しません。"
  • 404 Not Found、RenameDestinationParentPathNotFound、"宛先パスの親ディレクトリが存在しません。"
  • 404 Not Found、ResourceNotFound、"指定されたリソースが存在しません。"
  • 404 Not Found、SourcePathNotFound、"名前変更操作のソース パスが存在しません。"
  • 405 メソッド Not Allowed、UnsupportedHttpVerb、"リソースは指定された HTTP 動詞をサポートしていません。"
  • 409 Conflict、DestinationPathIsBeingDeleted、"指定された宛先パスは削除済みとしてマークされています。"
  • 409 Conflict, DirectoryNotEmpty, "再帰的なクエリ パラメーター値は、空でないディレクトリを削除するには true である必要があります。"
  • 409 競合、FilesystemAlreadyExists、"指定されたファイルシステムは既に存在します。
  • 409 競合、FilesystemBeingDeleted、"指定されたファイルシステムが削除されています。"
  • 409 Conflict、InvalidDestinationPath、"指定されたパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。* 409 Conflict, InvalidFlushOperation, "リソースは Blob Service API によって作成または変更され、Data Lake Storage サービス API によって書き込むことができません。"
  • 409 Conflict, InvalidRenameSourcePath, "source directory cannot be same as the destination directory, or can be a サブディレクトリ of the source directory."
  • 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 競合、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、"1 秒あたりの操作数がアカウントの制限を超えています。"
  • 503 サービス利用不可、ServerBusy、"サーバーは現在、要求を受信できません。 要求を再試行してください。"

Headers

  • 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[]