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

查询容器详细信息 - ShowK8sContainerDetail

功能介绍

查询容器详细信息

授权信息

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

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

URI

GET /v5/{project_id}/kubernetes/container/detail

表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_id

是

String

容器ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

service_name

String

服务名称

service_username

String

服务用户名

service_password

String

服务密码

service_port_list

Array of ServicePortInfo objects

容器各服务端口信息

enable_simulate

String

数据仿真，默认关闭。开启后将在沙箱中注入仿真数据

  • open : 开启

  • close : 关闭

hosts

String

沙箱域名，域名之间使用 ',' 隔开

extra

ContainerExtraInfo object

沙箱额外配置，包括VPN引流沙箱、linux沙箱、RDP沙箱、mysql沙箱，其他沙箱默认为空
表5 ServicePortInfo

参数

参数类型

描述

desc

String

服务名称

type

String

参数解释:

类型

约束限制:

不涉及

取值范围:

  • http：http类端口

  • https：https类端口

默认取值:

不涉及

protocol

String

默认tcp。可取值集合[tcp，udp]

user_port

Integer

用户端口

port

Integer

容器内部端口
表6 ContainerExtraInfo

参数

参数类型

描述

openvpn

ContainerExtraOpenvpnInfo object

沙箱类型，VPN引流沙箱专用

linux

ContainerExtraLinuxInfo object

沙箱类型，linux沙箱专用

rdp

ContainerExtraRdpInfo object

沙箱类型，RDP沙箱专用

mysql

ContainerExtraMysqlInfo object

沙箱类型，MYSQL、MYSQLCHEAT沙箱专用
表7 ContainerExtraOpenvpnInfo

参数

参数类型

描述

outside_ip

String

映射ip

outside_port

String

映射端口
表8 ContainerExtraLinuxInfo

参数

参数类型

描述

os

String

操作系统:

  • ubt : ubuntu

  • centos : centos

  • debian

  • redhat

  • opensuse

  • kylin

  • uos

  • euleros
表9 ContainerExtraRdpInfo

参数

参数类型

描述

proto_env

String

协议类型:

  • 0 : 协议模拟

  • 1 : 系统模拟

system

String

系统类型，系统模拟时使用:

  • win7 : win 7

  • win8 : win 8

  • win10 : win 10

  • win-server2012 : win-server 2012

  • win-server2016 : win-server 2016
表10 ContainerExtraMysqlInfo

参数

参数类型

描述

custom_path

String

自定义反制路径

请求示例

无

响应示例

状态码：200

请求已成功

{
  "container_id" : "19031ec457570cce64f789a57ce6551509c5ac95836c196a1e34e67232da5744",
  "container_name" : "k8s_POD_hostguard-w4x9h_hss_64732fbe-475c-4f1d-a728-fa4bdd22496f_0",
  "status" : "Running",
  "create_time" : 1742184403735,
  "image_name" : "cce-pause",
  "image_id" : "sha256:c96088c71666e3aa61a2659a1e6b533d5ea286d8f370f3b2088b102e9c595042",
  "pod_name" : "",
  "command\"" : "/pause",
  "cluster_name" : ""
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 容器管理

相关文档