This topic describes common parameters, including common request parameters and common response parameters. Common parameters are required by all API operations.
Common request parameters
Common request parameters must be included in all Elasticsearch API requests. The following table lists the parameters.
Parameter | Required | Example | Description |
---|---|---|---|
Authorization | Yes | acs<yourAccessKeyId>:<yourSignature> | The authentication information that is used to verify the validity of the request.
Specify the information in the AccessKeyId:Signature format.
|
Date | Yes | Thu,17 Nov 2018 18:49:58 GMT | The time when the request was created. The time must be the GMT time specified in HTTP 1.1. |
Accept | Yes | application/json | The type of the response that is required by the client. Set the value to application/json. |
x-acs-action | Yes | ListInstance | The name of the API operation. For more information, see List of operations by function. |
x-acs-version | Yes | 2017-06-13 | The version number of the API operation. |
x-acs-signature-nonce | No | 51284580-614a-11eb-8a9b-9dcfec8d**** | A unique, random number used to prevent replay attacks. You must use different numbers for different requests. |
x-acs-signature-method | Yes | HMAC-SHA1 | The encryption method of the signature string. Set the value to HMAC-SHA1. |
ContentMD5 | Yes | MACiECZtnLiNkNS1v5****=1 | The Base64-encoded 128-bit MD5 hash value of the HTTP request body. |
The following code provides a sample request:
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
Common response parameters
Parameter | Type | Description |
---|---|---|
RequestId | String | The ID of the request. This parameter is returned regardless of whether the call is successful. |