1. 接口描述
接口请求域名： csip.tencentcloudapi.com 。
集群pod列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterPodAssets。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-21。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值：["mem-6wfo0fzks3","mem-85fo0fzks4"] |
| Filter | 否 | Filter | 过滤 示例值：{ "Filters": [ { "Name": "Status", "Values": [ "0" ], "OperatorType": 7 }, { "Name": "Uin", "Values": [ "100065" ], "OperatorType": 7 } ], "Limit": 10, "Offset": 0, "StartTime": "2024-10-26 00:00:00", "EndTime": "2024-11-01 23:59:59" } |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of AssetClusterPod | 列表 示例值：[ { "AppId": 1302396211, "AssetId": "002a244ad33*6b7ec01b91ae63a9", "AssetName": "kubernetes-proxy-6dd44f7b74-mqf4n", "ClusterId": "cls-0hdxu91s", "ClusterName": "yancyw", "ContainerCount": 1, "InstanceCreateTime": "2024-08-22 21:45:10", "IsCore": 2, "IsNewAsset": 0, "MachineId": "ins-0hdxu91s", "MachineName": "my-vm", "Namespace": "default", "Nick": "声声乌龙", "PodIp": "10..0.", "PrivateIp": "10..0.", "PublicIp": "118...", "Region": "ap-guangzhou", "ServiceCount": 1, "Status": "Running", "Uin": "100014111178" } ] |
| TotalCount | Integer | 总数 示例值：10 |
| PodStatusList | Array of FilterDataObject | 集群pod状态枚举 示例值：[ { "Text": "running", "Value": "running" }, { "Text": "succeeded", "Value": "succeeded" } ] |
| NamespaceList | Array of FilterDataObject | 命名空间枚举 示例值：[ { "Text": "default", "Value": "default" }, { "Text": "kube-system", "Value": "kube-system" }, { "Text": "tcss", "Value": "tcss" } ] |
| RegionList | Array of FilterDataObject | 地域枚举 示例值：[ { "Text": "广州", "Value": "ap-guangzhou" } ] |
| AppIdList | Array of FilterDataObject | 租户枚举 示例值：[ { "Text": "1302396211", "Value": "1302396211" } ] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 集群pod列表
集群pod列表
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterPodAssets
<公共请求参数>
{
"MemberId": [
"mem-68b8087a65268000"
],
"Filter": {
"Limit": 1,
"Offset": 0
}
}输出示例
{
"Response": {
"AppIdList": [
{
"Text": "1302396211",
"Value": "1302396211"
}
],
"Data": [
{
"AppId": 1302396211,
"AssetId": "002a244ad33***6b7ec01b91ae63a9",
"AssetName": "kubernetes-proxy-6dd44f7b74-mqf4n",
"ClusterId": "cls-0hdxu91s",
"ClusterName": "yancyw",
"ContainerCount": 1,
"InstanceCreateTime": "2024-08-22 21:45:10",
"IsCore": 2,
"IsNewAsset": 0,
"MachineId": "ins-0hdxu91s",
"MachineName": "my-vm",
"Namespace": "default",
"Nick": "声声乌龙",
"PodIp": "10.**.0.**",
"PrivateIp": "10.**.0.**",
"PublicIp": "118.**.**.**",
"Region": "ap-guangzhou",
"ServiceCount": 1,
"Status": "Running",
"Uin": "100014111178"
}
],
"NamespaceList": [
{
"Text": "default",
"Value": "default"
},
{
"Text": "kube-system",
"Value": "kube-system"
},
{
"Text": "tcss",
"Value": "tcss"
}
],
"PodStatusList": [
{
"Text": "running",
"Value": "running"
},
{
"Text": "succeeded",
"Value": "succeeded"
}
],
"RegionList": [
{
"Text": "广州",
"Value": "ap-guangzhou"
}
],
"RequestId": "077d335a-f2c7-4f20-884a-9700086f3608",
"TotalCount": 27
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
