1. 接口描述
接口请求域名： clb.tencentcloudapi.com 。
创建 API Key
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateKey。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai, ap-singapore, na-siliconvalley 。 |
| ModelRouterId | 是 | String | 模型路由实例ID 示例值：cmr-pm53f9c3 |
| KeyName | 否 | String | Key名称 示例值：测试key |
| RateLimitConfig | 否 | RateLimitConfigForKey | 限速配置 |
| BudgetId | 否 | String | 关联的积分预算ID 示例值：budget-6sek5osn |
| UserGroupId | 否 | String | 需要关联的用户组ID 示例值：ugrp-93eee43e |
| Tags.N | 否 | Array of TagInfo | 标签 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KeyId | String | Key的ID 示例值：vkey-cgjyw5xj |
| Key | String | 返回的真实Key 示例值：sk-uI_NjZwG9s9p3VS1wkL26ABYni4hbCEsq0-SOOlzkGL2-882Qp9XsHzKZaI27zQO4R5c18Im1wh4aUYGW0dizfMT |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建Key
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateKey
<公共请求参数>
{
"ModelRouterId": "cmr-pm53f9c3",
"KeyName": "测试key"
}输出示例
{
"Response": {
"Key": "sk-uI_NjZwG9s9p3VS1wkL26ABYni4hbCEsq0-SOOlzkGL2-882Qp9XsHzKZaI27zQO4R5c18Im1wh4aUYGW0dizfMT",
"KeyId": "vkey-cgjyw5xj",
"RequestId": "d81e7b1f-3587-491b-8556-9e47222fecfd"
}
}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
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
