Help Center/Host Security Service/API Reference/API Description/Container Management/Querying the Container Node List
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the Container Node List

Function

This API is used to query the container node list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/container/nodes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

offset

No

Integer

Definition

Start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

0

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

host_name

No

String

Definition

Node name.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

agent_status

No

String

Definition

Agent status.

Constraints

N/A

Range

The options are as follows:

  • installed

  • not_installed

  • online

  • offline

  • install_failed

  • installing

Default Value

N/A

protect_status

No

String

Definition

Protection status.

Constraints

N/A

Range

The options are as follows:

  • closed

  • opened

Default Value

N/A

container_tags

No

String

Definition

Tag used to identify a CCE node or user-built node.

Constraints

N/A

Range

The options are as follows:

  • cce: CCE node

  • self: user-built node

  • other: other node

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 0 to 128 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number of container nodes.

Range

Value range: 0 to 65,535

data_list

Array of ContainerNodeInfo objects

Definition

Container node list.

Range

Value range: 0 to 65,535

Table 5 ContainerNodeInfo

Parameter

Type

Description

agent_id

String

Definition

Agent ID

Range

The value can contain 0 to 64 characters.

host_id

String

Definition

Server ID.

Range

The value can contain 0 to 128 characters.

host_name

String

Definition

Node name.

Range

The value can contain 0 to 128 characters.

host_status

String

Definition

Server status.

Range

The options are as follows:

  • ACTIVE: running

  • SHUTOFF: shut down

    • BUILDING: creating

    • ERROR: faulty

agent_status

String

Definition

Agent status.

Range

The options are as follows:

  • not_installed

  • online

  • offline

protect_status

String

Definition

Protection status.

Range

The options are as follows:

  • closed

  • opened

protect_interrupt

Boolean

Definition

Whether protection is interrupted.

Range

  • true: The protection is interrupted.

  • false: Protection is not interrupted.

protect_degradation

Boolean

Definition

Whether protection is degraded.

Range

  • true: The protection is degraded.

  • false: Protection is not degraded.

degradation_reason

String

Definition

Protection degradation cause.

Range

The value can contain 1 to 32 characters.

container_tags

String

Definition

Tag used to identify a CCE node or user-built node.

Range

The options are as follows:

  • cce: CCE node

  • self: user-built node

  • other: other node

private_ip

String

Definition

Private IP address.

Range

The value can contain 0 to 128 characters.

public_ip

String

Definition

EIP.

Range

The value can contain 0 to 128 characters.

resource_id

String

Definition

HSS quota ID (UUID).

Range

The value can contain 0 to 128 characters.

group_name

String

Definition

Server group name.

Range

The value can contain 1 to 128 characters.

enterprise_project_name

String

Definition

Enterprise project name.

Range

The value can contain 0 to 256 characters.

detect_result

String

Definition

Cloud server security scan result.

Range

The options are as follows:

  • undetected: not checked

  • clean: no risks detected

  • risk: risks detected

  • scanning: scan in progress

asset

Integer

Definition

Asset risks.

Range

Value range: 0 to 2,097,152

vulnerability

Integer

Definition

Vulnerability risks.

Range

Value range: 0 to 2,097,152

intrusion

Integer

Definition

Intrusion risks.

Range

Value range: 0 to 2,097,152

policy_group_id

String

Definition

Policy group ID.

Range

The value can contain 1 to 128 characters.

policy_group_name

String

Definition

Policy group name.

Range

The value can contain 1 to 128 characters.

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

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Management