# Updating a Specified Node Pool

#### Function

This API is used to update a specified node pool.

- The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.
- Currently, only the node pool name and scaling parameters in spec can be updated, such as initialNodeCount, autoscaling, name, k8sTags, taints, login, and userTags.

#### URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}

Table 1 describes the parameters of this API.

Table 1 Parameter description
Parameter | Mandatory | Description
--- | --- | ---
project_id | Yes | Project ID. For details about how to obtain the project ID, see How to Obtain Parameters in the API URI.
cluster_id | Yes | Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI.
nodepool_id | Yes | Node pool ID. For details about how to obtain the node pool ID, see Listing All Node Pools in a Specified Cluster.

#### Request

Request parameters:

Table 2 and Table 3 lists the request parameters.

Table 2 Parameters in the request header
Parameter | Mandatory | String | Description
--- | --- | --- | ---
Content-Type | Yes | String | Message body type (format). Default: application/json
X-Auth-Token | Yes | String | Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details on how to obtain a user token, see API Usage Guidelines.

Table 3 NodePool structure
Parameter | Mandatory | Type | Description
--- | --- | --- | ---
kind | Yes | String | API type, which is fixed at NodePool.
apiVersion | Yes | String | API version, which is fixed at v3.
metadata | Yes | metadata object | Metadata of the node pool.
spec | Yes | spec object | Parameters of the node pool.

Table 4 Data structure of the metadata field
Parameter | Mandatory | Type | Description
--- | --- | --- | ---
name | Yes | String | Node pool name. Naming rule: Enter 1 to 50 characters that starts with a lowercase letter and cannot end with a hyphen (-). Lowercase letters, digits, and hyphens (-) are allowed. The value cannot be DefaultPool.

Table 5 Data structure of the spec field
Parameter | Mandatory | Type | Description
--- | --- | --- | ---
initialNodeCount | Yes | Integer | Expected number of nodes in this node pool. The value cannot be greater than the maximum number of nodes allowed for the cluster.

type

No

String

Node pool type. If this parameter is left blank, the value vm is used by default.

- vm: ECS
- ElasticBMS: BMS. This value is valid in CCE Turbo cluster.

autoscaling | No | autoscaling object | Auto scaling parameters.

nodeTemplate

Yes

nodeTemplate object

Parameters of the node pool template.

If az is set to random, when you create a node pool or update the number of nodes in a node pool, a scaling task is triggered. The system selects an AZ from all AZs where scaling is allowed to add nodes based on priorities.

AZs with a smaller number of existing nodes have a higher priority. If AZs have the same number of nodes, the system selects the AZ based on the AZ sequence. Example:

- Creating nodes in a node pool for the first time: Assume that AZ 1, AZ 2, and AZ 3 have available resources. These AZs have the same priority because they have no existing nodes. In this case, AZ 1 is selected by sequence to create all nodes to be added.
- Adding nodes to a node pool that already has nodes:
  - Assume that the node pool has 1 node in AZ 1, 3 in AZ 2, and 2 in AZ 3, and that resources in AZ 1 have been sold out. Only AZ 2 and AZ 3 are available for scaling. In this case, AZ 3 has a higher priority than AZ 2 because AZ 3 has less nodes. Therefore, all nodes to be added will be created in AZ 3.
  - Assume that the node pool has 1 node in AZ 1, 2 in AZ 2, and 2 in AZ 3, and that resources in AZ 1 have been sold out. Only AZ 2 and AZ 3 are available for scaling. In this case, AZ 2 and AZ 3 have the same priority because they have the same number of nodes. Therefore, all nodes to be added will be created in AZ 2.

Table 6 Data structure of the autoscaling field
Parameter | Mandatory | Type | Description
--- | --- | --- | ---
enable | No | Boolean | Whether to enable auto scaling.
minNodeCount | No | Integer | Minimum number of nodes after a scale-down if auto scaling is enabled.
maxNodeCount | No | Integer | Maximum number of nodes after a scale-up if auto scaling is enabled. The value of this parameter must be greater than or equal to that of minNodeCount and does not exceed the maximum number of nodes for the cluster.
scaleDownCooldownTime | No | Integer | Interval during which nodes added after a scale-up will not be deleted, in minutes.
priority | No | Integer | Node pool weight. A higher weight indicates a higher priority in scale-up.

Table 7 Data structure of the nodeTemplate field
Parameter | Mandatory | Type | Description
--- | --- | --- | ---

k8sTags

No

Object

Kubernetes label, in the format of key-value pair. A maximum of 20 key-value pairs are allowed.

- Key: Enter 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key and contain a maximum of 253 characters. Example DNS subdomain: example.com/my-key.
- Value: The value can be left blank or a string of 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed in the character string.

Example:

    "k8sTags": {
    	"key": "value"
    }

taints

No

Object

Taints added to the created node to set anti-affinity. The following three parameters are contained in every taint:

