取得屬性 |取得狀態 |取得 存取控制 清單 |檢查存取權
取得屬性會傳回路徑的所有系統和使用者定義屬性。 取得狀態會傳回路徑的所有系統定義屬性。 取得 存取控制 清單會傳回路徑的訪問控制清單。 此作業支援條件式 HTTP 要求。 如需詳細資訊，請參閱指定 Blob 服務作業的條件式標頭。
HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}
含選擇性參數:
HEAD https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&upn={upn}&fsAction={fsAction}&timeout={timeout}
URI 參數
| 名稱 |
位於 |
必要 |
類型 |
Description |
|
accountName
|
path |
True
|
string
|
Azure 記憶體帳戶名稱。
|
|
dnsSuffix
|
path |
True
|
string
|
Azure Data Lake Storage 端點的 DNS 後綴。
|
|
filesystem
|
path |
True
|
string
|
文件系統標識碼。
Regex 模式: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
|
|
path
|
path |
True
|
string
|
檔案或目錄路徑。
|
|
action
|
query |
|
PathGetPropertiesAction
|
選擇性。 如果值為 「getStatus」，則只會傳回路徑的系統定義屬性。 如果值為 「getAccessControl」，則會在響應標頭中傳回訪問控制清單， (階層命名空間必須針對帳戶啟用) ，否則會傳回屬性。
|
|
fsAction
|
query |
|
string
|
只有檢查存取動作才需要。 只有在帳戶啟用階層命名空間時才有效。 以字串形式讀取/寫入/執行檔系統作業，比對 regex 模式 '[rwx-]{3}'
|
|
timeout
|
query |
|
integer
int32
|
選擇性的作業逾時值，以秒為單位。 此期間會從服務收到要求時開始。 如果逾時值在作業完成之前經過，作業就會失敗。
|
|
upn
|
query |
|
boolean
|
選擇性。 只有在帳戶啟用階層命名空間時才有效。 如果為 「true」，則會將 x-ms-owner、x-ms-group 和 x-ms-acl 回應標頭中傳回的用戶識別值從 Azure Active Directory 物件標識符轉換成用戶主體名稱。 如果為 「false」，則會以 Azure Active Directory 物件標識碼的形式傳回這些值。 預設值為 false。 請注意，群組和應用程式對象標識碼不會轉譯，因為它們沒有唯一的易記名稱。
|
| 名稱 |
必要 |
類型 |
Description |
|
x-ms-lease-id
|
|
string
|
選擇性。 如果指定此標頭，只有在符合下列兩個條件時，才會執行作業：i) 路徑的租用目前為作用中，而ii) 要求中指定的租用標識符符合路徑的租用標識符。
Regex 模式: ^[{(]?[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 模式: ^[{(]?[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
|
|
傳回檔案或目錄的所有屬性。
標題
- 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 不正確的要求、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
|
定義
DataLakeStorageError
| 名稱 |
類型 |
Description |
|
error
|
Error
|
服務錯誤回應物件。
|
Error
服務錯誤回應物件。
| 名稱 |
類型 |
Description |
|
code
|
string
|
服務錯誤碼。
|
|
message
|
string
|
服務錯誤訊息。
|
PathGetPropertiesAction
選擇性。 如果值為 「getStatus」，則只會傳回路徑的系統定義屬性。 如果值為 「getAccessControl」，則會在響應標頭中傳回訪問控制清單， (階層命名空間必須針對帳戶啟用) ，否則會傳回屬性。
| 名稱 |
類型 |
Description |
|
checkAccess
|
string
|
|
|
getAccessControl
|
string
|
|
|
getStatus
|
string
|
|