全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
视频点播

公共参数

更新时间:2017-11-09 09:12:16

公共参数

公共请求参数

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

名称 类型 必填项 描述
Format String 返回值的类型,支持JSON与XML,默认为XML。
Version String API版本号,为日期形式:YYYY-MM-DD,本版本对应为2017-03-21。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。请参见账号权限概述
Signature String 签名结果串,关于签名的计算方法,请参见API签名机制,代码示例参见Signature
SignatureMethod String 签名方式,目前支持HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ
例如,2017-3-29T12:00:00Z(为北京时间2017年3月29日的20点0分0秒。代码示例参见TimeStamp
SignatureVersion String 签名算法版本,目前版本是1.0。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。代码示例参见SignatureNonce
SecurityToken String STS临时授权的Token,默认为空。概念可参考账号权限STS临时AK,生成方式参考STS临时授权访问

示例:

  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=tkHh5O7431CgWayx
  10. &Timestamp=2017-03-29T09%3A22%3A32Z

公共返回参数

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

XML示例:

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

Json示例:

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