文档首页> 容器安全服务 CGS> API参考> API说明> 容器管理> 查询容器节点列表
更新时间：2022-11-25 GMT+08:00
查看PDF
分享

查询容器节点列表

功能介绍

查询容器节点列表（仅新版本容器安全支持，即将上线，敬请期待！）

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v5/{project_id}/container/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

host_name

否

String

节点（服务器）名称

agent_status

否

String

Agent状态，包含如下3种。

  • not_installed ：未安装

  • online ：在线

  • offline ：离线

limit

否

Integer

查询返回查询容器节点列表当前页面的数，量默认10

offset

否

Integer

查询游标，初始传入0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

容器节点总数

data_list

Array of ContainerNodeInfo objects

容器节点列表
表5 ContainerNodeInfo

参数

参数类型

描述

host_id

String

节点id

host_name

String

节点（服务器）名称

host_status

String

服务器状态，包含如下4种。

  • ACTIVE ：正在运行。

  • SHUTOFF ：关机。

  • BUILDING ：创建中。

  • ERROR ：故障。

agent_status

String

Agent状态，包含如下3种。

  • not_register ：未注册。

  • online ：在线。

  • offline ：离线。

protect_status

String

防护状态，包含如下2种。

  • closed ：关闭。

  • opened ：开启。

请求示例

无

响应示例

状态码： 200

success response

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "caa958ad-a481-4d46-b51e-6861b8864515",
    "host_name" : "test",
    "host_status" : "ACTIVE",
    "agent_status" : "not_register",
    "protect_status" : "opened"
  } ]
}

状态码

状态码

描述

200

success response

错误码

请参见错误码。

父主题： 容器管理
分享：

    相关文档

    相关产品