文档

公共参数

更新时间:

公共请求参数

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

名称

类型

是否必须

描述

Format

String

返回值的类型,支持JSON与XML,默认为XML。

RegionId

String

当前请设置为cn-hangzhou

Version

String

API版本号,为日期形式YYYY-MM-DD,请参见概览

AccessKeyId

String

阿里云颁发给用户的访问服务所用的密钥ID。

Signature

String

签名结果串,关于签名的计算方法,请参见 签名机制

SignatureMethod

String

签名方式,目前支持HMAC-SHA1。

Timestamp

String

请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ,例如2016-02-25T12:00:00Z(为UTC时间2016年2月25日12点0分0秒)。

SignatureVersion

String

签名算法版本,目前版本是1.0。

SignatureNonce

String

唯一随机数,用于防止网络重放攻击,用户在不同请求间要使用不同的随机数值。

示例

https://cloudpush.aliyuncs.com/
?Format=XML
&RegionId=cn-hangzhou
&Version=2016-08-01
&AccessKeyId=testid
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&Timestamp=2016-02-25T12: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"
    /* 返回结果数据 */
}
  • 本页导读 (0)
文档反馈