Format

  • Name: Format
  • Type: String
  • Required: No
  • Description: Return value type. JSON and XML are supported, and the default value is XML.

Version

  • Name: Version
  • Type: String
  • Required: Yes
  • Description: API version number. It is in the YYYY-MM-DD format and the current version number is 2015-05-01.

AccessKeyId

  • Name: AccessKeyId
  • Type: String
  • Required: Yes
  • Description: AccessKey (AK) ID

Signature

  • Name: Signature
  • Type: String
  • Required: Yes
  • Description: Message signature

SignatureMethod

  • Name: SignatureMethod
  • Type: String
  • Required: Yes
  • Description: Signature method. Currently, only HMAC-SHA1 is supported.

SignatureVersion

  • Name: SignatureVersion
  • Type: String
  • Required: Yes
  • Description: Signature algorithm version. The current version is 1.0.

SignatureNonce

  • Name: SignatureNonce
  • Type: String
  • Required: Yes
  • Description: A unique random number preventing network replay attacks. You must use different random numbers for different requests.

Timestamp

  • Name: Timestamp
  • Type: String
  • Required: Yes
  • Description: Timestamp for a request. The date format follows the ISO8601 standard and uses UTC time. The timestamp format is:
    YYYY-MM-DDThh:mm:ssZ
    For example: 2013-01-10T12:00:00Z (equivalent to 2013-01-10 20:00:00 Beijing time)

Request example

https://ram.aliyuncs.com/
          Format=xml
          &Version=2015-05-01
          &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
          &SignatureMethod=HMAC-SHA1
          &SignatureNonce=15215528852396
          &SignatureVersion=1.0
          &AccessKeyId=key-test
          &Timestamp=2012-06-01T12:00:00Z
          …

Public return parameters

Each time you send a request to call an interface, the system will return a unique identification code (RequestId) to you no matter the request is successful or not. This parameter is used to identify requests.

Example
  • XML example
    <? xml version="1.0" encoding="utf-8"? >
              <!—Result root node-->
              <Interface name+response>
              <!—Return request tag-->
              <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
              <!—Return result data-->
              </Interface name+response>
  • JSON example
    
              "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
              /* Return result data */