Common parameters
This topic describes the request and response parameters that are required for every API call.
Common request parameters
Name | Type | Required | Description |
Format | String | No | The format of the response message. Valid values: JSON (default) and XML. |
Version | String | Yes | The API version. The date format is YYYY-MM-DD. Example: 2014-05-15 |
AccessKeyId | String | Yes | The ID of the AccessKey pair that you use to access the service. |
Signature | String | Yes | The signature string. |
SignatureMethod | String | Yes | The signature method. Set the value to HMAC-SHA1. |
Timestamp | String | Yes | The timestamp of the request. The timestamp must be in UTC and follow the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 20:00:00 on January 10, 2013 (UTC+8) is represented as 2013-01-10T12:00:00Z. |
SignatureVersion | String | Yes | The version of the signature algorithm. Set the value to: 1.0 |
SignatureNonce | String | Yes | A unique random number used to prevent replay attacks. Use a different random number for each request. |
ResourceOwnerAccount | String | No | The account of the resource owner for this API request. This is the logon username. |
Common response parameters
API responses are returned in a unified JSON or XML format.
RequestId: A unique identifier that is returned for each API call, regardless of success.
Success: Indicates whether the call was successful. Valid values: true or false.
Code: The error code returned for the call. Examples: 200, 4XX, or 5XX.
Message: The error message.
The following are examples of responses:
JSON format
{ "RequestId":"59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A" "Success":"true", "Code":200, "Message":"success" /*Response data*/ }
XML format
<CreateTaskResponse>
<RequestId>59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A</RequestId>
<Success>true</Success>
<Code>200</Code>
<Message>success</Message>
</CreateTaskResponse>