Help Center/ Cloud Container Engine/ API Reference/ APIs/ Configuration Management/ Changing the Values of Configuration Parameters of a Node Pool
Updated on 2026-09-08 GMT+08:00

Changing the Values of Configuration Parameters of a Node Pool

Function

This API is used to change the values of parameter configurations of a node pool in the CCE cluster.

Calling Method

For details, see Calling APIs.

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

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

cluster_id

Yes

String

Details:

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

nodepool_id

Yes

String

Details:

Node pool ID. For details about how to obtain the ID, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition:

Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any.

Constraints:

GET requests are not validated.

Range:

N/A

Default Value:

N/A

X-Auth-Token

Yes

String

Details:

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, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

apiVersion

Yes

String

Definition:

API version. The value is fixed at v3.

Constraints:

The value is fixed.

Range:

  • v3

Default Value:

v3

kind

Yes

String

Definition:

API type. The value is fixed at Configuration.

Constraints:

The value is fixed.

Range:

  • Configuration

Default Value:

Configuration

metadata

Yes

ConfigurationMetadata object

Definition:

Metadata of Configuration

Constraints:

N/A

Range:

N/A

Default Value:

N/A

spec

Yes

ClusterConfigurationsSpec object

Definition:

Spec of Configuration

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 4 ConfigurationMetadata

Parameter

Mandatory

Type

Description

name

Yes

String

Definition:

Configuration name

Constraints:

N/A

Range:

N/A

Default Value:

N/A

labels

No

Map<String,String>

Definition:

A configuration label in a key-value pair.

  • Key: The key must contain a maximum of 63 characters that start with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key, for example, example.com/my-key, and contain a maximum of 253 characters.

  • Value: The value can be left empty or contain a maximum of 63 characters that start and end with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Example: "foo": "bar"

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 5 ClusterConfigurationsSpec

Parameter

Mandatory

Type

Description

packages

Yes

Array of packages objects

Definition:

Component configuration item list

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 6 packages

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Component name

Constraints:

N/A

Range:

N/A

Default Value:

N/A

configurations

No

Array of ConfigurationItem objects

Definition:

Details about component configuration items

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Table 7 ConfigurationItem

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Component configuration parameters.

For details about the components and parameters that can be configured for the current cluster, see Modifying CCE Cluster Configurations. For details about the components and parameters that can be configured for the current node pool, see Modifying Node Pool Configurations.

Constraints:

If you specify a component or parameter that is not supported, the configuration item will be ignored.

Options:

N/A

Default value:

N/A

value

No

Object

Definition:

Values of component configuration parameters.

For details about the components and parameters that can be configured for the current cluster, see Modifying CCE Cluster Configurations. For details about the components and parameters that can be configured for the current node pool, see Modifying Node Pool Configurations.

Constraints:

If you specify a component or parameter that is not supported, the configuration item will be ignored.

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

apiVersion

String

Definition:

API version. The value is fixed at v3.

Range:

  • v3

kind

String

Definition:

API type. The value is fixed at Configuration.

Range:

  • Configuration

metadata

ConfigurationMetadata object

Definition:

Metadata of Configuration

Range:

N/A

spec

ClusterConfigurationsSpec object

Definition:

Spec of Configuration

Range:

N/A

status

Object

Definition:

Status of Configuration

Range:

N/A

Table 9 ConfigurationMetadata

Parameter

Type

Description

name

String

Definition:

Configuration name

Range:

N/A

labels

Map<String,String>

Definition:

A configuration label in a key-value pair.

  • Key: The key must contain a maximum of 63 characters that start with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. A DNS subdomain can be prefixed to a key, for example, example.com/my-key, and contain a maximum of 253 characters.

  • Value: The value can be left empty or contain a maximum of 63 characters that start and end with a letter or digit. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed.

Example: "foo": "bar"

Range:

N/A

Table 10 ClusterConfigurationsSpec

Parameter

Type

Description

packages

Array of packages objects

Definition:

Component configuration item list

Range:

N/A

Table 11 packages

Parameter

Type

Description

name

String

Definition:

Component name

Range:

N/A

configurations

Array of ConfigurationItem objects

Definition:

Details about component configuration items

Range:

N/A

Table 12 ConfigurationItem

Parameter

Type

Description

name

String

Definition:

Component configuration parameters.

For details about the components and parameters that can be configured for the current cluster, see Modifying CCE Cluster Configurations. For details about the components and parameters that can be configured for the current node pool, see Modifying Node Pool Configurations.

Options:

N/A

Default value:

N/A

value

Object

Definition:

Values of component configuration parameters.

For details about the components and parameters that can be configured for the current cluster, see Modifying CCE Cluster Configurations. For details about the components and parameters that can be configured for the current node pool, see Modifying Node Pool Configurations.

Options:

N/A

Default value:

N/A

Example Requests

The following example describes how to update the system-reserved-mem and kube-reserved-mem parameters in kubelet.

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

{
  "kind" : "Configuration",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "configuration"
  },
  "spec" : {
    "packages" : [ {
      "name" : "kubelet",
      "configurations" : [ {
        "name" : "system-reserved-mem",
        "value" : 600
      }, {
        "name" : "kube-reserved-mem",
        "value" : 800
      } ]
    } ]
  }
}

