本文介绍云搜索服务的 API 返回结果信息。

返回结果示例

• 请求调用成功返回结果

  {
      "ResponseMetadata": {
          "RequestId": "202310231017313****A60DADB80BE85",
          "Action": "DescribeZones",
          "Version": "2023-01-01",
          "Service": "ESCloud",
          "Region": "cn-beijing"
      },
      "Result": {
          "Zones": [
              {
                  "RegionId": "cn-beijing",
                  "ZoneId": "cn-beijing-a",
                  "ZoneName": "可用区A",
                  "ZoneStatus": "AVAILABLE"
              },
              {
                  "RegionId": "cn-beijing",
                  "ZoneId": "cn-beijing-b",
                  "ZoneName": "可用区B",
                  "ZoneStatus": "AVAILABLE"
              },
              {
                  "RegionId": "cn-beijing",
                  "ZoneId": "cn-beijing-c",
                  "ZoneName": "可用区C",
                  "ZoneStatus": "AVAILABLE"
              }
          ]
      }
  }
  

  说明

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

• 请求调用失败返回结果

  {
      "ResponseMetadata": {
          "RequestId": "2023102***54A5A338FA49A",
          "Action": "DescribeInstance",
          "Version": "2023-01-01",
          "Service": "ESCloud",
          "Region": "cn-beijing",
          "Error": {
              "Code": "0012",
              "Message": "wrong id"
          }
      }
  }
  

  说明

  请求调用失败时必定会出现 Error 字段，Error 字段中包含了 Code 和 Message 字段，其中：

  • Code 表示具体出错的错误码，您可以先根据该错误码在公共错误码和当前接口对应的错误码列表里面查找对应原因和解决方案。
  • Message 会给出错误发生的具体原因，随着业务发展或体验优化，此文本可能会变更。

API幂等

在调用 API 创建实例的场景下，需要保证请求在出错后重试的情况下不会创建多个实例，造成资金损失。
通过在相关 API 中的请求参数中加入ClientToken参数，可以标识请求的唯一性，以便在出现错误时，可以使用同一个ClientToken来认证同一个业务请求。
ClientToken是一个用户自行生成的唯一的、大小写敏感、不超过 64 个 ASCII 字符的字符串（如123e4567-e89b-12d3-a456-426655440000），有效期为 24 个小时。即每一个账号的一个特定操作，使用同一个ClientToken后，在 24 小时内重复的发送将会被系统识别，并避免重复操作。