本文介绍文档数据库 MongoDB 版的 API 返回结构信息。

返回结果示例

• 请求调用成功返回结果

  {
  	"ResponseMetadata" : {
            "RequestId": "202202091517470102040490790603E341",
            "Action": "DescribeRegions",
            "Version": "2022-01-01",
            "Service": "mongodb",
            "Region": "cn-beijing",
  	  }
  	"Result": { /* 具体业务的返回信息 */
            "Regions":[
               { 
                "RegionId": "cn-beijing", 
                "RegionName": "华北2（北京）"
               },
            ] 
      }
  }
  

  说明

  • ResponseMetadata 及其内部的 RequestId、Action、Version、Service、Region 是固定的字段，无论请求成功与否，只要发起了 API 请求，必定会返回。
  • RequestId 是一个 API 请求的唯一标识，如果 API 出现异常，您可以提交工单联系技术支持，并提供该 ID 来帮助定位问题。
  • Result 是固定字段，此字段的内容由不同的产品自行定义。请求调用失败时不会返回该字段。
  • 除了固定的字段外，其余均为具体 API 定义的字段，不同的 API 所返回的字段请参见各 API 文档中的具体定义。

• 请求调用失败返回结果

  {
     "ResponseMetadata" : {
          "RequestId": "202202091526190102100291611503CEA0",
          "Action": "DescribeRegions",
          "Version": "2022-01-01",
          "Service": "mongodb",
          "Region": "cn-beijing",
          "Error": {
              "Code": "Failed",
              "Message": "The request processing has failed due to some unknown error, exception or failure.", 
          }
     }
  }
  

  说明

  • 请求调用失败时必定会出现 Error 字段，Error 字段中包含了 Code 和 Message 字段，其中：
    • Code 表示具体出错的错误码，您可以先根据该错误码在公共错误码和当前接口对应的错误码列表里面查找对应原因和解决方案。
    • Message 会给出错误发生的具体原因，随着业务发展或体验优化，此文本可能会变更。
  • 请求调用失败时，不会返回 Result 字段。