全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件 ET大脑
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多
视频直播

公共参数

更新时间:2018-04-11 23:43:03

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

公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。

名称 类型 是否必选 描述
Version String API 版本号。
  • 格式:YYYY-MM-DD。
  • 本版本对应为 2016-11-01。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥 ID。
Signature String 签名结果串。
关于签名的计算方法,参见 签名机制
SignatureMethod String 签名方式,目前支持 HMAC-SHA1。
Timestamp String 请求的时间戳。
  • 日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。
  • 格式:YYYY-MM-DDThh:mm:ssZ。
  • 例如:2014-05-26T12:00:00Z(为北京时间 2014 年 5 月 26 日 20 点 0 分 0 秒)。
SignatureVersion String 签名算法版本。
目前版本是 1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。
用户在不同请求间要使用不同的随机数值。
ResourceOwnerAccount String 本次 API 请求访问到的资源拥有者账户,即登录用户名。
此参数的使用方法,参见 RAM资源授权。(只能在 RAM 中可对 live 资源进行授权的 Action 中才能使用此参数,否则访问会被拒绝。)
Format String 返回值的类型,支持 JSON 与 XML。
默认值:XML

示例

  1. https://live.aliyuncs.com/
  2. ?Format=xml
  3. &Version=2016-11-01
  4. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  5. &SignatureMethod=HMAC-SHA1
  6. &SignatureNonce=15215528852396
  7. &SignatureVersion=1.0
  8. &AccessKeyId=key-test
  9. &Timestamp=2012-06-01T12:00:00Z

公共返回参数

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

示例

XML示例

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--结果的根结点-->
  3. <接口名称+Response>
  4. <!--返回请求标签-->
  5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  6. <!--返回结果数据-->
  7. </接口名称+Response>

JSON示例

  1. {
  2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  3. /* 返回结果数据 */
  4. }
本文导读目录