edit-icon download-icon


Last Updated: Mar 12, 2018

Common request parameters

In addition to API specific parameters, the following common request parameters are required each time an RPC API is called.

Parameters Data Type Required Description
Version String Yes

The version of the API in the format of YYYY-MM-DD.

Example: 2014-05-26

Note: The API version is different for different products. Go to the API documentation of the specific product to get the applicable API version.

AccessKeyId String Yes

The AccessKey ID of the user that calls the API.

Note: For security purposes, we recommend that you use the AccessKey ID of a RAM user.

Signature String Yes The request signature. For more information, see Sign RPC APIs and Sign REST APIs.
SignatureMethod String Yes

The algorithm used to create the request signature. Valid value:


Timestamp String Yes

The time at which the request is signed in the format of YYYY-MM-DDThh:mm:ssZ.

Example: 2014-05-26T12:00:00Z

SignatureVersion String Yes

The signature version to use. Valid value:


SignatureNonce String Yes A random number for the signature to prevent from network attacks. Different random numbers must be used for different requests.
ResourceOwnerAccount String No

The account owner of the resource that this request calls.

This parameter is required only when a RAM user calls an API to access the resources of the primary account.

Format String No

The format of the response. Valid values:

XML (default value) | JSON

Common response parameters

A RequestId is returned no matter whether the request is successful or not.

XML format

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--Result root node-->
  3. <ActionResponse>
  4. <!--Return request tag-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!--Return result data-->
  7. </ActionResponse>

JSON format

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* Other response parameters*/
  4. }
Thank you! We've received your feedback.