1. 接口描述
接口请求域名: tcbr.tencentcloudapi.com 。
查询版本详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeVersionDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2022-02-17。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境Id 示例值:frederickli***clc930f66d |
| ServerName | 是 | String | 服务名 示例值:echos |
| VersionName | 是 | String | 版本名 示例值:echos-008 |
| Channel | 否 | String | channel 示例值:gateway |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 版本名 示例值:echos-008 |
| Port | Integer | 端口号 示例值:0 |
| Cpu | Float | cpu 规格 示例值:1 |
| Mem | Float | mem 规格 示例值:2 |
| MinNum | Integer | 最小副本数 示例值:0 |
| MaxNum | Integer | 最大副本数 示例值:5 |
| PolicyDetails | Array of HpaPolicy | 扩缩容策略 |
| Dockerfile | String | Dockerfile path 示例值:Dockerfile |
| BuildDir | String | 目标目录 示例值:. |
| EnvParams | String | 环境变量 示例值:{"key":"val"} |
| Status | String | 状态 示例值:build_failed |
| CreatedTime | String | 创建时间 示例值:2025-12-18 15:32:24 |
| UpdatedTime | String | 更新时间 示例值:2025-12-18 16:04:43 |
| LogPath | String | 日志采集路径 示例值:stdout |
| EntryPoint | String | entryPoint 注意:此字段可能返回 null,表示取不到有效值。 示例值:["/ap***ho"] |
| Cmd | String | Cmd 注意:此字段可能返回 null,表示取不到有效值。 示例值:["/ap***ho"] |
| VpcConf | VpcConf | vpc conf 注意:此字段可能返回 null,表示取不到有效值。 |
| VolumesConf | Array of VolumeConf | volume conf 注意:此字段可能返回 null,表示取不到有效值。 |
| BuildPacks | BuildPacksInfo | buildpack 信息 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询版本详情
输入示例
POST / HTTP/1.1
Host: tcbr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVersionDetail
<公共请求参数>
{
"EnvId": "frederickli***clc930f66d",
"ServerName": "echos",
"VersionName": "echos-008"
}
输出示例
{
"Response": {
"BuildDir": ".",
"BuildPacks": {
"BaseImage": "Python3",
"EntryPoint": "echo 1",
"LanguageVersion": "",
"RepoLanguage": "Python",
"UploadFilename": ""
},
"Cmd": "[\"/ap***ho\"]",
"Cpu": 1,
"CreatedTime": "2025-12-18 15:32:24",
"Dockerfile": "",
"EntryPoint": "[\"/ap***ho\"]",
"EnvParams": "",
"LogPath": "stdout",
"MaxNum": 5,
"Mem": 2,
"MinNum": 0,
"Name": "echos-008",
"PolicyDetails": [
{
"PolicyThreshold": 50,
"PolicyType": "cpu"
}
],
"Port": 0,
"Status": "build_failed",
"UpdatedTime": "2025-12-18 16:04:43",
"VolumesConf": [],
"VpcConf": {
"SubnetCIDR": "",
"SubnetId": "",
"VpcCIDR": "",
"VpcId": ""
},
"RequestId": "1c148a2d-6d44-450e-a160-a097dbf4c63e"
}
}
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 | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceNotFound | 资源不存在。 |