このトピックでは、共通リクエストパラメーターと共通レスポンスパラメーターを含む、共通パラメーターについて説明します。共通パラメーターは、すべての API オペレーションで必須です。
共通リクエストパラメーター
共通リクエストパラメーターは、すべてのElasticsearch API リクエストに含める必要があります。次の表にパラメーターを示します。
パラメーター | 必須 | 例 | 説明 |
Authorization | はい | acs<yourAccessKeyId>:<yourSignature> | リクエストの有効性を検証するために使用される認証情報。AccessKeyId:Signature 形式で情報を指定します。
|
Date | はい | Thu,17 Nov 2018 18:49:58 GMT | リクエストが作成された時刻。時刻は、HTTP 1.1 で指定された GMT 時刻である必要があります。 |
Accept | はい | application/json | クライアントが必要とするレスポンスのタイプ。値を application/json に設定します。 |
x-acs-action | はい | ListInstance | API オペレーションの名前。詳細については、「関数別の操作一覧」をご参照ください。 |
x-acs-version | はい | 2017-06-13 | API オペレーションのバージョン番号。 |
x-acs-signature-nonce | いいえ | 51284580-614a-11eb-8a9b-9dcfec8d**** | リプレイ攻撃を防ぐために使用される一意の乱数。異なるリクエストには異なる番号を使用する必要があります。 |
x-acs-signature-method | はい | HMAC-SHA1 | 署名文字列の暗号化方式。値を HMAC-SHA1 に設定します。 |
ContentMD5 | はい | MACiECZtnLiNkNS1v5****=1 | HTTP リクエストボディの Base64 エンコードされた 128 ビット MD5 ハッシュ値。 |
次のコードは、リクエストの例を示しています。
GET https://elasticsearch.cn-hangzhou.aliyuncs.com/openapi/instances HTTP/1.1
Authorization: acs DemoAccessKey:31nTIpResD/0C8gb+ChUeuv****=
Date: Thu, 17 Nov 2018 18:49:58 GMT
Accept: application/json
x-acs-action: ListInstance
x-acs-version: 2017-06-13
x-acs-signature-nonce: 51284580-614a-11eb-8a9b-9dcfec8d****
x-acs-signature-method: HMAC-SHA1
ContentMD5:MACiECZtnLiNkNS1v5****=1
共通レスポンスパラメーター
パラメーター | タイプ | 説明 |
RequestId | String | リクエストの ID。このパラメーターは、呼び出しが成功したかどうかに関係なく返されます。 |