1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询集群容器列表
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeClusterContainerList。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-a6df317cb6a8c424"] |
| Filter | 否 | Filter | 通用过滤条件列表。支持的过滤字段: |
| ClusterCaMD5 | 否 | String | 集群ca证书md5值,集群的唯一标识 示例值:ddfda8***ddc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 示例值:10 |
| List | Array of ClusterContainerListItem | 列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterContainerList
<公共请求参数>
{
"ClusterAssetId": "86693c5bf9e9fbdce993d557b1038fd8",
"MemberId": [
"mem-a6df317cb6a8c424"
],
"ClusterCaMD5": "ddfda8***********************ddc"
}
输出示例
{
"Response": {
"List": [
{
"AppID": 260083796,
"AssetId": "16b1e3113189bf28db0584ea67dab7ee67d2fe2b170d7b6456d09caf73e49ea4",
"ContainerId": "16b1e3113189bf28db0584ea67dab7ee67d2fe2b170d7b6456d09caf73e49ea4",
"ContainerName": "[yunjing-agent-zbldl]yunjing-agent",
"ImageId": "ccr.ccs.tencentyun.com/yunjing_agent/agent@sha256:c35369e4b827e0054305354be9f74728e87ade34df23deb92dbd9450b098f2c4",
"ImageName": "ccr.ccs.tencentyun.com/yunjing_agent/agent:latest",
"NodeId": "",
"NodeType": "",
"PodName": "tcss-asset-66c6b4cc44-4v8vl",
"PodUid": "a08a96938d70342df1a8f0c115277a07",
"RunStatus": "RUNNING"
}
],
"TotalCount": 17,
"RequestId": "6e498acb-a6a0-4d6d-96da-369b2c02bb58"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |