CheckCdnDomain--内容分发网络-火山引擎

文档中心

立即注册

导航

CheckCdnDomain

最近更新时间：2025.02.10 18:21:08首次发布时间：2024.12.06 16:43:46

检查该 API 的调用者是否是一个域名的所有者。

使用限制

节流限制：您每秒最多可以提交 20 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=CheckCdnDomain&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `CheckCdnDomain`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示待检查的一个域名，该域名可以是泛域名。	`www.example.com`

返回参数

参数名称	数据类型	参数说明	示例
ErrorMsg	String	表示校验未通过的原因。如果 `Status` 是 `success`，该参数值是空（""）。	`some reason`
Status	String	表示校验结果。该参数有以下取值： `fail`：表示校验未通过。 `success`：表示校验通过。	`fail`

请求示例

POST https://cdn.volcengineapi.com/?Action=CheckCdnDomain&Version=2021-03-01
{
  "Domain":"www.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241206143123375BE43944CA95D1969A",
        "Action": "CheckCdnDomain",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-01"
    },
    "Result": {
        "ErrorMsg": "解析校验失败，请稍后重试。",
        "Status": "fail"
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。