You need to enable JavaScript to run this app.
导航
域名服务
  • 文档首页
    • /
  • 域名服务

API 请求响应结果

最近更新时间：2023.02.16 15:16:07

首次发布时间：2022.12.21 20:29:40

我的收藏

本文档介绍了火山引擎域名服务是如何响应 API 请求的。

响应状态码

域名服务的响应状态码的介绍如下：

  • 2xx：表示域名服务已成功响应了 API 请求。但是成功响应未必保证 API 请求是成功的。参见判断 API 请求是否成功。

  • 4xx：表示域名服务无法返回客户端请求的内容。原因是客户端请求不合法。例如：

    • 请求方法不正确。
    • 请求中缺少必要的参数。例如缺少 Action 参数。
    • 请求者没有操作目标资源的权限。

  • 5xx：表示请求已经失败了。失败的原因是域名服务发生了内部错误。例如域名服务不可用。

判断 API 请求是否成功

在您判断 API 请求是否成功时，不建议您使用域名服务的响应状态码。我们建议您使用以下判断标准：

  • 如果一个 API 请求成功，响应正文的 ResponseMetadata 结构体中不包含 Error 字段。
  • 其余情况都被认为是请求失败。您可以在 ResponseMetadata 结构体的 Error 字段中找到相应的错误消息。

说明

您的 API 请求可能会遇到以下情况：

  • 域名服务的响应状态码是 2xx，但是 ResponseMetadata 结构体中包含 Error 字段。

在这种情况下，该 API 请求是失败的。原因就是客户端请求不满足域名服务中的配置。例如模板 ID 不存在。

关于域名服务中的常见错误，参见 错误码说明。

API 请求成功的响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212201818340102120770200576EFAA",
        "Action": "GetAsyncTask",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1"
    },
    "Result": { ... }
}

API 请求失败的响应示例

{
    "ResponseMetadata": {
        "RequestId": "202212201910590102080181520277EBA1",
        "Action": "GetAsyncTask",
        "Version": "2022-12-12",
        "Service": "domain_openapi",
        "Region": "cn-north-1",
        "Error": {
            "CodeN": 100009,
            "Code": "InvalidAccessKey",
            "Message": "The security token included in the request is invalid."
        }
    }
}