This topic describes common parameters, including common request parameters and common response parameters. Common parameters are required by all API operations.
Common request parameters
Common request parameters must be included in all ApsaraVideo Live API requests.
Parameter | Type | Required | Description |
---|---|---|---|
Version | String | Yes | The version number of the API.
|
AccessKeyId | String | Yes | The AccessKey ID provided to you by Alibaba Cloud. |
Signature | String | Yes | The signature string of the current request. For more information about how signatures are calculated, see Signature method. |
SignatureMethod | String | Yes | The encryption method of the signature string. Set the value to HMAC-SHA1. |
Timestamp | String | Yes | The timestamp of the request. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. |
SignatureVersion | String | Yes | The version of the signature encryption algorithm. Set the value to 1.0. |
SignatureNonce | String | Yes | A unique, random number used to prevent replay attacks. You must use different random numbers for different requests. |
ResourceOwnerAccount | String | No | The Alibaba Cloud account that owns the resource to be accessed by the API request. For more information about how to use this parameter, see Authentication rules on API requests. If you call API operations as a RAM user, make sure that you use this parameter in operations where ApsaraVideo Live resources can be authorized by the RAM user. Otherwise, requests are rejected. |
Format | String | No | The format in which to return the response. Valid values: json and xml. Default value: xml. |
Sample request
https://live.aliyuncs.com/?Format=xml
&Version=2016-11-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
...
Common response parameters
Every response returns a unique request ID regardless of whether the call is successful.
Sample success responses
- XML format
<? xml version="1.0" encoding="UTF-8"? > <! --Root node of the response --> <Operation name+Response> <! --Return request tag--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <! --Return result data--> </Operation name+Response>
- JSON format
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* Return result data */ }