文档首页/ 主机安全服务（新版）HSS/ API参考/ API说明/ 容器管理/ 查询容器基本信息列表
更新时间：2024-07-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询容器基本信息列表

功能介绍

查询容器基本信息列表

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/container/kubernetes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，查询所有企业项目时填写：all_granted_eps

缺省值：0

最小长度：1

最大长度：256

container_name

否

String

容器名称

最小长度：0

最大长度：128

pod_name

否

String

所属Pod名称

最小长度：0

最大长度：128

image_name

否

String

镜像名称

最小长度：0

最大长度：128

cluster_container

否

Boolean

是否是集群纳管的容器

缺省值：false

limit

否

Integer

每页显示个数

最小值：1

最大值：1000

缺省值：10

offset

否

Integer

偏移量：指定返回记录的开始位置

最小值：0

最大值：2000000

缺省值：0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户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
表5 ContainerBaseInfo

参数

参数类型

描述

container_id

String

容器ID

最小长度：0

最大长度：255

container_name

String

容器名称

最小长度：0

最大长度：255

image_name

String

镜像名称

最小长度：0

最大长度：255

status

String

容器状态，包含以下几种： -Running 运行中 -Terminated 终止 -Waiting 等待

最小长度：0

最大长度：64

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自建集群

最小长度：0

最大长度：255

risky

Boolean

是否有风险

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

容器基本信息列表

错误码

请参见错误码。

父主题： 容器管理

相关文档