取得檔案屬性
Get File Properties 作業會傳回檔案所有使用者定義的中繼資料、標準 HTTP 屬性及系統屬性， 它不會傳回檔案的內容。
通訊協定可用性
| 已啟用檔案共享通訊協定 | 可用 |
|---|---|
| SMB |  |
| NFS |  |
要求
Get File Properties 要求的建構如下。 建議您使用 HTTPS。
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime> |
HTTP/1.1 |
以您自己的要求 URI 取代顯示在要求 URI 中的路徑元件，如下所示：
| 路徑元件 | Description |
|---|---|
myaccount |
儲存體帳戶的名稱。 |
myshare |
檔案共用的名稱。 |
mydirectorypath |
選擇性。 上層目錄的路徑。 |
myfile |
檔案的名稱。 |
如需路徑命名限制的詳細資訊，請參閱 名稱和參考共用、目錄、檔案和元數據。
URI 參數
您可以在要求 URI 上指定下列其他參數：
| 參數 | 描述 |
|---|---|
sharesnapshot |
選擇性。 版本 2017-04-17 和更新版本。 參數 sharesnapshot 是不透明的 DateTime 值，當存在時，會指定要查詢檔案屬性的共用快照集。 |
timeout |
選擇性。 timeout 參數以秒為單位。 如需詳細資訊，請參閱設定 Azure 檔案儲存體 作業的逾時。 |
要求標頭
下表說明必要的和選擇性要求標頭：
| 要求標頭 | 描述 |
|---|---|
| 授權 | 必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。 |
Date 或 x-ms-date |
必要。 指定要求的「國際標準時間」(UTC)。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。 |
x-ms-version |
所有授權要求都需要。 指定用於這個要求的作業版本。 如需詳細資訊，請參閱 Azure 儲存體服務的版本。 |
x-ms-lease-id:<ID> |
選擇性。 版本 2019-02-02 和更新版本。 如果指定標頭，則只有在檔案的租用目前為使用中，且要求中指定的租用標識符符合檔案的租用標識符時，才會執行作業。 如果不符合，作業會失敗，狀態代碼為 412 (前置條件失敗) 。 |
x-ms-client-request-id |
選擇性。 提供客戶端產生的不透明值，其中包含 1-kibibyte (KiB) 字元限制，這會在啟用 Azure 儲存體分析 記錄時記錄在分析記錄中。 強烈建議您在將用戶端活動與伺服器所接收的要求相互關聯時，請使用此標頭。 如需詳細資訊，請參閱監視 Azure Blob 儲存體。 |
x-ms-file-request-intent |
如果 Authorization 標頭指定 OAuth 令牌，則為必要專案。 可接受的值為 backup。 此標頭會Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action指定如果指派給使用 Authorization 標頭授權之身分識別的 RBAC 原則中包含 或 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action ，則應該授與 或 。 適用於 2022-11-02 版和更新版本。 |
x-ms-allow-trailing-dot: { <Boolean> } |
選擇性。 版本 2022-11-02 和更新版本。 布爾值會指定是否應該修剪要求 URL 中的尾端點。 如需詳細資訊，請參閱 命名和參考共用、目錄、檔案和元數據。 |
要求本文
無。
回應
回應包括 HTTP 狀態碼和一組回應標頭。
狀態碼
成功的作業會傳回狀態碼 200 (OK)。
如需狀態代碼的詳細資訊，請參閱 狀態和錯誤碼。
回應標頭
這項作業的回應包括下列標頭。 回應也可能包括其他標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協議規格。
| 回應標頭 | 描述 |
|---|---|
Last-Modified |
傳回上次修改檔案的日期和時間。 日期格式會依照 RFC 1123。 如需詳細資訊，請參閱 代表標頭中的日期/時間值。 任何修改檔案或其屬性的作業會更新上次修改的時間。 |
x-ms-meta-name:value |
一組與這個檔案相關聯的名稱/值組，做為使用者定義的元數據。 |
x-ms-type: <File> |
傳回類型 File。 保留供未來使用。 |
Content-Length |
以位元組為單位的檔案大小。 此標頭會傳回與檔案一起儲存的 x-ms-content-length 標頭值。 |
Content-Type |
為檔案指定的內容類型。 如果未指定內容類型，則預設內容類型為 application/octet-stream。 |
ETag |
ETag 包含的值可讓您依條件執行作業。 此值會以引弧括住。 |
Content-MD5 |
若為檔案設定了 Content-MD5 標頭，則會傳回 Content-MD5 回應標頭，以便用戶端檢查訊息內容完整性。 |
Content-Encoding |
若先前為檔案設定了 Content-Encoding 要求標頭，則會傳回此標頭的 Content-Encoding 值。 |
Content-Language |
若先前為檔案設定了 Content-Language 要求標頭，則會傳回此標頭的 Content-Language 值。 |
Cache-Control |
若先前為檔案設定了 Cache-Control 要求標頭，則會傳回此標頭的 Cache-Control 值。 |
Content-Disposition |
傳回對 x-ms-content-disposition 標頭指定的值，並指定回應的處理方式。響應 Content-Disposition 標頭欄位會傳達如何處理響應承載的其他資訊，而且您可以使用它來附加其他元數據。 例如，如果設定為 attachment， Content-Disposition 表示使用者代理程式不應該顯示回應，但應該改為顯示 [另存新檔] 視窗。 |
x-ms-request-id |
可唯一識別已提出的要求，並可用來對要求進行疑難解答。 如需詳細資訊，請參閱 針對 API 作業進行疑難解答。 |
x-ms-version |
指出用來執行要求的服務版本。 |
Date |
服務所產生的 UTC 日期/時間值，表示起始響應的時間。 |
x-ms-copy-completion-time:<datetime> |
版本 2015-02-21 和更新版本。 上次嘗試 複製檔案 作業的結束時間，其中此檔案是目的地檔案。 此值可指定完成、中止或複製嘗試失敗的時間。 如果復本擱置中，如果此檔案從未成為複製文件作業中的目的地，或者此檔案在使用 [設定檔案屬性] 或 [建立檔案] 作業結束之後修改，則不會顯示此標頭。 |
x-ms-copy-status-description: <error string> |
版本 2015-02-21 和更新版本。 只有在失敗或擱置時x-ms-copy-status才會出現。 其描述嚴重或非嚴重複製作業失敗的原因。 如果復本擱置中，如果此檔案從未成為複製文件作業中的目的地，或者此檔案在使用 [設定檔案屬性] 或 [建立檔案] 作業結束之後修改，則不會顯示此標頭。 |
x-ms-copy-id: <id> |
版本 2015-02-21 和更新版本。 上次嘗試複製 檔案 作業的字元串標識符，其中此檔案是目的地檔案。 如果此檔案從未成為複製檔案作業中的目的地，或是此檔案在使用 [設定檔案屬性] 或 [建立檔案] 作業結束之後修改，則不會顯示這個標頭。 |
x-ms-copy-progress: <bytes copied/bytes total> |
版本 2015-02-21 和更新版本。 包含上次嘗試的複製 檔案 作業中，複製的位元元組數目和來源中的位元組總數，其中此檔案是目的地檔案。 可以顯示介於 0 與複製的 Content-Length 位元元數目之間。 如果此檔案從未成為複製檔案作業中的目的地，或是此檔案在使用 [設定檔案屬性] 或 [建立檔案] 作業結束之後修改，則不會顯示這個標頭。 |
x-ms-copy-source: url |
版本 2015-02-21 和更新版本。 最多 2 KB 字元的 URL，指定上次嘗試複製 檔案 作業中使用的來源檔案，其中此檔案是目的地檔案。 如果此檔案從未成為複製檔案作業中的目的地，或是此檔案在使用 [設定檔案屬性] 或 [建立檔案] 作業結束之後修改，則不會顯示這個標頭。 |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
版本 2015-02-21 和更新版本。 由識別 x-ms-copy-id的複製作業狀態，這些值如下：- 成功： 複製成功完成。 - 等待： 複製正在進行中。 檢查 x-ms-copy-status-description 間歇性、非嚴重錯誤是否妨礙複製進度，但不會造成失敗。- 中止： 複製已由 中止複製檔案結束。 - 失敗： 複製失敗。 請參閱 x-ms-copy-status-description，以取得失敗的詳細資料。如果此檔案從未成為複製檔案作業中的目的地，或是此檔案在使用 [設定檔案屬性] 或 [建立檔案] 作業結束之後修改，則不會顯示這個標頭。 |
x-ms-server-encrypted: true/false |
版本 2017-04-17 和更新版本。 如果檔案資料與應用程式中繼資料使用指定的演算法完全加密，這個標頭的值就會設定 true 為 。 如果檔案未加密，或只有檔案或應用程式元資料的一部分加密，則此值會設定 false 為 。 |
x-ms-file-permission-key |
版本 2019-02-02 和更新版本。 檔案許可權的索引鍵。 |
x-ms-file-attributes |
版本 2019-02-02 和更新版本。 檔案的檔案系統屬性。 如需詳細資訊，請參閱 可用屬性的清單。 |
x-ms-file-creation-time |
版本 2019-02-02 和更新版本。 UTC 日期/時間值，表示檔案的建立時間屬性。 |
x-ms-file-last-write-time |
版本 2019-02-02 和更新版本。 UTC 日期/時間值，表示檔案的最後一個寫入時間屬性。 |
x-ms-file-change-time |
版本 2019-02-02 和更新版本。 UTC 日期/時間值，表示檔案的變更時間屬性。 |
x-ms-file-file-id |
版本 2019-02-02 和更新版本。 檔案的檔案識別碼。 |
x-ms-file-parent-id |
版本 2019-02-02 和更新版本。 檔案的父檔案標識碼。 |
x-ms-lease-duration:infinite |
版本 2019-02-02 和更新版本。 當檔案租用時，指定租用是無限持續時間。 |
x-ms-lease-state:<available;leased;broken> |
版本 2019-02-02 和更新版本。 當檔案租用時，指定檔案的租用狀態。 |
x-ms-lease-status:<locked;unlocked> |
版本 2019-02-02 和更新版本。 當檔案租用時，指定檔案的租用狀態。 |
x-ms-client-request-id |
可用來針對要求和對應的回應進行疑難解答。 如果此標頭存在於要求中，則此標頭的值等於標頭的值 x-ms-client-request-id ，且值不包含超過 1,024 個可見的 ASCII 字元。 x-ms-client-request-id如果標頭不存在於要求中，則不會出現在回應中。 |
回應本文
無。
範例回應
Response Status:
HTTP/1.1 200 OK
Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2019-02-02
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6
x-ms-copy-source: <url>
x-ms-copy-status: success
x-ms-copy-progress: 11/11
x-ms-copy-completion-time: <date>
x-ms-lease-duration: infinite
x-ms-lease-state: leased
x-ms-lease-status: locked
授權
只有帳戶擁有者可呼叫這項作業。