全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 更多
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 智能硬件
云数据库 MongoDB 版

公共参数

更新时间:2017-11-15 10:14:39

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

相关参数说明

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

示例

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

公共返回参数

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

示例

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

返回结果

调用API服务后返回数据采用统一格式,返回的HTTP状态码为2xx,代表调用成功;返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。

说明:本文档中的返回示例为了便于用户查看,做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。

成功结果

XML返回结果包括请求是否成功信息和具体的业务数据。示例如下:

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

JSON示例

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

错误结果

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

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

示例如下:

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

JSON示例

  1. {
  2. "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
  3. "HostId": " mongodb.aliyuncs.com",
  4. "Code": "UnsupportedOperation",
  5. "Message": "The specified action is not supported."
  6. }
本文导读目录