1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
查询云托管服务版本容器列表
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCloudBaseRunPodList。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境id 示例值：env-sdfsd |
| ServerName | 是 | String | 服务名 示例值：server-sdfsdf |
| VersionName | 是 | String | 版本名 示例值：version |
| Limit | 否 | Integer | 分页限制 示例值：10 |
| Offset | 否 | Integer | 分页偏移量 示例值：0 |
| Status | 否 | String | 容器状态 示例值：normal |
| PodName | 否 | String | 容器名 示例值：pod |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Offset | Integer | 偏移量 示例值：0 |
| Limit | Integer | 分页大小 示例值：10 |
| TotalCount | Integer | 总数 示例值：1 |
| PodList | Array of CloudBaseRunVersionPod | 容器列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例一
输入示例
https://tcb.tencentcloudapi.com/?Action=DescribeCloudBaseRunPodList
&EnvId="test"
&ServerName="test"
&VersionName="test-001"
&PodName="test-001-111"
&Status="running"
&<公共请求参数>输出示例
{
"Response": {
"PodList": [
{
"Webshell": "https://tkecache.cloud.tencent.com/qcloud/ccs/webconsole/index.html#rid=4&clusterId=cls-e7ovytqu&podId=test-nanking-30-001-5d54476cf-zzkzc&containerName=test-nanking-30-001&namespace=default&tkeeks=1",
"PodId": "test-nanking-30-001-5d54476cf-zzkzc",
"Status": "Running",
"PodIp": "10.0.0.36",
"CreateTime": "2020-06-30 13:28:33 +0000 UTC"
}
],
"TotalCount": 1,
"Offset": 0,
"RequestId": "8971182b-32a0-4d9b-b0e2-2190524a1cfb",
"Limit": 10
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ServiceNotExist | 服务不存在。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
