Path - List
指定されたファイルシステム内のパスとそのプロパティを一覧表示します。
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 パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
account
|
path | True |
string |
Azure Storage アカウント名。 |
dns
|
path | True |
string |
Azure Data Lake Storage エンドポイントの DNS サフィックス。 |
filesystem
|
path | True |
string minLength: 3maxLength: 63 pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$ |
ファイルシステム識別子。 値は、文字または数字で始まり、末尾に文字、数字、ダッシュ (-) 文字のみを含める必要があります。 連続するダッシュは使用できません。 すべての文字は小文字にする必要があります。 値は 3 ~ 63 文字にする必要があります。 |
recursive
|
query | True |
boolean |
"true" の場合、すべてのパスが一覧表示されます。それ以外の場合は、ファイルシステムのルートにあるパスのみが一覧表示されます。 "directory" が指定されている場合、リストには同じルートを共有するパスのみが含まれます。 |
resource
|
query | True |
すべてのファイルシステム操作では、値は "filesystem" である必要があります。 |
|
continuation
|
query |
string |
各呼び出しで返されるパスの数は制限されています。 返されるパスの数がこの制限を超えると、応答ヘッダー x-ms-continuation に継続トークンが返されます。 応答で継続トークンが返される場合、パスの一覧表示を続行するには、後続のリスト操作の呼び出しで継続トークンを指定する必要があります。 応答ヘッダー x-ms-continuation で返される継続トークンは、後続の呼び出しで使用される前に URL エンコードされている必要があることに注意してください。 |
|
directory
|
query |
string |
指定したディレクトリ内のパスに結果をフィルター処理します。 ディレクトリが存在しない場合、エラーが発生します。 |
|
max
|
query |
integer (int32) minimum: 1 |
返される項目の最大数を指定する省略可能な値。 省略した場合、または 5,000 を超える場合、応答には最大 5,000 個の項目が含まれます。 |
|
timeout
|
query |
integer (int32) minimum: 1 |
オプションの操作タイムアウト値 (秒単位)。 期間は、サービスが要求を受信したときに開始されます。 操作が完了する前にタイムアウト値が経過すると、操作は失敗します。 |
|
upn
|
query |
boolean |
随意。 アカウントに対して階層型名前空間が有効になっている場合にのみ有効です。 "true" の場合、各リスト エントリの所有者フィールドとグループ フィールドで返されるユーザー ID 値は、Azure Active Directory オブジェクト ID からユーザー プリンシパル名に変換されます。 "false" の場合、値は Azure Active Directory オブジェクト ID として返されます。 既定値は false です。 グループ ID とアプリケーション オブジェクト ID は一意のフレンドリ名を持たないため、変換されないことに注意してください。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-request-id |
string pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$ |
トラブルシューティングと相関関係のために分析ログに記録された UUID。 |
|
x-ms-date |
string |
要求の世界協定時刻 (UTC) を指定します。 これは、共有キーの承認を使用する場合に必要です。 |
|
x-ms-version |
string |
要求の処理に使用される REST プロトコルのバージョンを指定します。 これは、共有キーの承認を使用する場合に必要です。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました ヘッダー
|
|
Other Status Codes |
エラーが発生しました。 可能な HTTP 状態、コード、およびメッセージ文字列を次に示します。
ヘッダー
|
定義
名前 | 説明 |
---|---|
Data |
|
Error |
サービス エラー応答オブジェクト。 |
Filesystem |
すべてのファイルシステム操作では、値は "filesystem" である必要があります。 |
Path | |
Path |
DataLakeStorageError
名前 | 型 | 説明 |
---|---|---|
error |
サービス エラー応答オブジェクト。 |
Error
サービス エラー応答オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サービス エラー コード。 |
message |
string |
サービス エラー メッセージ。 |
FilesystemResourceType
すべてのファイルシステム操作では、値は "filesystem" である必要があります。
値 | 説明 |
---|---|
filesystem |
Path
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
contentLength |
integer (int64) |
||
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[] |