取得檔案中繼資料
Get File Metadata
作業會傳回容器中所有使用者定義的中繼資料。
通訊協定可用性
已啟用檔案共用通訊協定 | 可用 |
---|---|
SMB | |
NFS |
要求
Get File Metadata
要求的指定方式如下。 建議您使用 HTTPS。
方法 | 要求 URI | HTTP 版本 |
---|---|---|
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
HTTP/1.1 |
GET |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata&sharesnapshot=<DateTime> |
HTTP/1.1 |
將要求 URI 中的路徑元件取代為您自己的路徑元件,如下所示:
路徑元件 | Description |
---|---|
myaccount |
儲存體帳戶的名稱。 |
myshare |
檔案共用的名稱。 |
mydirectorypath |
選擇性。 目錄的路徑。 |
myfile |
檔案的名稱。 |
如需路徑命名限制的詳細資訊,請參閱 名稱和參考共用、目錄、檔案和中繼資料。
URI 參數
您可以在要求 URI 中指定下列其他參數:
參數 | 描述 |
---|---|
sharesnapshot |
選擇性。 版本 2017-04-17 和更新版本。 參數 sharesnapshot 是不透明的 DateTime 值,當存在時,會指定要查詢檔案中繼資料的共用快照集。 |
timeout |
選擇性。
timeout 參數以秒為單位。 如需詳細資訊,請參閱設定Azure 檔案儲存體作業的逾時。 |
要求標頭
下表說明必要的和選擇性要求標頭:
要求標頭 | 描述 |
---|---|
Authorization |
必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊,請參閱授權對 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 檔案儲存體。 |
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 狀態碼和一組回應標頭。
狀態碼
成功的作業會傳回狀態碼「202 (已接受)」。
如需狀態碼的詳細資訊,請參閱 狀態和錯誤碼。
回應標頭
這項作業的回應包括下列標頭。 回應也可能包括其他標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協定規格。
回應標頭 | 描述 |
---|---|
Last-Modified |
傳回上次修改檔案的日期和時間。 日期格式會依照 RFC 1123。 如需詳細資訊,請參閱 代表標頭中的日期/時間值。 任何修改檔案或其屬性的作業會更新上次修改的時間。 |
x-ms-meta-name:value |
包含網站之屬性的一組名稱/值組。 |
x-ms-type: <File> |
傳回 File 供以後使用 |
x-ms-request-id |
可唯一識別所做的要求,並可用來對要求進行疑難排解。 如需詳細資訊,請參閱 針對 API 作業進行疑難排解。 |
ETag |
ETag 包含的值可讓您依條件執行作業。 此值會以引號括住。 |
x-ms-version |
用來執行要求的服務版本。 |
Date 或 x-ms-date |
服務所產生的 UTC 日期/時間值,表示起始回應的時間。 |
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
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2015-02-21
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
授權
只有帳戶擁有者可呼叫這項作業。