This topic describes the request parameters and response parameters that each operation uses.

Common request parameters

Table 1. Common request parameters
Parameter Type Required Description
Format String No The format in which to return the response. Valid values:

JSON and XML. Default value: XML.

Version String Yes The version number of the API, in the format of YYYY-MM-DD. Set the value to:

2020-03-26
AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud.
Signature String Yes The signature string of the current request.
SignatureMethod String Yes The encryption method of the signature string.

Set the value to HMAC-SHA1.

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.

Example: 2013-01-10T12:00:00Z, which specifies 20:00:00 on January 10, 2013 (UTC+8).
SignatureVersion String Yes The version of the signature encryption algorithm.

Set the value to 1.0
SignatureNonce String Yes A unique, random number used to prevent replay attacks.

You must use different numbers for different requests.
Sample requests 
https://workorder.ap-southeast-1.aliyuncs.com/?Action=CreateTicket
&Format=xml
&Version=2020-03-26
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z
…

Common response parameters

All Alibaba Cloud API responses are returned in either the JSON or XML format. You can specify the response format when sending requests. The default response format is XML. Each response includes a unique RequestId regardless of whether the call is successful. Each response also contains a HTTP status code.
  • A 2xx status code indicates a successful call.
  • A 4xx or 5xx status code indicates a failed call.
Sample responses:
  • XML format 
    <?xml xml version="1.0" encoding="utf-8"? > 
    <!--Result Root Node-->
    <Operation Name+Response>
        <!-Return Request Tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!-Return Result Data-->
    </Operation Name+Response>
  • JSON format 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /*Return Result Data*/
}