校验HTTP访问服务路由

1. 接口描述

接口请求域名： tcb.tencentcloudapi.com 。

覆盖的校验项包括：

1. Ownership：域名所有权（TXT/CNAME 记录）；
2. Cert：证书与域名匹配（CertId 为空时跳过）；
3. Quota：环境下域名/路径数量配额；
4. RouteConflict：同域名下路由路径冲突；
5. DomainConflict：域名被其他环境占用；
6. InternalAccount：内部域名且非内部账号；
7. Blacklist：域名黑名单；
8. CDNResource：AccessType=CDN 时 CDN 资源存在性 / 状态（含 ICP 未备案提示）；
9. EO：AccessType=EO 时 EdgeOne 侧域名冲突 / 备案 / 归属权预检。

使用方式：

• 调用本接口前置校验，若 Passed=true 表示所有启用检查项均通过，可继续调用 CreateHTTPServiceRoute 正式创建；
• 若 Passed=false，前端应根据各 CheckItem 的 Code 精确渲染对应的错误提示与用户操作指引（如 DNS 归属权配置、ICP 备案指引等），用户修正参数后可重复调用本接口，直到通过后再进行创建。

注意：本接口为只读 dry-run 操作，不落库、不创建任何资源，仅返回各项检查的详细结果。本接口通过不代表 CreateHTTPServiceRoute 必然成功（例如证书运行时状态、并发抢占等仍需创建时最终判定），但本接口不通过则 CreateHTTPServiceRoute 必然不通过。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 校验路由

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyHTTPServiceRoute
<公共请求参数>

{
    "EnvId": "*****************-7ezncwdd421446",
    "Domain": {
        "Domain": "********************.cn",
        "AccessType": "EO",
        "Protocol": "HTTP_AND_HTTPS",
        "Enable": true,
        "Routes": [
            {
                "Path": "/autotest/api",
                "UpstreamResourceType": "CBR",
                "UpstreamResourceName": "autotest-service",
                "EnableSafeDomain": true,
                "EnableAuth": false,
                "EnablePathTransmission": false,
                "QPSPolicy": {
                    "QPSTotal": 500,
                    "QPSPerClient": {
                        "LimitBy": "ClientIP",
                        "LimitValue": 50
                    }
                },
                "Enable": true,
                "Extension": {
                    "HeadersHandler": {
                        "RequestHeadersToAdd": [
                            {
                                "Key": "X-Route-Header",
                                "Value": "route-value",
                                "Action": "OVERWRITE_IF_EXISTS_OR_ADD"
                            }
                        ],
                        "ResponseHeadersToAdd": [
                            {
                                "Key": "X-Route-Response",
                                "Value": "route-resp-value",
                                "Action": "OVERWRITE_IF_EXISTS_OR_ADD"
                            }
                        ]
                    }
                }
            }
        ],
        "Extension": {}
    }
}

输出示例

{
    "Response": {
        "Blacklist": {
            "Message": "not in blacklist",
            "Status": "PASS"
        },
        "CDNResource": {
            "Message": "access type is not CDN, cdn resource check skipped",
            "Status": "SKIPPED"
        },
        "Cert": {
            "Message": "CertId is empty, cert verify skipped",
            "Status": "SKIPPED"
        },
        "DomainConflict": {
            "Message": "no domain conflict",
            "Status": "PASS"
        },
        "EO": {
            "Message": "域名尚未备案",
            "Status": "FAIL"
        },
        "InternalAccount": {
            "Message": "not an internal domain, skipped",
            "Status": "SKIPPED"
        },
        "Ownership": {
            "Message": "domain ownership verification failed for ab7.woyaodaguaishou1.cn",
            "OwnershipVerification": {
                "DnsVerification": [
                    {
                        "RecordType": "TXT",
                        "RecordValue": "*****************-7ezncwdd421446",
                        "Subdomain": "_cloudbase-challenge.********************.cn"
                    }
                ],
                "Domain": "********************.cn"
            },
            "Status": "FAIL"
        },
        "Passed": false,
        "Quota": {
            "Message": "quota check passed",
            "Status": "PASS"
        },
        "RouteConflict": {
            "Message": "no route conflict",
            "Status": "PASS"
        },
        "RequestId": "b4912cfe-d26d-4cc0-bb55-eb47cee7fdcb"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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