edit-icon download-icon

Common parameters

Last Updated: Apr 16, 2018

The following common request parameters must be added each time calling an API, and a request ID will be returned no matter the request is successful or not.

Common request parameters

Parameter Data Type Required Description
Version String Yes

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

2014-05-15

AccessKeyId String Yes The AccessKey ID of the user who calls the API.
Signature String Yes

The request signature.

For more information, see Sign RPC APIs

SignatureMethod String Yes

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

HMAC-SHA1

Timestamp String Yes

The time at which the quest 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:

1.0

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.

Format String No

The format of the response. Valid values:

JSON | XML (default value)

  1. http://slb.aliyuncs.com/?Action=DescribeLoadBalancers
  2. &Timestamp=2014-05-19T10%3A33%3A56Z
  3. &Format=xml
  4. &AccessKeyId=testid
  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 response parameters

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

  • XML format

    1. <?xml version="1.0" encoding="UTF-8"?>
    2. <!--The root node of the result-->
    3. <Action+Response>
    4. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    5. <!--The returned result -->
    6. </Action+Response>
  • JSON format

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