取得共用中繼資料
此 Get Share Metadata 作業會傳回 Azure 檔案共用或共用快照集的所有使用者定義中繼資料。
雖然完全支援此 API，但它是舊版管理 API。 基於這個理由，建議您改用 檔案共用 - Get，這是由儲存體資源提供者提供， (Microsoft.Storage) 。
若要深入瞭解如何使用儲存體資源提供者以程式設計方式與 FileShare 資源互動，請參閱 Azure 檔案共用上的作業。
通訊協定可用性
| 已啟用檔案共用通訊協定 | 可用 |
|---|---|
| SMB |  |
| NFS | |
要求
Get Share Metadata 要求的指定方式如下。 建議您使用 HTTPS。
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime> |
HTTP/1.1 |
以您自己的方式取代要求 URI 中顯示的路徑元件，如下所示：
| 路徑元件 | Description |
|---|---|
myaccount |
儲存體帳戶的名稱。 |
myshare |
檔案共用的名稱。 |
如需路徑命名限制的相關資訊，請參閱 名稱和參考共用、目錄、檔案和中繼資料。
URI 參數
您可以在要求 URI 中指定下列額外的參數：
| 參數 | 描述 |
|---|---|
sharesnapshot |
選擇性。 版本 2017-04-17 和更新版本。 參數 sharesnapshot 是不透明的日期/時間值，當存在時，會指定要查詢的共用快照集以擷取中繼資料 |
timeout |
選擇性。 timeout 參數以秒為單位。 如需詳細資訊，請參閱設定Azure 檔案儲存體作業的逾時。 |
要求標頭
| 要求標頭 | 描述 |
|---|---|
Authorization |
必要。 指定授權配置、帳戶名稱和簽章。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。 |
Date 或 x-ms-date |
必要。 指定要求的「國際標準時間」(UTC)。 如需詳細資訊，請參閱授權對 Azure 儲存體提出要求。 |
x-ms-version |
所有已授權要求都需要。 指定用於這個要求的作業版本。 如需詳細資訊，請參閱 Azure 儲存體服務的版本。 |
x-ms-client-request-id |
選擇性。 提供用戶端產生的不透明值，其中包含設定記錄時記錄的 1 kibibyte (KiB) 字元限制。 強烈建議您使用此標頭，將用戶端活動與伺服器接收的要求相互關聯。 如需詳細資訊，請參閱監視Azure 檔案儲存體。 |
x-ms-lease-id:<ID> |
選擇性。 版本 2020-02-10 和更新版本。 如果指定標頭，只有在檔案共用的租用目前為使用中，且要求中指定的租用識別碼符合檔案共用的租用識別碼時，才會執行作業。 如果沒有相符專案，作業會失敗，狀態碼為 412 (前置條件失敗) 。 |
要求本文
無。
回應
回應包括 HTTP 狀態碼和一組回應標頭。
狀態碼
成功的作業會傳回狀態碼 200 (OK)。
如需狀態碼的詳細資訊，請參閱 狀態和錯誤碼。
回應標頭
這項作業的回應包括下列標頭。 回應也可能包括其他標準 HTTP 標頭。 所有標準標頭都符合 HTTP/1.1 通訊協定規格。
| 回應標頭 | 描述 |
|---|---|
Last-Modified |
傳回上次修改共用的日期和時間。 日期格式會依照 RFC 1123。 如需詳細資訊，請參閱 在標頭中代表日期/時間值。 修改共用或其屬性的任何作業，都會更新上次修改時間。 檔案上的作業不會影響共用的上次修改時間。 |
x-ms-meta-name:value |
一組名稱/值組，其中包含共用的使用者定義中繼資料。 |
ETag |
包含可用來有條件地執行作業的值。 此值會以引號括住。 |
x-ms-request-id |
可唯一識別發出的要求，並可用來對要求進行疑難排解。 如需詳細資訊，請參閱 針對 API 作業進行疑難排解。 |
x-ms-version |
指出用來執行要求的Azure 檔案儲存體版本。 |
Date 或 x-ms-date |
服務所產生的 UTC 日期/時間值，表示起始回應的時間。 |
x-ms-client-request-id |
可用來針對要求及其對應的回應進行疑難排解。 如果此標頭存在於要求中，且值包含不超過 1，024 個可見的 ASCII 字元，則此標頭的值等於 標頭的值 x-ms-client-request-id 。 x-ms-client-request-id如果要求中沒有標頭，它就不會出現在回應中。 |
回應本文
無。
範例回應
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: somemetadata
Date: Mon, 27 Jan 2014 22:49:18 GMT
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT
x-ms-version: 2014-02-14
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
授權
只有帳戶擁有者可呼叫這項作業。
備註
此作業只會傳回共用中使用者定義的中繼資料。 若要同時傳回系統屬性，請呼叫 Get Share Properties。