You need to enable JavaScript to run this app.
文档中心
内容分发网络

内容分发网络

复制全文
下载 pdf
API 参考
API 响应
复制全文
下载 pdf
API 响应

本文档介绍了火山引擎内容分发网络(CDN)API 的响应。

响应头

每个 API 的响应中包含的响应头的描述如下。

响应状态码

CDN 的响应状态码的介绍如下:

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

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

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

判断 API 请求是否成功

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

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

说明

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

  • CDN 的响应状态码是 2xx,但是 ResponseMetadata 结构体中包含 Error 字段。

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

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

关于 CDN 中的常见错误,参见 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"
		}
	}
}
最近更新时间:2024.06.28 19:18:52
这个页面对您有帮助吗?
有用
有用
无用
无用