负载均衡进行BYOK健康探测

1. 接口描述

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

BYOK健康检查

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：TestServiceProviderConnection。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。
Models.N	否	Array of String	需要探测的模型列表入参限制：上限为20个模型示例值：["deepseek-reasoner"]
ProviderKey	否	String	需要探测的Key 示例值：sk-40df882e447043fcaca5e0fce4af1db1
ProviderKeyId	否	String	需要探测的KeyId，和ProviderKey二者传一个即可示例值：mkey-7jj4vetd
AccessType	否	String	BYOK类型，当ProviderKey存在时必传示例值：PublicCustom
ModelProvider	否	String	模型的厂商示例值：tokenhub
ModelProtocol	否	String	模型厂商协议，当ProviderKey存在时必传示例值：deepseek
ApiBase	否	String	BYOK类型，当AccessType为PublicCustom时生效示例值：http://api.deepseek.com/v1
HostHeader	否	String	请求携带的Host头部，当AccessType为PrivateCustom时生效示例值：test.com
ServiceProviderId	否	String	BYOK的ID，当AccessType为PrivateCustom时生效示例值：byok-giaywwtf
VerifySSL	否	Boolean	是否校验服务提供商的SSL证书默认值：AccessType取值为： PublicBYOK时，该参数无效； PublicCustom时，该参数默认为true； PrivateCustom时，该参数默认为false；示例值：false
HealthCheckProtocol	否	String	健康检查协议枚举值： chat：表示/chat/completion协议 messages：表示/v1/messages协议 responses：表示/responses协议示例值：chat
CMRPrivateNetworkTunnelId	否	String	CMR 私网管道ID 示例值：pnt-lbepdi5o
Capability	否	String	对应模型的能力枚举值： chat：生文能力 embedding：向量能力 rerank：重排序能力 video：生视频能力示例值：chat
EndpointPath	否	String	端点路径示例值：/compatible-mode/v1
HealthCheckMethod	否	String	健康检查方式枚举值： Service：探测服务可用性 Model：探测模型可用性示例值：Service
HealthCheckPath	否	String	健康检查路径。仅HealthCheckMethod为Service时生效。示例值：v1/models

3. 输出参数

参数名称	类型	描述
Results	Array of ModelTestResult	探测结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 探测模型是否健康

输入示例

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

{
    "Models": [
        "deepseek-reasoner"
    ],
    "ProviderKey": "sk-40df882e447043fcaca5e0fce4af1db1",
    "AccessType": "PublicCustom",
    "ModelProtocol": "deepseek",
    "ApiBase": "http://api.deepseek.com/v1",
    "VerifySSL": false
}

输出示例

{
    "Response": {
        "Results": [
            {
                "ErrorInfo": {
                    "ErrorStatus": "",
                    "HttpCode": 0,
                    "OriginalMessage": ""
                },
                "Model": "deepseek-reasoner",
                "Status": "Success",
                "TestConnectionRequest": {
                    "RequestBody": "",
                    "RequestHeaders": "",
                    "RequestUrl": ""
                }
            }
        ],
        "RequestId": "0dc8d1e6-9fd3-41c9-a39e-dbd3d16da611"
    }
}

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

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

进行BYOK健康探测

本页目录：