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

公共请求参数

名称 类型 是否必须 描述
Format String 返回值的类型为JSON。
Version String API版本号,为日期形式:YYYY-MM-DD,本版本对应的版本号为2019-03-27。
AccessKeyId String 阿里云分配给用户访问服务所用的密钥ID。
Signature String 签名结果串。关于签名的计算方法,请参见签名机制
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,并需要使用UTC时间,格式为YYYY-MM-DDThh:mm:ssZ。例如,2013-08-15T12:00:00Z为北京时间2013年8月15日12点0分0秒。
SignatureVersion string 签签名算法版本,目前的版本是1.0。
SignatureNonce string 唯一随机数,用于防止网络重放攻击。在不同请求间要使用不同的随机数值。

公共返回参数

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

请求示例

https://dg.aliyuncs.com/
?Format=xml
&Version=2019-06-18
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z

返回示例

调用API服务后,系统返回的数据采用统一格式。返回2xx的HTTP状态码,表示调用成功;返回4xx或5xx的HTTP状态码,表示调用失败。调用成功返回的数据格式是JSON格式,外部系统可以在请求时传入参数来制定返回的数据格式。为了便于查看,本文档中的返回示例做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* 返回结果数据 */
}