Example Responses

Status code: 200

The parameter configurations of the node pool are updated successfully.

{
  "kind" : "Configuration",
  "apiVersion" : "v3",
  "metadata" : {
    "name" : "configuration",
    "labels" : {
      "nodepool_id" : "61de338d-a1f9-11ed-8891-0255ac100036"
    }
  },
  "spec" : {
    "packages" : [ {
      "name" : "kube-apiserver",
      "configurations" : [ {
        "name" : "event-rate-limit-qps",
        "value" : 200
      }, {
        "name" : "support-overload",
        "value" : false
      } ]
    }, {
      "name" : "kube-scheduler",
      "configurations" : [ {
        "name" : "kube-api-qps",
        "value" : 100
      }, {
        "name" : "default-scheduler",
        "value" : "kube-scheduler"
      } ]
    } ]
  },
  "status" : { }
}

SDK Sample Code

The SDK sample code is as follows.

The following example describes how to update the system-reserved-mem and kube-reserved-mem parameters in kubelet.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateNodePoolConfigurationSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateNodePoolConfigurationRequest request = new UpdateNodePoolConfigurationRequest();
        request.withClusterId("{cluster_id}");
        request.withNodepoolId("{nodepool_id}");
        UpdateClusterConfigurationsBody body = new UpdateClusterConfigurationsBody();
        List<ConfigurationItem> listPackagesConfigurations = new ArrayList<>();
        listPackagesConfigurations.add(
            new ConfigurationItem()
                .withName("system-reserved-mem")
                .withValue("600")
        );
        listPackagesConfigurations.add(
            new ConfigurationItem()
                .withName("kube-reserved-mem")
                .withValue("800")
        );
        List<ClusterConfigurationsSpecPackages> listSpecPackages = new ArrayList<>();
        listSpecPackages.add(
            new ClusterConfigurationsSpecPackages()
                .withName("kubelet")
                .withConfigurations(listPackagesConfigurations)
        );
        ClusterConfigurationsSpec specbody = new ClusterConfigurationsSpec();
        specbody.withPackages(listSpecPackages);
        ConfigurationMetadata metadatabody = new ConfigurationMetadata();
        metadatabody.withName("configuration");
        body.withSpec(specbody);
        body.withMetadata(metadatabody);
        body.withKind("Configuration");
        body.withApiVersion("v3");
        request.withBody(body);
        try {
            UpdateNodePoolConfigurationResponse response = client.updateNodePoolConfiguration(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

The following example describes how to update the system-reserved-mem and kube-reserved-mem parameters in kubelet.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateNodePoolConfigurationRequest()
        request.cluster_id = "{cluster_id}"
        request.nodepool_id = "{nodepool_id}"
        listConfigurationsPackages = [
            ConfigurationItem(
                name="system-reserved-mem",
                value="600"
            ),
            ConfigurationItem(
                name="kube-reserved-mem",
                value="800"
            )
        ]
        listPackagesSpec = [
            ClusterConfigurationsSpecPackages(
                name="kubelet",
                configurations=listConfigurationsPackages
            )
        ]
        specbody = ClusterConfigurationsSpec(
            packages=listPackagesSpec
        )
        metadatabody = ConfigurationMetadata(
            name="configuration"
        )
        request.body = UpdateClusterConfigurationsBody(
            spec=specbody,
            metadata=metadatabody,
            kind="Configuration",
            api_version="v3"
        )
        response = client.update_node_pool_configuration(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

The following example describes how to update the system-reserved-mem and kube-reserved-mem parameters in kubelet.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cce.CceClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cce.NewCceClient(hcClient)

    request := &model.UpdateNodePoolConfigurationRequest{}
	request.ClusterId = "{cluster_id}"
	request.NodepoolId = "{nodepool_id}"
	nameConfigurations:= "system-reserved-mem"
	valueConfigurations:= "600"
	var valueConfigurationsInterface interface{} = valueConfigurations
	nameConfigurations1:= "kube-reserved-mem"
	valueConfigurations1:= "800"
	var valueConfigurationsInterface1 interface{} = valueConfigurations1
	var listConfigurationsPackages = []model.ConfigurationItem{
        {
            Name: &nameConfigurations,
            Value: &valueConfigurationsInterface,
        },
        {
            Name: &nameConfigurations1,
            Value: &valueConfigurationsInterface1,
        },
    }
	namePackages:= "kubelet"
	var listPackagesSpec = []model.ClusterConfigurationsSpecPackages{
        {
            Name: &namePackages,
            Configurations: &listConfigurationsPackages,
        },
    }
	specbody := &model.ClusterConfigurationsSpec{
		Packages: listPackagesSpec,
	}
	metadatabody := &model.ConfigurationMetadata{
		Name: "configuration",
	}
	request.Body = &model.UpdateClusterConfigurationsBody{
		Spec: specbody,
		Metadata: metadatabody,
		Kind: "Configuration",
		ApiVersion: "v3",
	}
	response, err := client.UpdateNodePoolConfiguration(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The parameter configurations of the node pool are updated successfully.

Error Codes

See Error Codes.