负载均衡查询模型别名列表

1. 接口描述

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

查询当前用户 BYOK 中已经配置过的模型别名列表，按 Provider 和 ModelAliasName 去重。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeModelAliases。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。
Filters.N	否	Array of Filter	过滤条件支持的过滤键： ModelAliasName：按模型别名过滤。
Limit	否	Integer	每页数量，取值范围：[1, 100]，默认值：20。示例值：20
Offset	否	Integer	分页偏移量，默认值：0。示例值：1
Sort.N	否	Array of Sort	排序条件。支持按 InputCoefficient、InputCachedCoefficient 或 OutputCoefficient 排序，Order 支持 ASC、DESC。不传或传空数组时，默认按 OutputCoefficient 降序排列。最多支持 3 个排序条件，排序字段不可重复。

3. 输出参数

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

4. 示例

示例1 查询模型别名列表

输入示例

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

{
    "Limit": 20,
    "Offset": 1
}

输出示例

{
    "Response": {
        "ModelAliasSet": [
            {
                "Coefficient": {
                    "InputCoefficient": 25,
                    "InputCachedCoefficient": 3,
                    "OutputCoefficient": 100
                },
                "ModelAliasName": "gpt-4o",
                "Source": "BYOK",
                "Status": "Active",
                "ServiceProviderCoefficientSet": [
                    {
                        "ServiceProviderId": "byok-52mdfb352",
                        "ServiceProviderName": "openai-direct",
                        "Coefficient": {
                            "InputCoefficient": 40,
                            "InputCachedCoefficient": 5,
                            "OutputCoefficient": 160
                        }
                    },
                    {
                        "ServiceProviderId": "byok-7a1c9e02",
                        "ServiceProviderName": "openai-proxy"
                    }
                ]
            }
        ],
        "TotalCount": 7,
        "RequestId": "1f58bf6f-3576-4f1a-9f33-8ffdf9917369"
    }
}

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

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

查询模型别名列表

本页目录：