查询容器Kubernetes集群列表 - ListKubernetesClusterDetails
功能介绍
查询容器Kubernetes集群列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/kubernetes/clusters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
cluster_name |
否 |
String |
集群名称 |
|
load_agent_info |
否 |
Boolean |
是否加载agent相关信息，默认false |
|
scene |
否 |
String |
查询场景类型，包含如下： -cluster_risk : 集群风险场景 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
last_update_time |
Long |
最近更新时间 |
|
total_num |
Integer |
集群总数 |
|
cluster_info_list |
Array of KubernetesClusterInfo objects |
集群列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
id |
|
cluster_name |
String |
集群名称 |
|
cluster_id |
String |
集群ID |
|
cluster_type |
String |
参数解释: 集群类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
status |
String |
参数解释: 集群状态(11种) 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
version |
String |
集群版本 |
|
total_nodes_number |
Integer |
节点总数 |
|
active_nodes_number |
Integer |
正常节点数 |
|
creation_timestamp |
Long |
创建时间戳 |
|
agent_installed_num |
Integer |
集群下已安装agent节点数 |
|
agent_install_failed_num |
Integer |
集群下安装失败节点数 |
|
agent_not_install_num |
Integer |
集群下未安装agent节点数 |
|
agent_ds_install_status |
String |
集群下agent-ds安装状态，关联agent相关信息时则需同时考虑last_operate_time时间，包含如下2种。
|
|
agent_ds_failed_reason |
String |
操作失败原因 |
|
last_operate_timestamp |
Long |
最近操作时间戳，daemonset脚本安装操作时间，间隔10分钟以内时，agent仍处于安装中 |
|
last_scan_time |
Long |
集群最近一次扫描时间戳 |
|
sys_vul_num |
Integer |
集群下系统漏洞个数 |
|
app_vul_num |
Integer |
集群下应用漏洞个数 |
|
emg_vul_num |
Integer |
集群下应急漏洞个数 |
|
risk_assess_num |
Integer |
集群下风险评估问题个数 |
|
sec_comp_num |
Integer |
集群下安全合规问题个数 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 21,
"last_update_time" : 1744311874662,
"cluster_info_list" : [ {
"id" : "1aee3ca1-69f0-4390-a7e5-adcf90e4728f",
"cluster_name" : "yescrypt",
"cluster_id" : "1aee3ca1-69f0-4390-a7e5-adcf90e4728f",
"cluster_type" : "self_built_hw",
"status" : "Available",
"total_nodes_number" : 0,
"active_nodes_number" : 0,
"reation_timestamp" : 1743575464217
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
