公共参数

公共请求参数

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

名称

类型

是否必须

描述

Format

String

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

Version

String

API 版本号,为日期形式:YYYY-MM-DD。如果参数 RegionID 是 cn-hangzhou,则版本对应为2015-11-23;如参数 RegionID 是cn-hangzhou 以外其他 Region,比如 ap-southeast-1,则版本对应为2017-06-22

AccessKeyId

String

阿里云颁发给用户的访问服务所用的密钥 ID,可以通过控制台AccessKey管理来创建。

Signature

String

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

SignatureMethod

String

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

Timestamp

String

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

SignatureVersion

String

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

SignatureNonce

String

唯一随机数,用于防止网络重放攻击。不同的请求要使用不同的随机数值。您可以使用UUID(随机串),也可以自定义。

RegionId

String

机房信息 ,目前支持 cn-hangzhou、ap-southeast-1、ap-southeast-2。

示例

https://dm.aliyuncs.com/
?Format=xml
&Version=2015-11-23
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e1b44502-6d13-4433-9493-69eeb068e955
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2015-11-23T12:00:00Z

公共返回参数

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

参数

类型

描述

RequestId

String

阿里云为该请求生成的唯一标识符。

示例

XML示例

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

JSON示例

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 返回结果数据 */
}
阿里云首页 邮件推送 相关技术圈