Azure Cosmos DB の一般的な REST 要求ヘッダー
次の要求ヘッダーは、SQL API で実行できるすべてのタスクに共通です。
| ヘッダー | 必須 | Type | 説明 |
|---|---|---|---|
| 承認 | 必須 | String | 要求の承認トークン。 有効な承認トークンの生成の詳細については、「Cosmos DB リソースのAccess Control」を参照してください。 |
| 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 | 指定した日付以降に変更されたリソースの etag を RFC 1123 形式で返します。 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 | ドキュメントと添付ファイルに対する読み取りオプションの整合性レベルのオーバーライド。 有効な値は、Strong、Bounded、Session、または Eventual (最も強いものから弱い順) です。 オーバーライドは、アカウントの構成済みの整合性レベルと同じか弱い必要があります。 |
| x-ms-continuation | 省略可能 | String | 読み取る結果が多い場合は、クエリと読み取りフィード操作に対して返される文字列トークン。 クライアントは、x-ms-continuation 要求ヘッダーをこの値に設定して要求を再送信することで、結果の次のページを取得できます。 |
| x-ms-date | 必須 | Date | 協定世界時で表される RFC 1123 日付形式ごとの要求の日付 。たとえば、Fri、2015 年 4 月 8 日 03:52:31 GMT などです。 |
| x-ms-max-item-count | 省略可能 | Number | ページごとに返されるアイテムの最大数を示す整数。 x-ms-max-item-count -1 を指定して、サービスが最適な項目数を判断できるようにします。 これは、x-ms-max-item-count の推奨される構成値です |
| x-ms-documentdb-partitionkey | 省略可能 | Array | 要求されたドキュメントまたは添付ファイル操作のパーティション キー値。 コレクション定義にパーティション キー定義が含まれている場合に、ドキュメントと添付ファイルに対する操作に必要です。 この値は、パーティション キーの条件に一致するドキュメントにクエリのスコープを設定するために使用されます。 設計上、これは単一のパーティション クエリです。 API バージョン 2015-12-16 以降でサポートされています。 現在、SQL API は 1 つのパーティション キーをサポートしているため、これは 1 つの値のみを含む配列です。 |
| 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 | 省略可能 | Number | 変更フィード要求で使用されます。 読み取りデータのパーティション キー範囲の ID です。 |
| x-ms-cosmos-allow-tentative-writes | 省略可能 | Boolean | 複数の書き込み場所で構成された Azure Cosmos アカウントに対してこのヘッダーが true に設定されている場合、Azure Cosmos DB はすべての場所への書き込みを許可します。 このヘッダーの値を false に設定した書き込み要求 (またはヘッダーが存在しない場合) は、403 応答状態コードで失敗し、エラー メッセージ "Writes is not allowed in the region" (リージョンでの書き込みは許可されていません) が表示されます。 |
参照