Path - Get Properties

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

プロパティの取得 |状態の取得 |Access Controlリストを取得する |アクセスの確認
Get Properties は、パスのすべてのシステムおよびユーザー定義のプロパティを返します。 Get Status は、パスのすべてのシステム定義プロパティを返します。 Get Access Control List は、パスのアクセス制御リストを返します。 この操作では、条件付き HTTP 要求がサポートされます。 詳細については、「BLOB サービス操作の条件ヘッダーの指定」を参照してください。

HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}
With optional parameters: 
HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&upn={upn}&fsAction={fsAction}&timeout={timeout}

URI パラメーター

名前 / 必須 型 説明
accountName
 path True

string

Azure Storage のアカウント名。
dnsSuffix
 path True

string

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

string

ファイルシステム識別子。

Regex pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
path
 path True

string

ファイルまたはディレクトリのパス。
action
 query

PathGetPropertiesAction

省略可能。 値が "getStatus" の場合は、パスのシステム定義プロパティのみが返されます。 値が "getAccessControl" の場合、アクセス制御リストが応答ヘッダーに返されます (アカウントに対して階層型名前空間を有効にする必要があります)。それ以外の場合は、プロパティが返されます。
fsAction
 query

string

チェックアクセス アクションにのみ必要です。 アカウントに対して階層型名前空間が有効になっている場合にのみ有効です。 正規表現パターン '[rwx-]{3}' に一致するファイル システム操作を文字列形式で読み取り/書き込み/実行する
timeout
 query

integer

int32

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

boolean

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

要求ヘッダー

名前 必須 型 説明
x-ms-lease-id

string

省略可能。 このヘッダーが指定されている場合、操作は、i) パスのリースが現在アクティブであり、ii) 要求で指定されたリース ID がパスのリース ID と一致する場合にのみ実行されます。

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
If-Match

string

省略可能。 ETag 値。 このヘッダーを指定すると、リソースの ETag が指定値と一致する場合に限り操作が実行されます。 ETag は引用符で指定する必要があります。
If-None-Match

string

省略可能。 ETag 値または特別なワイルドカード ("*") 値。 このヘッダーを指定すると、リソースの ETag が指定値と一致しない場合に限り操作が実行されます。 ETag は引用符で指定する必要があります。
If-Modified-Since

string

省略可能。 日付と時刻の値。 指定した日時以降にリソースが変更された場合にのみ、このヘッダーを指定して操作を実行します。
If-Unmodified-Since

string

省略可能。 日付と時刻の値。 指定した日時以降にリソースが変更されていない場合にのみ、このヘッダーを指定して操作を実行します。
x-ms-encryption-key

string

省略可能。 Base64 でエンコードされた AES-256 暗号化キー。
x-ms-encryption-key-sha256

string

省略可能。 暗号化キーの Base64 でエンコードされた SHA256 ハッシュ。
x-ms-encryption-algorithm: AES256

string

省略可能。 暗号化に使用するアルゴリズムを指定します。 このヘッダーの値は AES256 である必要があります。
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

ファイルまたはディレクトリのすべてのプロパティを返します。

Headers

  • Accept-Ranges: string
  • Cache-Control: string
  • Content-Disposition: string
  • Content-Encoding: string
  • Content-Language: string
  • Content-Length: integer
  • Content-Range: string
  • Content-Type: string
  • Content-MD5: string
  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-resource-type: string
  • x-ms-properties: string
  • x-ms-owner: string
  • x-ms-group: string
  • x-ms-permissions: string
  • x-ms-acl: string
  • x-ms-lease-duration: string
  • x-ms-lease-state: string
  • x-ms-lease-status: string
  • x-ms-server-encrypted: true/false: boolean
  • x-ms-encryption-key-sha256: string
  • x-ms-encryption-context: string
  • x-ms-encryption-scope: string
  • x-ms-creation-time: string
  • x-ms-expiry-time: string
Other Status Codes

