公共请求参数

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

相关参数说明

名称 类型 是否必须 描述
Format String 返回值的类型支持JSON与XML,默认为XML。
Version String API版本号,格式为日期形式:YYYY-MM-DD,本版本对应版本号为2015-12-01。
AccessKeyId String 阿里云颁发给用户访问服务所用的密钥ID。
Signature String 签名结果串。
SignatureMethod String 签名方式,目前支持HMAC-SHA1。
Timestamp String
  • 请求的时间戳。日期格式按照ISO8601标准表示,需要使用UTC时间。
  • 格式为:YYYY-MM-DDThh:mm:ssZ,例如:2016-01-01T12:00:00Z(为北京时间2016年1月1日20点0分0秒)。
SignatureVersion String 签名算法版本,目前版本是1.0版本。
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。

请求示例

https:// mongodb.aliyuncs.com/
?Format=json
&Version=2015-12-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2016-01-01T12:00:00Z

公共返回参数

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

返回示例

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

返回结果

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

返回成功结果

XML示例

返回结果包括请求是否成功等信息以及具体的业务数据,示例如下:

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

JSON示例

{
"RequestId": "4C4fdsf38-3910-447D-87AD-AC078932216",
/* 返回结果数据 */
}

返回错误结果

调用接口出错后,将不会返回结果数据。调用方可根据错误代码表来定位错误原因。当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID:RequestId和一个您该次请求访问的站点ID:HostId。

在调用方找不到错误原因时,可以联系阿里云客服,并提供该HostId和RequestId,以便我们尽快帮您解决问题。

XML示例

<?xml version="1.0" encoding="UTF-8"?>
<Error>
<RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
<HostId> mongodb.aliyuncs.com</HostId>
<Code>UnsupportedOperation</Code>
<Message>The specified action is not supported.</Message>
</Error>

JSON示例

{
"RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
"HostId": " mongodb.aliyuncs.com",
"Code": "UnsupportedOperation",
"Message": "The specified action is not supported."
}