You need to enable JavaScript to run this app.
导航
API 请求响应结果
最近更新时间:2023.02.15 10:24:02首次发布时间:2021.07.15 11:09:03

本文档介绍了火山引擎内容分发网络是如何响应 API 请求的。

响应状态码

内容分发网络的响应状态码的介绍如下:

  • 2xx:表示内容分发网络已成功响应了 API 请求。但是成功响应未必保证 API 请求是成功的。参见判断 API 请求是否成功

  • 4xx:表示内容分发网络无法返回客户端请求的内容。原因是客户端请求不合法。例如:

    • 请求的文件不存在。
    • 请求方法不正确。
    • 请求中缺少必要的参数。例如缺少 Action 参数。
    • 请求者没有操作目标资源的权限。
  • 5xx:表示请求已经失败了。失败的原因是内容分发网络发生了内部错误。例如内容分发网络服务不可用。

判断 API 请求是否成功

在您判断 API 请求是否成功时,不建议您使用内容分发网络的响应状态码。我们建议您使用以下判断标准:

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

说明

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

  • 内容分发网络的响应状态码是 2xx,但是 ResponseMetadata 结构体中包含 Error 字段。

在这种情况下,该 API 请求是失败的。原因就是客户端请求不满足内容分发网络中的配置。例如:

  • 某个请求参数的值不合法。
  • 在您为加速域名配置证书时,证书文件没有包含完整的证书链。

关于内容分发网络中的常见错误,参见 API 请求错误码

响应示例

API 请求成功的响应示例

{
	"ResponseMetadata": {
		"RequestId": "2021041510110201022510703416005FB0",
		"Action": "DescribeCdnData",
		"Version": "2021-03-01",
		"Service": "CDN",
		"Region": "cn-north-1"
	},
	"Result": {...}
}

API 请求失败的响应示例

{
	"ResponseMetadata": {
		"RequestId": "2021041510110201022510703416005FB0",
		"Action": "DescribeCdnData",
		"Version": "2021-03-01",
		"Service": "CDN",
		"Region": "cn-north-1",
		"Error": {
			"Code": "ResourceNotFound",
			"Message": "resource is not found"
		}
	}
}