All Products
Search
Document Center

Common parameters

Last Updated: Aug 01, 2019

Common request parameters

The following table describes common request parameters required by all operations.

Parameter Type Required Description
Format String No The format of the response. Valid values: JSON and XML. Default value: XML.
Version String Yes The API version in YYYY-MM-DD format. The current version is 2017-03-21.
AccessKeyId String Yes The ID of the AccessKey that Alibaba Cloud issues for you to access services. For more information, see Overview.
Signature String Yes The signature string. For more information about how to calculate a signature, see Signature. For more information about the sample code, see Signature.
SignatureMethod String Yes The signature method. Currently, only HMAC-SHA1 is supported.
Timestamp String Yes The timestamp of the request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For example, a value of 2017-3-29T12:00:00Z indicates 20:00:00 on March 29, 2017, China Standard Time. For more information about the sample code, see TimeStamp.
SignatureVersion String Yes The signature algorithm version. The current version is 1.0.
SignatureNonce String Yes The unique random number. Different requests must use different random numbers to prevent network replay attacks. For more information about the sample code, see SignatureNonce.
SecurityToken String No The token for STS authorization. This parameter is not set by default. For more information, see STS temporary AccessKey in Overview. For more information about how to generate this token, see STS authorization.

Examples

  1. http://vod.cn-shanghai.aliyuncs.com/
  2. ? Format=json
  3. &Version=2017-03-21
  4. &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
  5. &SignatureMethod=Hmac-SHA1
  6. &SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
  7. &SignatureVersion=1.0
  8. &Action=GetVideoPlayAuth
  9. &AccessKeyId=XXXXXXX
  10. &Timestamp=2017-03-29T09%3A22%3A32Z

Common response parameters

Each time you send a request to call an operation, the system returns a unique identifier RequestId, no matter whether the call is successful or not.

XML format

  1. <? xml version="1.0" encoding="UTF-8"? >
  2. <!—The root node of the response-->
  3. <The operation name+Response> <!—The tag of the response to the request-->
  4. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  5. <!—The response data-->
  6. </Operation name+Response>

JSON format

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* The response data */
  3. }