Obtaining Node Pools

Function

This API is used to obtain the list of a specified node pool. This API is used when you need to obtain the details about a node pool, such as the configuration, status, or resource management. Before using this API, ensure that the node pool exists and you have the administrator permissions. After the API is called, the system returns the node pool list, including the node pool ID, name, number of nodes, and status. If the node pool does not exist, the user does not have the permission to perform the operation, or the node pool is unavailable, the API will return an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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 /v2/{project_id}/pools/{pool_name}/nodepools

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: User project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A
pool_name	Yes	String	Definition: Resource pool name. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
apiVersion	String	Definition: API version. Range: *v2
kind	String	Definition: Resource type. Range: NodePoolList: node list
items	Array of NodePool objects	Definition: Node pool list.

**Table 3** NodePool
Parameter	Type	Description
apiVersion	String	Definition: API version. Range: v2
kind	String	Node pool type. The options are as follows: NodePool: node pool
metadata	NodePoolMetadata object	Definition: Node pool metadata.
spec	NodePoolSpec object	Definition: Node pool expectation.
status	NodePoolStatus object	Definition: Node pool status.

**Table 4** NodePoolMetadata
Parameter	Type	Description
name	String	Definition: Node pool name. You can specify the name. If not specified, the default name is used. Range: N/A

**Table 5** NodePoolSpec
Parameter	Type	Description
resources	PoolResource object	Definition: List of resources in a node pool, including resource flavors, quantity, and custom configurations. Range: N/A

**Table 6** PoolResource
Parameter	Type	Description
flavor	String	Definition: Resource flavor name, for example, modelarts.vm.gpu.t4u8. Range: N/A.
count	Integer	Definition: Committed specifications. Range: N/A.
maxCount	Integer	Definition: Elastic usage of the resource flavor. This parameter value is the same the count value in a physical pool. Range: N/A.
azs	Array of PoolNodeAz objects	Definition: AZ information of nodes in the resource pool.
nodePool	String	Definition: Node pool name, for example, nodePool-1. Range: N/A.
taints	Array of Taints objects	Definition: Taints to be added to nodes to set anti-affinity. This parameter cannot be specified for a non-privileged pool.
labels	Map<String,String>	Definition: Kubernetes label, in key-value pair format.
tags	Array of UserTags objects	Definition: Resource tag. This parameter cannot be specified for a non-privileged pool.
network	NodeNetwork object	Definition: Network configuration. This parameter cannot be specified for a non-privileged pool.
extendParams	ResourceExtendParams object	Definition: Custom configuration.
creatingStep	CreatingStep object	Definition: Information about batch creation.
rootVolume	RootVolume object	Definition: Information about the custom system disk (cloud hard disk).
dataVolumes	Array of DataVolumeItem objects	Definition: List of custom data disks (cloud hard disks).
volumeGroupConfigs	Array of VolumeGroupConfig objects	Definition: Advanced disk configuration. This parameter is mandatory when a custom data disk exists.
os	Os object	Definition: OS image information.

**Table 7** Taints
Parameter	Type	Description
key	String	Definition: Key. Range: N/A
value	String	Value.
effect	String	Effect.

**Table 8** UserTags
Parameter	Type	Description
key	String	Definition: Key. The value cannot start with CCE- or __type_baremetal. Range: N/A
value	String	Value.

**Table 9** NodeNetwork
Parameter	Type	Description
vpc	String	Definition: VPC ID. Range: N/A.
subnet	String	Definition: Subnet ID. Range: N/A.
securityGroups	Array of strings	Definition: Security group ID set.

**Table 10** ResourceExtendParams
Parameter	Type	Description
dockerBaseSize	String	Definition: Container image space of a node. Range: Specified: The default value of dockerBaseSize ranges from 50 to 500. However, the actual value is restricted by the container data disk size of the node. Unlimited: *dockerBaseSize="0, indicating that the container image space is not limited.
postInstall	String	Definition: Post-installation script. The entered value must be encoded using Base64. Range: N/A.
runtime	String	Definition: Container runtime. Range: docker: Container runtime. It is the most commonly used container engine, which is used to create and manage container instances based on container images. containerd: Industrial-grade container runtime. It focuses on container lifecycle management and is one of the core components at the bottom layer of Docker. It can also be deployed independently.
labelPolicyOnExistingNodes	String	Definition: Kubernetes label update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
taintPolicyOnExistingNodes	String	Definition: Kubernetes taint update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
tagPolicyOnExistingNodes	String	Definition: Resource tag update policy of existing nodes. If the value is empty, the existing nodes are updated by default. Range: refresh: Update. ignore: Do not update.
XParameterPlaneSubnet	String	Definition: Subnet ID used for data transmission on the parameter plane between physical clusters. The value cannot be the same as the node subnet or container subnet. Range: N/A.
nodePoolName	String	Definition: Name of the node pool specified by you. The value is a string of 2 to 50 characters, consisting of lowercase letters, hyphens (-), and digits. It must start with a lowercase letter and cannot end with a hyphen (-) or -default. Range: N/A.

**Table 11** CreatingStep
Parameter	Type	Description
step	Integer	Definition: Step of a supernode. Constraints: N/A Range: Only the step contained in the resource specification details is supported. Default Value: N/A
type	String	Definition: Batch creation type. Constraints: N/A Range: hyperinstance: supernode Default Value: N/A

**Table 12** RootVolume
Parameter	Type	Description
volumeType	String	Definition: Disk type.. Range: SSD: Ultra-high I/O disk GPSSD: General-purpose SSD SAS: High I/O disk
size	String	Definition: Disk size, in GiB. Range: N/A.

