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.

Parameter Type Required Description
Format String No The format in which to return the response. Valid values:

JSON and XML. Default value: JSON.

Version String Yes The version number of the API. Format: YYYY-MM-DD. Valid values:


AccessKeyId String Yes The AccessKey ID that is used to call VPC API operations.
Signature String Yes The signature string of the current request.
SignatureMethod String Yes The encryption method of the signature string. Set the value to


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.

For example, you can use 2022-01-10T01:00:00Z to specify January 10, 2022, 09:00:00 (UTC+8).

SignatureVersion String Yes The version of the signature encryption algorithm. Set the value to


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

You must use a unique random number for each request.

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>
            <!--Returned request tag-->
            <!--Returned data-->
        </Operation name + Response>
  • JSON format
        /*Returned data*/