All API requests must include public parameters. To avoid redundant descriptions, these parameters may not be repeatedly documented in the product's API documentation. Ensure that you include these parameters when making API requests; otherwise, the request will fail the validity check.
tip
Action and Version must be placed in the query.
Name | Type | Required | Parameter format | Description | Example value |
|---|---|---|---|---|---|
Action | String | Yes | [a-zA-Z]+ | API name. For actual values, refer to the API documentation of the product you are using. | CreateUser |
Version | String | Yes | YYYY-MM-DD | API version. For actual values, refer to the API documentation of the product you are using. | 2018-01-01 |
X-Expires | Int | No | Integer | Signature validity period in seconds. The default value is 900 if not specified. | 900 |
tip
Signature parameters can be included in the query or in the header.
Name | Type | Required | Description | Example value |
|---|---|---|---|---|
X-Date | String | Yes | Use UTC time accurate to the second, in the ISO 8601 format: |
|
Authorization | String | Yes |
|
|
X-Security-Token | String | No | Refers to the SessionToken in the temporary security credentials issued by Security Token Service (STS). This parameter is not required when using long-term keys. |
|
Meaning of the information in Authorization:
Name | Type | Remarks | Example value |
|---|---|---|---|
AccessKeyId | String | Access Key ID for the request. |
|
ShortDate | String | Short date for the request, using UTC time accurate to the day. Please use the format: |
|
Region | String | Region for the request, for example: |
|
Service | String | Service name for the request. Refer to the API documentation of the product you are using for the Service value. For example, the service name for access control is |
|
SignedHeaders | String | Headers involved in the signature. Multiple headers are separated by semicolons. This specifies which headers are included in the signature calculation, so that extra headers added by proxies are ignored. If host or x-date is present in the header, they must be included in the signature. |
|
Signature | String | The calculated signature. For details, refer to Signature method |
|
Name | Type | Required | Description | Example value |
|---|---|---|---|---|
X-Date | String | Yes | Use UTC time accurate to the second. |
|
X-Algorithm | String | Yes | Fixed value: |
|
X-Credential | String | Yes | It consists of |
|
X-SignedHeaders | String | Required | The headers involved in the signature. Multiple headers are separated by semicolons. This specifies which headers are included in the signature calculation, so that any additional headers added by a proxy are ignored. If 'host' or 'x-date' are present in the headers, they must be included. |
|
X-Signature | String | Required | The computed signature. For a detailed explanation, please refer to Signature Method. |
|