Common parameters include common request parameters and common response parameters.

Common request parameters

Common request parameters must be included in all virtual private cloud (VPC) API requests. The following table describes the common request parameters.

ParameterTypeRequiredDescription
FormatStringNoThe format in which to return the response. Valid values:

JSON and XML. Default value: JSON.

VersionStringYesThe version number of the API. Format: YYYY-MM-DD. Valid values:

2016-04-28

AccessKeyIdStringYesThe AccessKey ID that is used to call VPC API operations.
SignatureStringYesThe signature string of the current request.
SignatureMethodStringYesThe encryption method of the signature string. Set the value to

HMAC-SHA1

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 20:00:00 (UTC+8) on January 10, 2013, set the parameter to 2013-01-10T12:00:00Z.

SignatureVersionStringYesThe version of the signature encryption algorithm. Set the value to

1.0

SignatureNonceStringYesA unique random number that is used to prevent replay attacks.

You must use different numbers for different requests.

Common response parameters

API responses use the HTTP response format where a 2xx status code indicates a successful call and a 4xx or 5xx status code indicates a failed call. Responses can be returned in the JSON or XML format. The default response format is JSON. You can specify the response format when you call an operation.

Every response returns a unique RequestId regardless of whether the call is successful.
  • XML format 
    <?xml version="1.0" encoding="utf-8"?> 
    <!--Result Root Node-->
    <Operation name + Response>
        <!--Return request tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--Returned data-->
    </Interface Name+Response>
  • JSON format 
    {
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    }