公共参数
更新时间:
介绍每个接口都需要使用的请求参数和返回参数。
公共请求参数
名称 | 类型 | 是否必选 | 描述 |
Format | String | 否 | 返回消息的格式。取值: JSON(默认值) | XML |
Version | String | 是 | API版本号,使用YYYY-MM-DD日期格式。取值: 2019-12-12 |
AccessKeyId | String | 是 | 访问服务使用的密钥ID。 |
Signature | String | 是 | 签名结果串。 |
SignatureMethod | String | 是 | 签名方式,取值: HMAC-SHA1 |
Timestamp | String | 是 | 请求的时间戳,为日期格式。使用UTC时间按照ISO8601标准,格式为YYYY-MM-DDThh:mm:ssZ。 例如,北京时间2013年1月10日20点0分0秒,表示为2013-01-10T20:00:00Z。 |
SignatureVersion | String | 是 | 签名算法版本,取值: 1.0 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。 在不同请求间要使用不同的随机数值,建议使用通用唯一识别码(Universally Unique Identifier, UUID)。 |
ResourceOwnerAccount | String | 否 | 本次API请求访问到的资源拥有者账户,即登录用户名。 |
示例
https://amqp-open.aliyuncs.com/?Action=ListInstances
&Format=JSON
&Version=2019-12-12
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e7b1f31150be45594905ce6d28561286
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2020-02-10T08%3A43%3A05Z
…
公共返回参数
API返回结果采用统一格式,调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId。
返回
2xx
HTTP状态码表示调用成功。返回
4xx
或5xx
HTTP状态码表示调用失败。
公共返回参数示例如下:
XML格式
<?xml version="1.0" encoding="utf-8"?> <!--结果的根结点--> <接口名称+Response> <!--返回请求标签--> <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId> <!--返回结果数据--> </接口名称+Response>
JSON格式
{ "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC", /*返回结果数据*/ }
文档内容是否对您有帮助?