查询容器列表

最近更新时间:2025-04-25 01:57:19

我的收藏

1. 接口描述

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

搜索查询容器列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAssetContainerList。
Version String 公共参数,本接口取值:2020-11-01。
Region String 公共参数,此参数为可选参数。
Limit Integer 需要返回的数量,默认为10,最大值为100
示例值:100
Offset Integer 偏移量,默认为0。
示例值:400
Filters.N Array of AssetFilters 过滤条件。
  • ContainerName - String - 是否必填:否 - 容器名称模糊搜索
  • Status - String - 是否必填:否 - 容器运行状态筛选,0:"created",1:"running", 2:"paused", 3:"restarting", 4:"removing", 5:"exited", 6:"dead"
  • Runas - String - 是否必填:否 - 运行用户筛选
  • ImageName- String - 是否必填:否 - 镜像名称搜索
  • HostIP- string - 是否必填:否 - 主机ip搜索
  • OrderBy - String 是否必填:否 -排序字段,支持:cpu_usage, mem_usage的动态排序 ["cpu_usage","+"] '+'升序、'-'降序
  • NetStatus - String -是否必填: 否 - 容器网络状态筛选 normal isolated isolating isolate_failed restoring restore_failed
  • PodID - String -是否必填: 否 - PodID筛选
  • NodeUniqueID - String -是否必填: 否 - SuperNode筛选
  • PodUid - String -是否必填: 否 - Pod筛选
  • PodIP - String -是否必填: 否 - PodIP筛选
  • NodeType - String -是否必填: 否 - 节点类型筛选:NORMAL:普通节点;SUPER:超级节点

  • 示例值:[{"Keywords":"Status","Values":["2"]}]
    By String 排序字段
    示例值:CPUUsage,RamUsage
    Order String 排序方式 asc,desc
    示例值:ASC

    3. 输出参数

    参数名称 类型 描述
    List Array of ContainerInfo 容器列表
    示例值:null
    TotalCount Integer 总数量
    示例值:5848
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 搜索查询容器列表

    搜索查询容器列表

    输入示例

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

    输出示例

    {
        "Response": {
            "List": [
                {
                    "CPUUsage": 0,
                    "ClusterID": "cls-dfw3e***",
                    "ClusterName": "clsfoo***",
                    "Cmd": "--controllers=*,-everest-csi-local-volume --leader-elect=true --leader-elect-resource-lock=endpoints --leader-elect-resource-namespace=kube-system --feature-gates=Topology=true,DistributeAttacher=false --provision-with-strict-topology=true --csi-attacher-worker-threads=60 --csi-attacher-detach-worker-threads=60 --csi-attacher-should-reconcile-va=false",
                    "ContainerID": "8eaffb2a09728b130020b7fe33d87fe3a45856a2ff39eab57873c34815461b22",
                    "ContainerName": "/k8s_everest-csi-controller_everest-csi-controller-7b7df58489-9v9pf_kube-system_3b5f2feb-af96-4c0b-84f0-4e86d0671ae8_2",
                    "CreateTime": "2023-08-30 14:48:19",
                    "HostID": "ed7bcc17-3ad7-455d-b2f6-1712c005ced0",
                    "HostIP": "10.0.4.74",
                    "HostName": "ecs-suanfa-0001",
                    "ImageID": "sha256:3cdeb1036c11af9e7f906ed2a0535056c71f3f53522242fa24a5aa2022b83f2c",
                    "ImageName": "swr.cn-south-1.myhuaweicloud.com/hwofficial/everest:2.1.13",
                    "IsolateSource": "source",
                    "IsolateTime": "1970-01-01 00:00:01",
                    "NetStatus": "NORMAL",
                    "NetSubStatus": "NONE",
                    "NodeID": "mix-GOmf****",
                    "NodeType": "NORMAL",
                    "NodeUniqueID": "896e349d-2e7d-4151-a26f-4e9fdafe****",
                    "POD": "clife-estate-thirdparty-admin-dm-59785fd6-4****",
                    "PodCpu": 0,
                    "PodIP": "10.0.1.92",
                    "PodMem": 0,
                    "PodName": "agent-test-2zrp7",
                    "PodUid": "20461430-67c2-455b-932e-6a6c8981****",
                    "PublicIp": "116.205.224.125",
                    "RamUsage": 99728,
                    "RunAs": "paas",
                    "Status": "RUNNING",
                    "UpdateTime": "2024-07-15 16:05:20"
                }
            ],
            "RequestId": "05844ae1-7f46-41f2-a521-0b6a011cc16d",
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.ParsingError 参数解析错误。
    ResourceNotFound 资源不存在。