API请求响应结果

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

响应状态码

私有CA服务的响应状态码的介绍如下：

• 2xx：表示私有CA服务已成功响应了 API 请求。但是成功响应未必保证 API 请求是成功的。参见判断 API 请求是否成功。
• 4xx：表示私有CA服务无法返回客户端请求的内容。原因是客户端请求不合法。例如：
  • 请求的文件不存在。
  • 请求方法不正确。
  • 请求中缺少必要的参数。例如缺少 Action 参数。
  • 请求者没有操作目标资源的权限。
• 5xx：表示请求已经失败了。失败的原因是私有CA服务发生了内部错误。例如私有CA服务服务不可用。

判断 API 请求是否成功

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

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

关于私有CA服务中的常见错误，参见 API 请求错误码。

响应示例

API 请求成功的响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230314151646747AE0BE8437E90EA396",
        "Action": "CreateRootInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
	"Result": {...}
}

API 请求失败的响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230317153442B0343CB3E5646E4ABCFC",
        "Action": "CreateRootInstance",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1",
        "Error": {
            "Code": 2000,
            "Message": "服务器内部错误"
        }
    }
}