- Key: Enter 1 to 63 characters starting with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key.
- Value: The value can be a string of 1 to 63 characters starting with a letter or digit. Letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.
- Effect: Set it to NoSchedule, PreferNoSchedule, or NoExecute.

Example:

    "taints": [
    {
    	"key": "status",
    	"value": "unavailable",
    	"effect": "NoSchedule"
    },
    {
    	"key": "looks",
    	"value": "bad",
    	"effect": "NoSchedule"
    }]

Example request:

    {
        "kind": "NodePool",
        "apiVersion": "v3",
        "metadata": {
            "name": "nodepool-name-change",
            "uid": "feec6013-cd7e-11ea-8c7a-0255ac100be7"
        },
        "spec": {
            "initialNodeCount": 0,
            "type": "vm",
            "nodeTemplate": {
                "flavor": "s6.large.2",
                "az": "eu-de-01",
                "os": "EulerOS 2.5",
                "login": {
                    "sshKey": "KeyPair-nodepool",
                    "userPassword": {}
                },
                "rootVolume": {
                    "volumetype": "SATA",
                    "size": 40
                },
                "dataVolumes": [
                    {
                        "volumetype": "SATA",
                        "size": 100,
                        "extendParam": {
                            "useType": "docker"
                        }
                    }
                ],
                "publicIP": {
                    "eip": {
                        "bandwidth": {}
                    }
                },
                "nodeNicSpec": {
                    "primaryNic": {
                        "subnetId": "31be174a-0c7f-4b71-bb0d-d325fecb90ef"
                    }
                },
                "billingMode": 0,
                "taints": [
                    {
                        "key": "change-taints",
                        "value": "value1",
                        "effect": "NoExecute"
                    }
                ],
                "k8sTags": {
                    "change-tag": "value2"
                },
                "userTags": [
                    {
                        "key": "change-resource-tag",
                        "value": "value3"
                    }
                ],
                "extendParam": {
                    "DockerLVMConfigOverride": "dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear",
                    "alpha.cce/postInstall": "bHMgLWwK",
                    "alpha.cce/preInstall": "bHMgLWw=",
                    "maxPods": 110
                }
            },
            "autoscaling": {
                "enable": true,
                "minNodeCount": 2,
                "maxNodeCount": 4,
                "scaleDownCooldownTime": 10,
                "priority": 2
            },
            "nodeManagement": {
                "serverGroupReference": "2129f95a-f233-4cd8-a1b2-9c0acdf918d3"
            }
        },
        "status": {
            "currentNode": 0,
            "phase": ""
        }
    }

#### Response

Response parameters:

Table 18 describes the response parameters.

Response example:

    {
        "kind": "NodePool",
        "apiVersion": "v3",
        "metadata": {
            "name": "nodepool-name-change",
            "uid": "feec6013-cd7e-11ea-8c7a-0255ac100be7"
        },
        "spec": {
            "initialNodeCount": 0,
            "type": "vm",
            "nodeTemplate": {
                "flavor": "s6.large.2",
                "az": "eu-de-01",
                "os": "EulerOS 2.5",
                "login": {
                    "sshKey": "KeyPair-nodepool",
                    "userPassword": {}
                },
                "rootVolume": {
                    "volumetype": "SATA",
                    "size": 40
                },
                "dataVolumes": [
                    {
                        "volumetype": "SATA",
                        "size": 100,
                        "extendParam": {
                            "useType": "docker"
                        }
                    }
                ],
                "publicIP": {
                    "eip": {
                        "bandwidth": {}
                    }
                },
                "nodeNicSpec": {
                    "primaryNic": {
                        "subnetId": "31be174a-0c7f-4b71-bb0d-d325fecb90ef"
                    }
                },
                "billingMode": 0,
                "taints": [
                    {
                        "key": "change-taints",
                        "value": "value1",
                        "effect": "NoExecute"
                    }
                ],
                "k8sTags": {
                    "cce.cloud.com/cce-nodepool": "nodepool-name-change",
                    "change-tag": "value2"
                },
                "userTags": [
                    {
                        "key": "change-resource-tag",
                        "value": "value3"
                    }
                ],
                "extendParam": {
                    "DockerLVMConfigOverride": "dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear",
                    "alpha.cce/postInstall": "bHMgLWwK",
                    "alpha.cce/preInstall": "bHMgLWw=",
                    "maxPods": 110
                }
            },
            "autoscaling": {
                "enable": true,
                "minNodeCount": 2,
                "maxNodeCount": 4,
                "scaleDownCooldownTime": 10,
                "priority": 2
            },
            "nodeManagement": {
                "serverGroupReference": "2129f95a-f233-4cd8-a1b2-9c0acdf918d3"
            }
        },
        "status": {
            "currentNode": 0,
            "phase": ""
        }
    }

#### Status Code

Table 8 describes the status code of this API.

Table 8 Status code
Status Code | Description
--- | ---
200 | The specified node pool is updated successfully.

For details about error status codes, see Status Code.

Parent topic: Cluster Management