负载均衡查询 BYOK 模型列表及 Key 信息

1. 接口描述

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

查询 BYOK 模型列表及 Key 信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeModelKeys。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。
AccessType	否	String	接入类型过滤：PublicBYOK/PublicCustom/PrivateCustom 示例值：PrivateCustom
Filters.N	否	Array of Filter	过滤条件
Limit	否	Integer	返回数量限制示例值：10
Offset	否	Integer	翻页启始索引示例值：0
ServiceProviderIds.N	否	Array of String	服务提供商ID 示例值：["byok-lfwolo91"]

3. 输出参数

参数名称	类型	描述
Models	Array of ModelKeyInfoItem	模型列表（含 Key 信息）
TotalCount	Integer	模型总数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询模型（包含多模态能力）和Key信息

查询模型（包含多模态能力）和Key信息

输入示例

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

{
    "ServiceProviderIds": [
        "byok-lfwolo91"
    ]
}

输出示例

{
    "Response": {
        "Models": [
            {
                "AccessType": "PublicCustom",
                "ApiBase": "http://11.141.93.26:10000/v1",
                "CreatedAt": "2026-06-01T07:37:25+00:00",
                "HostHeader": null,
                "KeyCount": 3,
                "Keys": [
                    {
                        "CreatedAt": "2026-06-01T07:37:25+00:00",
                        "KeyId": "mkey-qd6kwrnt",
                        "Name": "sk-1"
                    }
                ],
                "ModelIdsWithAlias": [
                    {
                        "AssociatedModelRouters": [],
                        "InputModalities": [
                            "text"
                        ],
                        "ModelAlias": "my-gpt-4o",
                        "ModelId": "gpt-4o",
                        "ProbedInputModalities": [
                            "text"
                        ]
                    }
                ],
                "ModelProvider": "openai",
                "Protocol": "openai",
                "ServiceIps": [],
                "ServiceProviderId": "byok-lfwolo91",
                "ServiceProviderName": null,
                "Status": "Active",
                "SubnetId": null,
                "Tags": [
                    {
                        "TagKey": "text",
                        "TagValue": "text"
                    }
                ],
                "VerifySSL": true,
                "VpcId": null
            }
        ],
        "TotalCount": 1,
        "RequestId": "d4ac361b-35ee-47b0-95b1-a5051c483c57"
    }
}

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

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