This topic describes the common request parameters and response parameters that are used by all Hybrid Backup Recovery (HBR) API operations.

Common request parameters

Parameter Type Required Description
Action String Yes The name of the API operation. For more information about the valid values, see List of operations by function.
Format String No The format of the response. Valid values:
  • JSON. Default value: JSON.
  • XML
Version String Yes The API version in the YYYY-MM-DD format. Valid value:


AccessKeyId String Yes The AccessKey ID that is used to access the required service. For more information, see Obtain an AccessKey pair.
Signature String Yes The signature string of the request. For more information, see Request signatures.
SignatureMethod String Yes The encryption method of the signature string. Valid value:


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. Valid value:


SignatureNonce String Yes A unique random number that is used to prevent replay attacks.

You must use different random numbers for different requests.

Sample requests

Common response parameters

API responses use the HTTP response format. Responses can be returned in the JSON or XML format. The default response format is XML. You can specify the response format in the request. Each call returns a unique RequestId in the response regardless of whether the call is successful.
Parameter Type Required Description
RequestId String Yes The ID of the request. This parameter is returned regardless of whether the call is successful.

Sample responses

Sample success responses
  • XML format
    <?xml version="1.0" encoding="utf-8"?> 
        <!--Result Root Node-->
        <API Operation Name+Response>
            <!--Return Request Tag-->
            <!--Return Result Data-->
        </API Operation Name+Response>
  • JSON format
        /*Return Result Data*/