Common parameters - API Reference| Alibaba Cloud Documentation Center

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

http://vod.cn-shanghai.aliyuncs.com/
    ? Format=json 
    &Version=2017-03-21
    &Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D  
    &SignatureMethod=Hmac-SHA1 
    &SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f 
    &SignatureVersion=1.0 
    &Action=GetVideoPlayAuth 
    &AccessKeyId=XXXXXXX  
    &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

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

JSON format

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