edit-icon download-icon

REST APIs

Last Updated: Mar 12, 2018

Common required parameters

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

ParameterDescription
Accept

The type of the response to return. Valid values:

application/json | application/xml

Content-MD5 The BASE64 encoded 128-bit MD5 digest.
Content-Type The content type of the request defined in RFC 2616.
Content-Length The content length of the request defined in RFC 2616.
Date

The time at which the request is created is referenced to Coordinated Universal Time (UTC).

Example: Wed, 05 Sep. 2012 23:00:00 UTC

Host The request endpoint.
Authorization The request signature in the format of acs <AccessKeyId>:<signature>.
x-acs-signature-nonce A random number for the signature to prevent from network attacks. Different random numbers must be used for different requests.
x-acs-signature-method

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

HMAC-SHA1

x-acs-signature-version

The signature version to use. Valid value:

1.0

x-acs-version

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

Example: 2014-05-26

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.