云开发 CloudBase 查询HTTP访问服务路由信息

1. 接口描述

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

本接口DescribeHTTPServiceRoute用于查询环境下HTTP访问服务路由信息。可通过Filters过滤。如果不存在不会返回错误。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeHTTPServiceRoute。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境ID 示例值：*-7ezncwdd421446
Filters.N	否	Array of Filter	过滤条件。Key的含义参考对应字段，Value精确匹配。可过滤: Domain、Path、DomainType、UpstreamResourceType。可过滤的Values单条不超过100
Offset	否	Integer	分页偏移量。默认 0 示例值：0
Limit	否	Integer	分页限制。默认20，最大值1000 示例值：10

3. 输出参数

参数名称	类型	描述
Domains	Array of HTTPServiceDomain	域名路由信息列表
OriginDomain	String	自定义接入的源站域名（HTTPService接入层域名）示例值：*******.tencentcloudbase.com
TotalCount	Integer	域名总数，分页查询使用总数判断是否已经拉取到所有数据示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询路由信息

通过域名过滤查询单个域名信息

输入示例

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

{
    "EnvId": "*****************-7ezncwdd421446",
    "Filters": [
        {
            "Name": "Domain",
            "Values": [
                "xxx.***************.cn"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Domains": [
            {
                "AccessType": "DIRECT",
                "CertId": "VF******",
                "Cname": "xxx.*********************************.tencentcloudbase.com",
                "CreateTime": "2026-03-13T10:03:25+08:00",
                "DNSStatus": "INVALID",
                "Domain": "xxx.***************.cn",
                "DomainType": "HTTPSERVICE",
                "Enable": true,
                "IsDefault": false,
                "Protocol": "HTTP_AND_HTTPS",
                "Routes": [
                    {
                        "CreateTime": "2026-03-13T10:03:26+08:00",
                        "Enable": true,
                        "EnableAuth": false,
                        "EnablePathTransmission": false,
                        "EnableSafeDomain": false,
                        "Path": "/api/v1",
                        "PathRewrite": {},
                        "QPSPolicy": {
                            "QPSPerClient": {
                                "LimitBy": "ClientIP",
                                "LimitValue": 10
                            },
                            "QPSTotal": 100
                        },
                        "UpdateTime": "2026-03-13T10:03:26+08:00",
                        "UpstreamResourceName": "my-service",
                        "UpstreamResourceType": "CBR"
                    }
                ],
                "Status": "SUCCESS",
                "UpdateTime": "2026-03-13T10:03:25+08:00"
            }
        ],
        "OriginDomain": "***********************************************.tencentcloudbase.com",
        "TotalCount": 1,
        "RequestId": "9d15e1e6-24a7-4de5-9be0-d6470f32120b"
    }
}

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. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InvalidParameter.EnvId	环境ID非法。

查询HTTP访问服务路由信息

本页目录：