文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器管理/ 查询容器基本信息列表 - ListContainers
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询容器基本信息列表 - ListContainers

功能介绍

查询容器基本信息列表

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/container/kubernetes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位。

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

container_name

否

String

参数解释:

容器名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

pod_name

否

String

参数解释:

所属Pod名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

image_name

否

String

参数解释:

镜像名称

约束限制:

不涉及

取值范围:

字符长度0-128位

默认取值:

不涉及

cluster_container

否

Boolean

参数解释:

是否是集群纳管的容器

约束限制:

不涉及

取值范围:

  • true：是集群纳管的容器。

  • false：不是集群纳管的容器。

默认取值:

false

limit

否

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

offset

否

Integer

参数解释:

指定返回记录的开始位置

约束限制:

不涉及

取值范围:

取值0-2000000

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

容器总数

取值范围:

取值0-2147483647

last_update_time

Long

参数解释:

最近更新时间

取值范围:

取值0-4071095999000

data_list

Array of ContainerBaseInfo objects

参数解释:

容器基本信息列表

取值范围:

取值0-2147483647个ContainerBaseInfo对象
表5 ContainerBaseInfo

参数

参数类型

描述

id

String

参数解释:

ID

取值范围:

字符长度0-255位

region_id

String

参数解释:

区域

取值范围:

字符长度0-255位

container_id

String

参数解释:

容器ID

取值范围:

字符长度0-255位

container_name

String

参数解释:

容器名称

取值范围:

字符长度0-255位

image_name

String

参数解释:

镜像名称

取值范围:

字符长度0-255位

status

String

参数解释:

容器状态

取值范围:

  • Running：运行中。

  • Terminated：终止。

  • Waiting：等待。

create_time

Long

参数解释:

创建时间

取值范围:

取值0-4071095999000

cpu_limit

String

参数解释:

cpu限制

取值范围:

字符长度0-64位

memory_limit

String

参数解释:

内存限制

取值范围:

字符长度0-64位

restart_count

Integer

参数解释:

重启次数

取值范围:

取值0-20

pod_name

String

参数解释:

所属pod名称

取值范围:

字符长度0-64位

cluster_name

String

参数解释:

所属集群

取值范围:

字符长度0-64位

cluster_id

String

参数解释:

集群id

取值范围:

字符长度0-64位

cluster_type

String

参数解释:

集群类型

取值范围:

  • k8s：原生集群。

  • cce：CCE集群。

  • ali：阿里云集群。

  • tencent：腾讯云集群。

  • azure：微软云集群。

  • aws：亚马逊集群。

  • self_built_hw：华为云自建集群。

  • self_built_idc：IDC自建集群。

risky

Boolean

参数解释:

是否有风险

取值范围:

true和false，true代表有风险，false代表无风险

low_risk

Integer

参数解释:

低危风险数量

取值范围:

取值0-2147483647

medium_risk

Integer

参数解释:

中危风险数量

取值范围:

取值0-2147483647

high_risk

Integer

参数解释:

高危风险数量

取值范围:

取值0-2147483647

fatal_risk

Integer

参数解释:

致命风险数量

取值范围:

取值0-2147483647

请求示例

查询前10条容器名称为install-agent-ds的容器列表

GET https://{endpoint}/v5/{project_id}/container/kubernetes?offset=0&limit=10&enterprise_project_id=all_granted_eps&contianer_name=install-agent-ds

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "last_update_time" : 1710097200019,
  "data_list" : [ {
    "container_id" : "d7354abc9c18c68ab3e48e3481624125e415766b6d03eefc5770ff70c5391c8d",
    "container_name" : "node-exporter",
    "image_name" : "official/node-exporter:3.9.5",
    "status" : "Running",
    "create_time" : 1708453039000,
    "cpu_limit" : "500m",
    "memory_limit" : "1Gi",
    "restart_count" : 0,
    "pod_name" : "node-exporter-l4m75",
    "cluster_name" : "glz-hss",
    "cluster_id" : "352f4ef1-ce57-11ee-8cb3-0255ac100b0f",
    "cluster_type" : "cce",
    "risky" : false,
    "low_risk" : 0,
    "medium_risk" : 0,
    "high_risk" : 0,
    "fatal_risk" : 0
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 容器管理

相关文档