文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>容器安全服务>集群安全相关接口>获取用户的pod列表

获取用户的pod列表

最近更新时间：2025-09-12 03:38:18

我的收藏

本页目录：

1. 接口描述

接口请求域名： tcss.tencentcloudapi.com 。

获取用户的pod列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeUserPodList。
Version 是 String 公共参数，本接口取值：2020-11-01。
Region 否 String 公共参数，此参数为可选参数。
ClusterId 否 String 集群Id,不填表示获取用户所有pod
示例值：cls-as2mkd13
Offset 否 Integer 偏移量
示例值：10
Limit 否 Integer 每次查询的最大记录数量
示例值：10
Filters.N 否 Array of ComplianceFilters Name 可取值：ClusterId集群id,Namespace命名空间等
示例值：[{
"Name": "Name",
"Values": [“namepsace”],
"ExactMatch": false
}]
By 否 String 排序字段
示例值：StartTime
Order 否 String 排序方式 asc,desc
示例值：asc
ServiceName 否 String Service名称
示例值：wk-service
Namespace 否 String 命名空间
示例值：default

3. 输出参数

参数名称 类型 描述
PodList Array of ClusterPodInfo Pod列表详细信息
TotalCount Integer Pod列表总数量
示例值：19
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群的Pod列表

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserPodList
<公共请求参数>

{
    "ClusterId": "cls-ane0zamq",
    "Limit": "1",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "PodList": [
            {
                "Age": "303h45m31.069895614s",
                "CPU": 0,
                "ChargeCoresCnt": 0,
                "ClusterId": "cls-abhq0j4o",
                "ClusterName": "bx_test_tmp",
                "ClusterStatus": "CSR_RUNNING",
                "ClusterType": "INDEPENDENT_CLUSTER",
                "ContainerCount": 0,
                "ContainerId": "ContainerId",
                "ContainerName": "ContainerName",
                "HostId": "ins-qj24hgj0",
                "HostName": "hn***",
                "Labels": "3",
                "Memory": 0,
                "Namespace": "default",
                "NodeLanIP": "10.0.0.14",
                "NodeName": "i-node***",
                "NodeType": "NORMAL",
                "PodIP": "192.168.0.172",
                "PodName": "tiefighter",
                "Region": "ap-guangzhou",
                "Restarts": 0,
                "ServiceCount": 0,
                "ServiceName": "ServiceName",
                "StartTime": "2024-10-17 23:03:42",
                "Status": "Running",
                "WorkloadKind": "Replic****",
                "WorkloadLabels": "WorkloadLabels",
                "WorkloadName": "ka-waybill-router-f877d****"
            }
        ],
        "RequestId": "1d32a744-4f31-4a6b-8574-7919f034f317",
        "TotalCount": 54
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
中国站
目录