公共参数包括公共请求参数和公共返回参数。
公共请求参数
公共请求参数是指每个接口都需要使用到的请求参数。
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Format | String | 否 | 返回值的类型,默认为JSON。 |
Version | String | 是 | API版本号,格式为日期形式YYYY-MM-DD,本版本对应为2020-09-30。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥ID。 |
Signature | String | 是 | 签名结果串。关于签名的计算方法,请参见签名机制。 |
SignatureMethod | String | 是 | 签名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 请求的时间戳,格式为日期形式YYYY-MM-DD Thh:mm:ssZ,例如2020-12-22 T12:00:00Z(北京时间为2020年12月22日20点00分00秒)。 日期格式需要按照ISO8601标准表示并使用UTC时间。 |
SignatureVersion | String | 是 | 签名算法版本,目前版本为1.0。 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。 |
ResourceOwnerAccount | String | 否 | 本次API请求访问到的资源拥有者账户,即登录用户名。 关于此参数的配置方法,请参见配置用户权限。 |
请求示例
https://imm.cn-hangzhou.aliyuncs.com/
?Format=json
&Version=2020-09-30
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2017-12-22T12:00:00Z
…
公共返回参数
用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId给用户。
参数 | 类型 | 描述 |
---|---|---|
RequestId | String | 当次请求的Request ID。 |
返回示例
JSON
格式{
"RequestId": "7F7D235C-76FF-4B65-800C-8238AE3F7230",
/* 返回结果数据 */
}