Common parameters include common request parameters and common response parameters.

Common request parameters

FormatStringNoThe format in which to return the response. Valid values:
  • JSON
  • XML (default value)
VersionStringYesThe version number of the API. The number must be in the YYYY-MM-DD format. Valid values:
  • 2022-04-19: Resource Directory (new version)
  • 2020-03-31: Resource Directory (old version)
  • 2020-03-31: Resource Group
  • 2018-08-28: Tag
  • 2020-01-10: Resource Sharing
  • 2022-12-01: Resource Center
SignatureStringYesThe signature string of the current request. For more information, see Request signatures.
SignatureMethodStringYesThe encryption method of the signature string. Set the value to HMAC-SHA1.
SignatureNonceStringYesA unique, random number used to prevent replay attacks. You must use different numbers for different requests.
SignatureVersionStringYesThe version of the signature encryption algorithm. Set the value to 1.0.
AccessKeyIdStringYesThe AccessKey ID provided to you by Alibaba Cloud. For more information, see Create an AccessKey pair.
TimestampStringYesThe 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, to specify January 10, 2013, 20:00:00 (UTC+8), set the value to 2013-01-10T12:00:00Z.

Sample requests

Common response parameters

API responses use the HTTP response format. Responses can be returned in either the JSON or XML format. You can specify the response format in the request. The default response format is XML. Every response returns a unique RequestId regardless of whether the call is successful.
  • A 2xx HTTP status code indicates a successful call.
  • A 4xx or 5xx HTTP status code indicates a failed call.
Sample responses
  • XML format
    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <Interface Name+Response>
            <!--Return Request Tag-->
            <!--Return Result Data-->
        </Interface Name+Response>                        
  • JSON format
        /*Return Result Data*/