公共参数指的是所有接口调用都需要用到的参数，包含公共请求参数和公共返回参数两种。

公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。
名称类型是否必选描述
VersionString是API 版本号。
  • 格式：YYYY-MM-DD。
  • 本版本对应为2016-11-01。
AccessKeyIdString是阿里云颁发给用户的访问服务所用的密钥ID。
说明

调用服务端接口需要使用AccessKey完成身份验证，请提前获取AccessKey。获取方法请参见创建AccessKey。

SignatureString是签名结果串。关于签名的计算方法，请参见签名机制。
SignatureMethodString是签名方式。目前支持HMAC-SHA1。
TimestampString是请求的时间戳。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
SignatureVersionString是签名算法版本。目前是1.0版本。
SignatureNonceString是唯一随机数。用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。
ResourceOwnerAccountString否本次API请求访问到的资源拥有者账户，即登录用户名。 此参数的使用方法，请参见RAM资源授权。（只能在RAM中可对直播资源进行授权的Action中才能使用此参数，否则访问会被拒绝。）
FormatString否返回值的类型。支持json和xml。默认为xml。

示例

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
…

公共返回参数

用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码RequestId给用户。

示例

  • XML示例
    <?xml version="1.0" encoding="UTF-8"?>
<!--结果的根结点-->
<接口名称+Response>
<!--返回请求标签-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--返回结果数据-->
</接口名称+Response>
  • JSON示例
    {
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* 返回结果数据 */
}