校验域名 CNAME 配置状态

最近更新时间:2026-02-02 03:20:28

我的收藏

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

当站点接入类型为 CNAME 接入类型时,要求该站点下的所有接入域名必须按照 EdgeOne 分配的指定 CNAME 域名完成 CNAME 记录配置。
您可以通过本接口获取 EdgeOne 为接入域名分配的指定 CNAME 域名,并且可以通过本接口完成对接入域名的 CNAME 配置状态的校验。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CheckCnameStatus。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
ZoneId String 站点 ID。
RecordNames.N Array of String 需要检测 CNAME 配置状态的域名列表,可以为:
  • 加速域名;
  • 别称域名。
  • 3. 输出参数

    参数名称 类型 描述
    CnameStatus Array of CnameStatus 接入域名的 CNAME 配置状态信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 校验域名 CNAME 配置状态

    对接入域名:test.qq.com 进行 CNAME 配置状态校验,校验的结果为 active(已正确完成 CNAME 配置),EdgeOne 为接入域名分配的指定 CNAME 域名为:test.qq.com.eo.dnse0.com。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CheckCnameStatus
    <公共请求参数>
    
    {
        "ZoneId": "zone-20hyebgyfsko",
        "RecordNames": [
            "example.qq.com"
        ]
    }

    输出示例

    {
        "Response": {
            "CnameStatus": [
                {
                    "RecordName": "test.qq.com",
                    "Cname": "test.qq.com.eo.dnse0.com",
                    "Status": "active"
                }
            ],
            "RequestId": "d08bed0d-15bf-4d65-ab56-906aee0c845"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError.ProxyServer 后端服务器发生未知错误。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。
    UnauthorizedOperation.NoPermission 子账户没有操作权限,请添加权限后继续操作。
    UnauthorizedOperation.Unknown 后端服务器发生未知错误。