DataLakeStorageError

エラーが発生しました。 使用可能な HTTP 状態、コード、およびメッセージ文字列を次に示します。

  • 400 Bad Request、ContentLengthMustBeZero、"Content-Length 要求ヘッダーは 0 である必要があります。
  • 400 Bad Request、InvalidAuthenticationInfo、"認証情報が正しい形式で指定されていません。 Authorization ヘッダーの値を確認してください。
  • 400 Bad Request、InvalidFlushPosition、"アップロードされたデータが連続していないか、位置クエリ パラメーターの値が、アップロードされたデータを追加した後のファイルの長さと等しくありません。"
  • 400 Bad Request、InvalidHeaderValue、"HTTP ヘッダーの 1 つの値が正しい形式ではありません。"
  • 400 Bad Request、InvalidHttpVerb、"指定された HTTP 動詞は無効です。サーバーによって認識されません。
  • 400 Bad Request、InvalidInput、"要求入力の 1 つが無効です。
  • 400 Bad Request、InvalidPropertyName、"プロパティ名を空にすることはできません"。
  • 400 Bad Request、InvalidPropertyName、"プロパティ名に無効な文字が含まれています。
  • 400 Bad Request、InvalidQueryParameterValue、"要求 URI で指定されたクエリ パラメーターの 1 つの値が無効です。
  • 400 Bad Request、InvalidResourceName、"指定されたリソース名に無効な文字が含まれています。
  • 400 無効な要求、InvalidSourceUri、"ソース URI が無効です。
  • 400 Bad Request、InvalidUri、"要求 URI が無効です。
  • 400 Bad Request、MissingRequiredHeader、"この要求に必須の HTTP ヘッダーが指定されていません。
  • 400 Bad Request、MissingRequiredQueryParameter、"この要求に必須のクエリ パラメーターが指定されていません。
  • 400 Bad Request、MultipleConditionHeadersNotSupported、"複数の条件ヘッダーはサポートされていません。
  • 400 Bad Request、OutOfRangeInput、"要求入力の 1 つが範囲外です。
  • 400 Bad Request、OutOfRangeQueryParameterValue、"要求 URI で指定されたクエリ パラメーターの 1 つが許容範囲外です。
  • 400 Bad Request、UnsupportedHeader、"要求で指定されたヘッダーの 1 つがサポートされていません。"
  • 400 Bad Request、UnsupportedQueryParameter、"要求 URI で指定されたクエリ パラメーターの 1 つがサポートされていません。
  • 400 Bad Request、UnsupportedRestVersion、"指定された Rest バージョンはサポートされていません。
  • 403 Forbidden、AccountIsDisabled、"指定されたアカウントが無効になっています。
  • 403 Forbidden、AuthorizationFailure、"この要求は、この操作を実行する権限がありません。
  • 403 Forbidden、InsufficientAccountPermissions、"アクセスされているアカウントには、この操作を実行するための十分なアクセス許可がありません。"
  • 404 見つかりません。FilesystemNotFound、"指定されたファイルシステムが存在しません。
  • 404 見つかりません。PathNotFound、"指定したパスが存在しません。
  • 404 Not Found, RenameDestinationParentPathNotFound, "宛先パスの親ディレクトリが存在しません。"
  • 404 見つかりません。ResourceNotFound、"指定されたリソースが存在しません。
  • 404 Not Found, SourcePathNotFound, "名前変更操作のソース パスが存在しません。"
  • 405 メソッド Not Allowed、UnsupportedHttpVerb、"リソースは指定された HTTP 動詞をサポートしていません。"
  • 409 競合、DestinationPathIsBeingDeleted、"指定した宛先パスは削除対象としてマークされています。
  • 409 Conflict,DirectoryNotEmpty, "空でないディレクトリを削除するには、再帰的なクエリ パラメーター値が true である必要があります。
  • 409 競合、FilesystemAlreadyExists、"指定されたファイルシステムは既に存在します。
  • 409 競合、FilesystemBeingDeleted、"指定されたファイルシステムが削除されています。
  • 409 Conflict、InvalidDestinationPath、"指定したパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。* 409 Conflict, InvalidFlushOperation, "リソースは Blob Service API によって作成または変更され、Data Lake Storage Service API によって書き込むことができません。"
  • 409 Conflict, InvalidRenameSourcePath, "ソース ディレクトリをコピー先ディレクトリと同じにすることも、コピー先をソース ディレクトリのサブディレクトリにすることもできません。"
  • 409 Conflict、InvalidSourceOrDestinationResourceType、"ソースとターゲットのリソースの種類は同じである必要があります。
  • 409 競合、LeaseAlreadyPresent、"既にリースが存在します。
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "指定されたリース ID は、指定されたリース操作を持つリソースのリース ID と一致しませんでした。"
  • 409 Conflict, LeaseIsAlreadyBroken, "リースは既に破損しており、再び壊すことはできません。"
  • 409 競合、LeaseIsBreakingAndCannotBeAcquired、"リース ID は一致しましたが、リースは現在中断状態であり、破損するまで取得できません"。
  • 409 競合、LeaseIsBreakingAndCannotBeChanged、"リース ID は一致しましたが、リースは現在中断状態であり、変更できません"。
  • 409 競合、LeaseIsBrokenAndCannotBeRenewed、"リース ID は一致しましたが、リースは明示的に破損しており、更新できません"。
  • 409 Conflict, LeaseNameMismatch, "指定されたリース名が既存のリース名と一致しませんでした。
  • 409 競合、LeaseNotPresentWithLeaseOperation、"リース ID が指定されたリース操作と一緒に存在しません。
  • 409 Conflict,PathAlreadyExists, "指定されたパスは既に存在します。
  • 409 Conflict、PathConflict、"指定したパス、またはパスの要素が存在し、そのリソースの種類がこの操作に対して無効です。
  • 409 競合、SourcePathIsBeingDeleted、"指定したソース パスは削除対象としてマークされています。
  • 409 競合、ResourceTypeMismatch、"要求で指定されたリソースの種類がリソースの種類と一致しません。"
  • 412 前提条件に失敗しました。ConditionNotMet、「HTTP 条件付きヘッダーを使用して指定された条件が満たされていません。」
  • 412 前提条件に失敗しました。LeaseIdMismatch、「指定されたリース ID がリソースのリース ID と一致しませんでした。」
  • 412 前提条件に失敗しました。LeaseIdMissing、「現在、リソースにリースがあり、要求でリース ID が指定されていません。
  • 412 前提条件に失敗しました。LeaseNotPresent、「現在、リソースにリースはありません。」
  • 412 前提条件に失敗しました。LeaseLost、「リース ID が指定されましたが、リソースのリースの有効期限が切れています。」
  • 412 Precondition Failed,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

サービス エラー応答オブジェクト。
PathGetPropertiesAction

省略可能。 値が "getStatus" の場合は、パスのシステム定義プロパティのみが返されます。 値が "getAccessControl" の場合、アクセス制御リストが応答ヘッダーに返されます (アカウントに対して階層型名前空間を有効にする必要があります)。それ以外の場合は、プロパティが返されます。

DataLakeStorageError

名前 型 説明
error

Error

サービス エラー応答オブジェクト。

Error

サービス エラー応答オブジェクト。

名前 型 説明
code

string

サービス エラー コード。
message

string

サービス エラー メッセージ。

PathGetPropertiesAction

省略可能。 値が "getStatus" の場合は、パスのシステム定義プロパティのみが返されます。 値が "getAccessControl" の場合、アクセス制御リストが応答ヘッダーに返されます (アカウントに対して階層型名前空間を有効にする必要があります)。それ以外の場合は、プロパティが返されます。

名前 型 説明
checkAccess

string

getAccessControl

string

getStatus

string