共用方式為


常見 Azure Cosmos DB REST 要求標頭

SQL API 可能執行的所有工作都有下列要求標頭:

標頭 必要 類型 描述
授權 必要 String 要求的授權權杖。 如需產生有效授權權杖的詳細資訊,請參閱Cosmos DB 資源上的存取控制
Content-Type PUT、PATCH 和 POST) 的必要 ( String 針對查詢作業上的 POST,它必須是 application/query+json

針對 PATCH 作業,它必須是application/json_patch+json

對於附件,必須設定為附件的 Mime 類型。 如需 Mime 類型的詳細資訊,請參閱 建立附件

對於所有其他工作,必須是 application/json。
If-Match 選擇性 (僅適用于 PUT 和 DELETE) String 用來設定開放式平行存取的條件式作業。 此值應該是資源的 etag 值。
If-None-Match 選擇性 (僅適用于 GET) String 只有在資源變更時,才會讓作業有條件地執行。 此值應該是資源的 etag。
If-Modified-Since 選擇性 (僅適用于 GET) Date 傳回 RFC 1123 格式的指定日期之後修改的資源 etag。 指定 If-None-Match 時忽略
User-Agent 選用 String 此字串指定執行要求的用戶端使用者代理程式。 建議的格式為 {使用者代理程式名稱}/{版本}。 例如,官方 SQL API .NET SDK 會將 User-Agent 字串設定為 Microsoft.Document.Client/1.0.0.0。 自訂使用者代理程式可能類似 ContosoMarketingApp/1.0.0。
x-ms-activity-id 選用 String 用戶端為作業提供識別碼,此識別碼會在伺服器回應中回應。 建議的值是唯一識別碼。
x-ms-consistency-level 選用 String 針對檔和附件讀取選項的一致性層級覆寫。 有效值為:強式、限定、會話或最終 (,以最強到最弱) 。 覆寫必須與帳戶設定的一致性層級相同或較弱。
x-ms-continuation 選用 String 如果有更多要讀取的結果,則會針對查詢和讀取摘要作業傳回的字串權杖。 用戶端可以重新提交要求,並將 x-ms-continuation 要求標頭設定為此值,以擷取下一頁的結果。
x-ms-date 必要 Date 每個 RFC 1123 日期格式的要求日期,以國際標準時程表示,例如 2015 年 4 月 8 日 03:52:31 GMT。
x-ms-max-item-count 選擇性 數字 整數,表示每個頁面要傳回的專案數目上限。 您可以指定 -1 的 x-ms-max-item-count,讓服務判斷最佳的專案計數。 這是 x-ms-max-item-count 的建議組態值
x-ms-documentdb-partitionkey 選擇性 Array 所要求檔或附件作業的分割區索引鍵值。 當集合定義包含資料分割索引鍵定義時,針對檔和附件的作業需要。 此值用來將查詢範圍限定為符合分割區索引鍵準則的檔。 根據設計,它是單一資料分割查詢。 API 版本 2015-12-16 和更新版本支援。 目前,SQL API 支援單一資料分割索引鍵,因此這是只包含一個值的陣列。
x-ms-documentdb-query-enablecrosspartition 選擇性 Boolean 當此標頭設定為 true 且您的查詢沒有分割區索引鍵時,Azure Cosmos DB 會跨分割區將查詢扇出。 分散方式是將個別查詢發給所有分割區。 若要讀取查詢結果,用戶端應用程式應該從 FeedResponse 取用結果,並查看 ContinuationToken 屬性。 若要讀取所有結果,請逐一查看資料,直到 ContinuationToken 為 null。
x-ms-session-token 只有會話一致性的必要 () String 與會話層級一致性搭配使用的字串權杖。 如需相關資訊,請參閱
在 Cosmos DB 中使用一致性層級
x-ms-version 必要 String Cosmos DB REST 服務的版本。
如需支援的 API 版本清單,請參閱 Azure Cosmos DB REST API 參考
A-IM 選用 String 表示 變更摘要 要求。 必須設定為 「累加摘要」,否則省略。
x-ms-documentdb-partitionkeyrangeid 選擇性 數字 用於 變更摘要 要求。 用來讀取資料的資料分割索引鍵範圍識別碼。
x-ms-cosmos-allow-tentative-writes 選擇性 Boolean 當此標頭設定為 true 時,針對使用多個寫入位置設定的 Azure Cosmos 帳戶,Azure Cosmos DB 會允許寫入所有位置。 寫入此標頭的值設定為 false (,或者如果標頭不存在,) 將會失敗並出現 403 回應狀態碼,並出現錯誤訊息「區域不允許寫入」。

另請參閱