Querying the Container Node List

Function

This API is used to query the container node list.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/container/nodes

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
offset	No	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
limit	No	Integer	Number of records displayed on each page.
host_name	No	String	Node name.
agent_status	No	String	Agent status. It can be: not_installed: online offline
protect_status	No	String	Protection status. Its value can be: closed opened
container_tags	No	String	Label, which is used to identify CCE container and self-built nodes. cce: CCE nodes self: self-built nodes other: other nodes

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number of container nodes
data_list	Array of ContainerNodeInfo objects	Container node list

**Table 5** ContainerNodeInfo
Parameter	Type	Description
agent_id	String	Agent ID
host_id	String	Server ID
host_name	String	Node name
host_status	String	Server status. The options are as follows: ACTIVE SHUTOFF BUILDING ERROR
agent_status	String	Agent status. It can be: not_installed online offline
protect_status	String	Protection status. Its value can be: closed opened
protect_interrupt	Boolean	Whether protection is interrupted
protect_degradation	Boolean	Whether the protection is degraded
degradation_reason	String	Protection degradation causes
container_tags	String	Label, which is used to identify CCE container and self-built nodes. cce: CCE nodes self: self-built nodes other: other nodes
private_ip	String	Private IP address
public_ip	String	Elastic IP Address (EIP)
resource_id	String	HSS quota ID (UUID)
group_name	String	Server group ID
enterprise_project_name	String	Enterprise project name
detect_result	String	Server scan result. The options are as follows: undetected clean: No risk is detected. risk: Risks are detected. scanning
asset	Integer	Asset risks
vulnerability	Integer	Vulnerabilities
intrusion	Integer	Intrusion risks
policy_group_id	String	Policy group ID
policy_group_name	String	Policy group name

Example Requests

This API is used to query the container node list. If the limit parameter is not set, 10 records are returned by default.

GET https://{endpoint}/v5/{project_id}/container/nodes

Example Responses

Status code: 200

success response

{
  "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_intrrupt" : 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)"
  } ]
}