查询容器节点列表
功能介绍
查询容器节点列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/container/nodes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:2000000 缺省值:0 |
limit |
否 |
Integer |
每页显示个数 最小值:10 最大值:200 缺省值:10 |
host_name |
否 |
String |
节点名称 最小长度:0 最大长度:128 |
agent_status |
否 |
String |
Agent状态,包含如下3种。
最小长度:1 最大长度:32 |
protect_status |
否 |
String |
防护状态,包含如下2种。
最小长度:1 最大长度:32 |
container_tags |
否 |
String |
标签:用来识别cce容器节点和自建
最小长度:1 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 |
region |
是 |
String |
Region ID 最小长度:0 最大长度:128 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
容器节点总数 最小值:0 最大值:65535 |
data_list |
Array of ContainerNodeInfo objects |
容器节点列表 数组长度:0 - 65535 |
参数 |
参数类型 |
描述 |
---|---|---|
agent_id |
String |
Agent ID 最小长度:0 最大长度:64 |
host_id |
String |
服务器ID 最小长度:0 最大长度:128 |
host_name |
String |
节点名称 最小长度:0 最大长度:128 |
host_status |
String |
服务器状态,包含如下4种。
最小长度:1 最大长度:32 |
agent_status |
String |
Agent状态,包含如下3种。
最小长度:1 最大长度:32 |
protect_status |
String |
防护状态,包含如下2种。
最小长度:1 最大长度:32 |
protect_interrupt |
Boolean |
防护是否中断 |
container_tags |
String |
标签:用来识别cce容器节点和自建
最小长度:1 最大长度:32 |
private_ip |
String |
私有IP地址 最小长度:0 最大长度:128 |
public_ip |
String |
弹性公网IP地址 最小长度:0 最大长度:128 |
resource_id |
String |
主机安全配额ID(UUID) 最小长度:0 最大长度:128 |
group_name |
String |
服务器组名称 最小长度:1 最大长度:128 |
enterprise_project_name |
String |
所属企业项目名称 最小长度:0 最大长度:256 |
detect_result |
String |
云主机安全检测结果,包含如下4种。
最小长度:1 最大长度:32 |
asset |
Integer |
资产风险 最小值:0 最大值:2097152 |
vulnerability |
Integer |
漏洞风险 最小值:0 最大值:2097152 |
intrusion |
Integer |
入侵风险 最小值:0 最大值:2097152 |
policy_group_id |
String |
策略组ID 最小长度:1 最大长度:128 |
policy_group_name |
String |
策略组名称 最小长度:1 最大长度:128 |
请求示例
查询容器节点列表,不传limit参数默认返回10条。
GET https://{endpoint}/v5/{project_id}/container/nodes
响应示例
状态码: 200
容器节点列表
{ "total_num" : 1, "data_list" : [ { "agent_id" : "2d0fe7824005bf001220ad9d892e86f8af44XXXXXXXXXXX", "agent_status" : "online", "host_id" : "host_id", "host_name" : "host_name", "host_status" : "ACTIVE", "protect_status" : "opened", "protect_interrupt" : false, "private_ip" : "192.168.0.114", "public_ip" : "100.85.218.122", "resource_id" : "ef5eb4fd-7376-48ac-886f-16fd057776f3", "group_name" : "as(All projects)", "enterprise_project_name" : "default", "detect_result" : "risk", "asset" : 0, "vulnerability" : 14, "intrusion" : 0, "policy_group_id" : "ce4d5e95-0cbf-4102-9c77-ef1bcb6b35aa", "policy_group_name" : "tenant_linux_enterprise_default_policy_group (All projects)" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
容器节点列表 |
错误码
请参见错误码。