全部产品
云市场

公共参数

更新时间:2019-01-16 16:22:46

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

公共请求参数

名称 类型 是否必须 描述
Format String 返回值的类型,支持JSON与XML,默认为XML。
Version String API版本号,日期形式:YYYY-MM-DD,本版本对应为2015-01-09。
Signature String 签名结果串,关于签名的计算方法,请参见签名机制。
SignatureMethod String 签名方式,目前支持HMAC-SHA1。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。在不同请求间要使用不同的随机数值。
SignatureVersion String 签名算法版本,目前版本是1.0。
AccessKeyId String 阿里云颁发给您的访问服务所用的密钥ID。
Timestamp String 请求的时间戳。

日期格式按照ISO8601标准表示,需使用UTC时间。

格式为YYYY-MM-DDThh:mm:ssZ 例如,2015-01-09T12:00:00Z(为UTC时间2015年1月9日12点0分0秒)

公共返回参数

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

请求示例

  1. https://openanalytics.cn-hangzhou.aliyuncs.com/?Format=xml
  2. &Version=2018-06-19
  3. &Signature=HaiKP8dBpEqhzeutgqOrHDpvxWw%3D
  4. &SignatureMethod=HMAC-SHA1
  5. &SignatureNonce=6d4b46a912d4b6d36809a04d216972a0
  6. &SignatureVersion=1.0
  7. &AccessKeyId=key-test
  8. &Timestamp=2018-11-10T06%3A31%3A08Z

返回示例

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. }