返回结果

本文介绍云数据库 PostgreSQL 版 Open API 的返回结果信息。

返回结果示例

请求调用成功返回结果

{
	"ResponseMetadata" : {
            "RequestId": "52ece640-60ba-4cf9-bf34-302fb45eef4f",
            "Action": "DescribeRegions",
            "Version": "2022-01-01",
            "Service": "rds_postgresql",
            "Region": "cn-beijing"
  	  },
	"Result": { /* 具体业务的返回信息 */
            "Regions":[
               { 
                "RegionId": "cn-beijing", 
                "RegionName": "华北 2（北京）"
               }
            ] 
      }
 }

请求被正常处理后，返回中会包含 ResponseMetadata 和 Result 两部分。
ResponseMetadata 及其内部的 RequestId、Action、Version、Service、Region 是固定的字段，无论请求成功与否，只要发起了 API 请求，必定会返回。请求调用失败时不会返回该字段。ResponseMetadata 各字段的说明如下：

Result 是固定字段，具体返回内容视请求的接口而定，不同的接口会有不同的 Result 返回。

请求调用失败返回结果

{
     "ResponseMetadata" : {
          "RequestId": "d78bbf4e-63a5-4937-ac3c-3767e7eddfbe",
          "Action": "DescribeRegions",
          "Version": "2022-01-01",
          "Service": "rds_postgresql",
          "Region": "cn-beijing",
          "Error": {
              "Code": "Failed",
              "Message": "The request processing has failed due to some unknown error, exception or failure."
          }
     }
 }

相较于成功结果，错误结果将不再有 Result 部分，而 ResponseMetadata 中将额外出现 Error 字段，Error 字段中包含了 Code 和 Message 字段。Error 中各字段的说明如下：