Azure Cognitive Searchで使用される一般的な HTTP 要求ヘッダーと応答ヘッダー
[アーティクル]
12/21/2022
3 人の共同作成者
フィードバック
この記事の内容
Azure Cognitive Search REST API では、一連の一般的な HTTP 要求/応答ヘッダーがサポートされています。ここでは、参考のためにまとめられています。
要求ヘッダー
種類
説明
Accept
Content type
応答に対して要求されたコンテンツの種類。 既定値は application/json;odata.metadata=minimal です。 その他の許容値は、application/json、application/json;odata.metadata=full、application/json;odata.metadata=none、text/plain です ($countのみ)。
api-key
String
クエリまたは管理者のキーに設定します。API により異なります。
authorization (プレビュー)
String
要求の OAuth 2.0 アクセス トークン。 ロールベースのアクセス を検索サービスに構成する必要があります。 この要求ヘッダーは、Azure Active Directory 認証と Azure ロールの割り当てを使用するクライアント アプリ用です。 クライアント コードでトークンを指定する必要があります。 この要求ヘッダーは、検索サービスが データ プレーン認証 用に構成されている限り、サポートされている REST API バージョンと共に使用できます。
Content-Type
Content-Type
要求の本文 (PUT または POST) のコンテンツの種類。 既定値は application/json
です。
client-request-id
GUID
省略可能な呼び出し元指定の要求 ID(中かっこなどの装飾のない GUID の形式) (例: client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。 指定した要求を識別する、呼び出し元で定義された値。 この値が指定されている場合、値は要求をマップする方法として応答情報に含まれます。
OData-MaxVersion
"4.0"
クライアントでサポートされている OData プロトコルの最大バージョンを指定します。 既定値は「4.0」です。
Prefer
「return=representation」または「return=minimal」
PUT や POST /indexes 要求から応答ペイロードを制御するために使用します。 POST や PUT を使用して新しいインデックスを作成するときの既定値は「return=representation」で、PUT を使用して既存のインデックスを更新する場合は「return=minimal」です。
return-client-request-id に
True または False
client-request-id が指定されている場合にこれを指定すると、client-request-id ヘッダーを応答に含めるようにサーバーに指示します。 既定値は False です。
If-Match
ETag または *
現在のバージョンが指定された ETag と一致する場合にのみ、リソースを変更するために使用されます。 このヘッダーを、リソース (インデクサー、インデックス、データ ソースなど、ドキュメントではなく) の POST、PUT、または DELETE メソッドと共に使用して、 オプティミスティック コンカレンシー制御 を有効にします。
If-None-Match
ETag または *
現在のバージョンが指定された ETag と一致しない場合にのみ、リソースを変更するために使用されます。 このヘッダーを、リソース (インデクサー、インデックス、データ ソースなど、ドキュメントではなく) の POST、PUT、または DELETE メソッドと共に使用して、 オプティミスティック コンカレンシー制御 を有効にします。
応答ヘッダー
種類
説明
client-request-id
GUID
元の要求の呼び出し元によって指定された識別子 (存在する場合)。
Content-Type
Content-Type
応答本文のコンテンツの種類。
場所
URL
POST および PUT /indexes 要求用に新しく作成されたインデックス定義の URL。
OData-Version
"4.0"
応答の OData プロトコルのバージョン。
request-id
GUID
現在の操作の一意の識別子。 指定した場合は、client-request-id と同じです。それ以外の場合、値はサーバーで生成されます。
elapsed-time
Number
サービスが要求の処理に費やした時間 (ミリ秒単位)。 これには、要求の処理に費やされた時間のみが含まれます。ネットワーク転送時間は含まれません。
ETag
String
リソースの現在のバージョンを表す不透明な文字列 (インデクサー、インデックス、データ ソースに対して返されますが、ドキュメントには返されません)。 オプティミスティック コンカレンシー制御 には、この文字列を If-Match または If-None-Match ヘッダーで使用します。
関連項目
Azure Cognitive Search REST API