All API requests must include public parameters. To avoid redundant descriptions, the product's API documentation may not repeat these parameters. Please ensure that you include these parameters when requesting APIs; 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 usage, refer to the API documentation of your product for the value. | CreateUser |
Version | String | Yes | YYYY-MM-DD | API version. For actual usage, refer to the API documentation of your product for the value. | 2018-01-01 |
X-Expires | Int | No | Integer | Signature validity period, unit: seconds. If not specified, the default value is 900. | 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 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 a long-term key. |
|
Meaning of 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, for example: |
|
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 and x-date exist in the header, they must be included in the signature. |
|
Signature | String | 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 | Composed of |
|
X-SignedHeaders | String | Yes | Headers involved in the signature. Multiple headers are separated by semicolons to specify which headers are included in the signature calculation, thereby ignoring additional headers added to the request by a proxy. If the host or x-date headers are present, they must be included. |
|
X-Signature | String | Yes | The computed signature. For detailed instructions, refer to Signature method. |
|