Common Parameters
Last update：2021-08-31 10:45:40
Common parameters are parameters used to identify users and interface authentication purposes. If not necessary, these parameters will not be described in the separate interface document of each interface, but each request needs to carry these parameters in order to initiate the request normally. Common request parameters must be included in all API requests. It is recommended to use interface authentication v3.
Interface Authentication V3
This authentication method needs to set the following three attributes in the request header. When all three attributes are set, this authentication method will be used for authentication.
Priority: interface authentication v3>interface authentication v2>interface authentication v1.
With interface authentication v3, the common parameters of the other two authentication methods do not need to be set.
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-WS-AccessKey | String | Yes | Access Key ID (AccessKey ID). The corresponding AccessKey Secret is obtained through the AccessKey management interface of the console. Both the main account and the sub-account have different AccessKey ID. The server will verify its authorization range, and the account can only operate on the data it has permission to operate. |
| X-WS-Timestamp | String | Yes | The timestamp of the request. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.For example, 2017-3-29T12:00:00Z indicates 20:00:00, March 29, 2017 (UTC+8). |
| Authorization | int | Yes | Authorization information |
| content-Type | string | Yes | The type of data actually sent to the server. |
| host | string | Yes | Request domain name |
Specify the return parameter format
It can return the result in json or xml format.
The json format data is returned by default. If you need to return the xml format, please include the format parameter in the request parameters. For GET requests, put the parameters in the url parameter string;
for POST requests, put them and other non-common parameters in the body.
| Parameter | Type | Required | Description |
|---|---|---|---|
| format | String | No | Return result format, optional value is json or xml, default is json. |