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

文档中心

立即注册

导航

CheckDomain

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

检查一个域名是否符合要求。只有符合要求的域名才能被添加到 CDN 中。检查结果显示在该 API 的响应正文中。

关于域名检查的详细信息，参见域名检查。

使用限制

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

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
Domain	String	是	表示待检查的一个域名。该域名可以是一个泛域名。	`www.example.com`
ServiceRegion	String	是	表示您要为该域名开通的 CDN 服务区域。该参数有以下取值： `chinese_mainland`：表示 "中国内地"。 `outside_chinese_mainland`：表示 "全球（不含中国内地）"。 `global`：表示 "全球"。	`chinese_mainland`

返回参数

参数名称	数据类型	参数说明	示例
Data	Object[]	表示检查的结果。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202412051605033A161C6099E0EF21F936",
        "Action": "CheckDomain",
        "Version": "2021-03-01",
        "Service": "CDN",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": [
            {
                "Access": false,
                "Domain": "www.example.com",
                "ErrorMsg": "请先验证域名的归属权，验证成功后可添加域名。",
                "ErrorType": 10,
                "RetrieveStatus": "verifying"
            }
        ]
    }
}

错误码

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