**Table 13** DataVolumeItem
Parameter	Type	Description
volumeType	String	Definition: Disk type.. Range: SSD: Ultra-high I/O disk GPSSD: General-purpose SSD SAS: High I/O disk
size	String	Definition: Disk size, in GiB. Range: N/A.
count	Integer	Definition: Number of disks. Range: N/A.
extendParams	VolumeExtendParams object	Definition: Custom disk configuration.

**Table 14** VolumeExtendParams
Parameter	Type	Description
volumeGroup	String	Definition: Name of a disk group, which is used to divide storage space. Range: vgpaas: container disk. default: common data disk, which is mounted in default mode. vguser: common data disk, which is mounted to a specified path. The group name varies depending on the path, for example, vguser1 and vguser2. vg-everest-localvolume-persistent: common data disk, which is used as the persistent storage volume. vg-everest-localvolume-ephemeral: common data disk, which is used as a temporary storage volume.

**Table 15** VolumeGroupConfig
Parameter	Type	Description
volumeGroup	String	Definition: Disk group name. Index of the volume group in the dataVolumes. Range: N/A.
dockerThinPool	Integer	Definition: Percentage of data disks designated as container disks. This parameter can be specified only when volumeGroup is vgpaas (container disk). Range: N/A.
lvmConfig	LvmConfig object	Definition: LVM configuration management.
types	Array of strings	Definition: Storage type. Options: volume: Cloud hard disk. When dataVolumes is specified, the default value is used. local: Local disk. This parameter must be specified when a local disk is used.

**Table 16** LvmConfig
Parameter	Type	Description
lvType	String	Definition: LVM write mode. Range: linear: Linear mode. striped: Striped mode in which multiple disks are used to form a strip to improve disk performance.
path	String	Definition: Disk mount path. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed. Range: N/A.

**Table 17** Os
Parameter	Type	Description
name	String	Definition: OS name and version, for example, EulorOS 2.5. This parameter can be left blank when a private image is specified. Range: N/A.
imageId	String	Definition: OS image ID. Range: N/A.
imageType	String	Definition: OS image type. This parameter must be specified when a private image is set. By default, the preset image is used. You do not need to specify this field. Range: private: private images "": The preset image is used.
autoMatch	String	Definition: Automatic OS image matching configuration. If this parameter is set, the optimal image is automatically selected, and this parameter is automatically cleared. Range: OS name and version, for example, EulorOS 2.5.

**Table 18** NodePoolStatus
Parameter	Type	Description
resources	resources object	Definition: Resources in different states in a node pool.

**Table 19** resources
Parameter	Type	Description
creating	PoolResourceFlavorCount object	Definition: Number of resources that are being created.
available	PoolResourceFlavorCount object	Definition: Number of available resources.
abnormal	PoolResourceFlavorCount object	Definition: Number of abnormal resources.
deleting	PoolResourceFlavorCount object	Definition: Number of resources that are being deleted.

**Table 20** PoolResourceFlavorCount
Parameter	Type	Description
flavor	String	Definition: Resource flavor ID. Range: N/A
count	Integer	Definition: Number of resource specification instances in a resource pool. Range: N/A
maxCount	Integer	Definition: Number of elastic resource specification instances in a resource pool. The value of this parameter in a physical pool is the same as that of count. Range: N/A
azs	Array of PoolNodeAz objects	Definition: AZ distribution of the resource specification instances to be created in a resource pool.
nodePool	String	Definition: Node pool ID. Range: N/A

**Table 21** PoolNodeAz
Parameter	Type	Description
az	String	Definition: AZ name. Range: N/A
count	Integer	Definition: Number of AZ resource instances. Range: N/A

Example Requests

Obtain node pools.

GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodepools

{ }

Example Responses

Status code: 200

OK.

{
  "kind" : "NodePoolList",
  "apiVersion" : "v2",
  "items" : [ {
    "kind" : "NodePool",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "modelarts.vm.2u4g.dcc-Default"
    },
    "spec" : {
      "resources" : {
        "nodePool" : "modelarts.vm.2u4g.dcc-Default",
        "flavor" : "modelarts.vm.2u4g.dcc",
        "count" : 1,
        "maxCount" : 1,
        "network" : {
          "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
          "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
          "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
        }
      }
    },
    "status" : {
      "resources" : {
        "available" : {
          "nodePool" : "modelarts.vm.2u4g.dcc-Default",
          "flavor" : "modelarts.vm.2u4g.dcc",
          "count" : 1,
          "maxCount" : 1,
          "azs" : [ {
            "az" : "cn-north-7c",
            "count" : 1
          } ]
        }
      }
    }
  }, {
    "kind" : "NodePool",
    "apiVersion" : "v2",
    "metadata" : {
      "name" : "nodepool-1"
    },
    "spec" : {
      "resources" : {
        "nodePool" : "nodepool-1",
        "flavor" : "modelarts.vm.2u4g.dcc",
        "count" : 1,
        "maxCount" : 1,
        "network" : {
          "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566",
          "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9",
          "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ]
        }
      }
    },
    "status" : {
      "resources" : {
        "available" : {
          "nodePool" : "nodepool-1",
          "flavor" : "modelarts.vm.2u4g.dcc",
          "count" : 1,
          "maxCount" : 1,
          "azs" : [ {
            "az" : "cn-north-7c",
            "count" : 1
          } ]
        }
      }
    }
  } ]
}