Help Center/ Host Security Service/ API Reference/ API Description/ Container Network Isolation Information/ Querying the Node List of a Container Cluster VPC Network
Updated on 2026-04-03 GMT+08:00

Querying the Node List of a Container Cluster VPC Network

Function

This API is used to query the node list of a container cluster network.

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-network/{cluster_id}/node

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

cluster_id

Yes

String

Specifies the cluster ID.

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.

limit

Yes

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10 to 200

Default Value

10

offset

Yes

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

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

Default Value

N/A

query_field

No

String

Field

query_value

No

String

Query field value.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

last_update_time

Long

Latest data synchronization time

data_list

Array of NetworkNodeInfo objects

Network node list.

Table 5 NetworkNodeInfo

Parameter

Type

Description

id

String

Node ID.

name

String

Node

status

String

Status

ip_addr

String

IP address

ipv6_addr

String

IPv6 address.

private_ip_addr

String

Private IP address

private_ipv6_addr

String

Private IPv6 address

runtime_version

String

Runtime version

os_version

String

OS version

security_group

String

Security group

server_id

String

Server ID.

server_type

String

Server type

Example Requests

Grants permission to query the node list of the VPC of a container cluster.

GET https://{endpoint}/v5/{project_id}/container-network/{cluster_id}/node?limit=10&offset=0&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "last_update_time" : 1757900763234,
  "data_list" : [ {
    "id" : "0255ac100b03",
    "name" : "assets-test-51208",
    "status" : "Active",
    "ip_addr" : "100.85.118.255",
    "ipv6_addr" : "2001:DB8::2AA:FF:C0A8:640A",
    "private_ip_addr" : "192.168.0.59",
    "private_ipv6_addr" : "2001:DB8::2AA:FF:C0A8:640A",
    "runtime_version" : "containerd",
    "os_version" : "Huawei Cloud EulerOS 2.0",
    "security_group" : "assets-test-cce-node-tfzg2",
    "server_id" : "7b7b819e-2cee-40ec-a7a1-c5f66d208613",
    "server_type" : "ecs"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.