1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
创建 API Key
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateApiKey。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Name | 是 | String | API Key 名称 示例值:test_061504-key-20260615210334-huny |
| ServiceId | 否 | String | 绑定的推理服务ID(可选,为空表示创建后不绑定任何服务) 示例值:svc-20260615210333-5si0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ApiKeyId | String | API Key ID(唯一标识) 示例值:apikey-20260615211539-xzma |
| Name | String | API Key 名称(用户创建时指定的可读名称) 示例值:test_061504-key-20260615210334-huny |
| ApiKey | String | API Key 值(完整密钥字符串,用于鉴权时携带在请求头中) 示例值:sk-* |
| ServiceId | String | 关联的推理服务ID 示例值:svc-20260615210333-5si0 |
| ServiceName | String | 关联的推理服务名称 示例值:qzzhu_061504 |
| Status | String | API Key 状态,可选值:Active(活跃可用)/ Revoked(已停用)。空闲 Key 通常为 Active 状态 示例值:Revoked |
| AppId | Integer | 应用ID 示例值:200000000 |
| Uin | String | 主账号UIN 示例值:7*** |
| CreateTime | Integer | 创建时间(毫秒时间戳) 示例值:1781527738362 |
| UpdateTime | Integer | 更新时间(毫秒时间戳) 示例值:1781527738362 |
| SubAccountUin | String | 子账号UIN(实际操作者) 示例值:7*** |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 API Key
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateApiKey
<公共请求参数>
{
"Name": "chenfan_test"
}
输出示例
{
"Response": {
"ApiKey": "sk-*****************************************************",
"ApiKeyId": "apikey-20260615204858-736d",
"AppId": 200000000,
"CreateTime": 1781527738362,
"Name": "chenfan_test",
"Status": "Revoked",
"SubAccountUin": "7***********",
"Uin": "7***********",
"UpdateTime": 1781527738362,
"RequestId": "f55e63df-8774-4e56-8c79-bbfaa60b57d7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ExternalService | 外部服务异常 |