Common parameters

Last Updated: May 22, 2017

Common request parameter

A common request parameter refers to the request parameter required by each interface.

Name Type Mandatory or not Description
Format String No Indicates the formatting method for a return message; value: JSON or XML; default: XML.
Version String Yes Indicates the version number in the date form: YYYY-MM-DD. This version comes with 2014-05-15.
AccessKeyId String Yes Indicates the Alicloud-issued key ID for a user to access a service. Value: view and apply for it on the page “User center–My service–Security authentication” on the Alicloud official website.
Signature String Yes Indicates the string of a signature result. For more about signature computing method,see Signature Mechanism.
SignatureMethod String Yes Indicates the method for signature. HMAC-SHA1 is currently supported. Value: HMAC-SHA1
Timestamp String Yes Indicates the timestamp of a request. The date is subject to the UTC time in the format specified in the ISO8601 standard. Format: YYYY-MM-DDThh:mm:ssZ; For example: 2013-01-10T12:00:00Z (Beijing time, 20:00:00, January 10, 2013)
SignatureVersion String Yes Indicates the version of a signature algorithm. The current version is 1.0. Value: 1.0.
SignatureNonce String Yes Indicates a unique random number. It is used to avoid an online replay attack. A user must use a unique random number for a different request.
ResourceOwnerAccount String No Indicates the account of the resource owner accessed by the API request, i.e. the user name for login. (this parameter can be used only at “the interface which can authorize an Server Load Balancer resource in the RAM”. Otherwise, the access will be rejected.)

Example

  1. http://slb.aliyuncs.com/?TimeStamp=2014-05-19T10%3A33%3A56Z
  2. &Format=xml
  3. &AccessKeyId=testid
  4. &Action=DescribeLoadBalancerAttribute
  5. &SignatureMethod=Hmac-SHA1
  6. &LoadBalancerId=139a00604ad-cn-east-hangzhou-01
  7. &SignatureNonce=NwDAxvLU6tFE0DVb
  8. &Version=2014-05-15
  9. &SignatureVersion=1.0
  10. &Signature=FZnIrdNSLax4lnWf6NkKDc7mp54%3D

Common return parameter

Upon a request sent by a user for calling an interface regardless of success, the system returns a unique ID (RequestID) to the user.

Example

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!—Root node of the result-->
  3. <Interface name +Response>
  4. <!—Label of the return request-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. </Interface name+Response>
Thank you! We've received your feedback.