文档首页/ 云容器引擎 CCE/ API参考/ API/ 配置管理/ 修改指定节点池配置参数的值
更新时间:2024-12-17 GMT+08:00
分享

修改指定节点池配置参数的值

功能介绍

该API用于修改CCE服务下指定节点池配置参数的值。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

nodepool_id

String

参数解释:

节点池ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

节点池ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)

约束限制:

GET方法不做校验

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data(注:存在FormData参数时使用)

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

apiVersion

String

API版本,固定值v3

kind

String

API类型,固定值Configuration

metadata

ConfigurationMetadata object

Configuration的元数据信息

spec

ClusterConfigurationsSpec object

Configuration的规格信息

表4 ConfigurationMetadata

参数

是否必选

参数类型

描述

name

String

Configuration名称

labels

Map<String,String>

Configuration标签,key/value对格式。

  • Key:必须以字母或数字开头,可以包含字母、数字、连字符、下划线和点,最长63个字符;另外可以使用DNS子域作为前缀,例如example.com/my-key,DNS子域最长253个字符。

  • Value:可以为空或者非空字符串,非空字符串必须以字符或数字开头和结尾,可以包含字母、数字、连字符、下划线和点,最长63个字符。

示例:"foo": "bar"

表5 ClusterConfigurationsSpec

参数

是否必选

参数类型

描述

packages

Array of packages objects

组件配置项列表

表6 packages

参数

是否必选

参数类型

描述

name

String

组件名称

configurations

Array of ConfigurationItem objects

组件配置项详情

表7 ConfigurationItem

参数

是否必选

参数类型

描述

name

String

参数解释:

覆盖集群默认组件配置。

当前支持的可配置组件及其参数详见配置管理

约束限制:

若指定了不支持的组件或组件不支持的参数,该配置项将被忽略。

取值范围:

不涉及

默认取值:

不涉及

value

AnyType

参数解释:

覆盖集群默认组件配置。

当前支持的可配置组件及其参数详见配置管理

约束限制:

若指定了不支持的组件或组件不支持的参数,该配置项将被忽略。

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本

kind

String

API类型,固定值Configuration

metadata

ConfigurationMetadata object

Configuration的元数据信息

spec

ClusterConfigurationsSpec object

Configuration的规格信息

status

Object

Configuration的状态信息

表9 ConfigurationMetadata

参数

参数类型

描述

name

String

Configuration名称

labels

Map<String,String>

Configuration标签,key/value对格式。

  • Key:必须以字母或数字开头,可以包含字母、数字、连字符、下划线和点,最长63个字符;另外可以使用DNS子域作为前缀,例如example.com/my-key,DNS子域最长253个字符。

  • Value:可以为空或者非空字符串,非空字符串必须以字符或数字开头和结尾,可以包含字母、数字、连字符、下划线和点,最长63个字符。

示例:"foo": "bar"

表10 ClusterConfigurationsSpec

参数

参数类型

描述

packages

Array of packages objects

组件配置项列表

表11 packages

参数

参数类型

描述

name

String

组件名称

configurations

Array of ConfigurationItem objects

组件配置项详情

表12 ConfigurationItem

参数

参数类型

描述

name

String

参数解释:

覆盖集群默认组件配置。

当前支持的可配置组件及其参数详见配置管理

约束限制:

若指定了不支持的组件或组件不支持的参数,该配置项将被忽略。

取值范围:

不涉及

默认取值:

不涉及

value

AnyType

参数解释:

覆盖集群默认组件配置。

当前支持的可配置组件及其参数详见配置管理

约束限制:

若指定了不支持的组件或组件不支持的参数,该配置项将被忽略。

取值范围:

不涉及

默认取值:

不涉及

请求示例

更新kubelet中的system-reserved-mem参数和kube-reserved-mem参数

/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
      } ]
    } ]
  }
}

响应示例

状态码: 200

表示更新指定节点池配置参数内容成功。

{
  "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代码示例

SDK代码示例如下。

更新kubelet中的system-reserved-mem参数和kube-reserved-mem参数

 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());
        }
    }
}

更新kubelet中的system-reserved-mem参数和kube-reserved-mem参数

 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)

更新kubelet中的system-reserved-mem参数和kube-reserved-mem参数

 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

表示更新指定节点池配置参数内容成功。

错误码

请参见错误码

相关文档