文档首页/ 云容器引擎 CCE/ API参考/ API/ 节点池管理/ 伸缩节点池
更新时间：2024-11-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

伸缩节点池

功能介绍

该API用于伸缩指定的节点池

集群管理的URL格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径

调用方法

请参见如何调用API。

URI

POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodepools/{nodepool_id}/operation/scale

表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

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

kind

是

String

API类型，固定值“NodePool”。

apiVersion

是

String

API版本，固定值“v3”。

spec

是

ScaleNodePoolSpec object

伸缩节点池请求详细参数
表4 ScaleNodePoolSpec

参数

是否必选

参数类型

描述

desiredNodeCount

是

Integer

节点池期望节点数

scaleGroups

是

Array of strings

扩缩容的节点池，只能填一个伸缩组，如果要伸缩默认伸缩组填default

options

否

ScaleNodePoolOptions object

节点池伸缩选项配置
表5 ScaleNodePoolOptions

参数

是否必选

参数类型

描述

scalableChecking

否

String

扩容状态检查策略: instant(同步检查), async(异步检查)。默认同步检查instant

billingConfigOverride

否

ScaleUpBillingConfigOverride object

节点池扩容时覆盖节点的默认计费模式配置
表6 ScaleUpBillingConfigOverride

参数

是否必选

参数类型

描述

billingMode

是

Integer

节点计费类型，0(按需)，1(包周期)

extendParam

否

ScaleUpExtendParam object

节点池扩容时节点的计费配置
表7 ScaleUpExtendParam

参数

是否必选

参数类型

描述

periodNum

是

Integer

包周期时长, 包月1-9, 包年1-3

periodType

是

String

包周期类型, year(包年), month(包月)

isAutoRenew

否

Boolean

是否自动续费，可选参数，如果不填写，以节点池isAutoRenew属性为准。

isAutoPay

否

Boolean

是否自动付费，可选参数，如果不填写，以节点池isAutoPay属性为准。

响应参数

无

请求示例

  • 扩容节点池默认伸缩组(按需)

    {
  "kind" : "NodePool",
  "apiVersion" : "v3",
  "spec" : {
    "desiredNodeCount" : 1,
    "scaleGroups" : [ "default" ]
  }
}

  • 扩容节点池默认伸缩组(包年包月)

    {
  "kind" : "NodePool",
  "apiVersion" : "v3",
  "spec" : {
    "desiredNodeCount" : 1,
    "scaleGroups" : [ "default" ],
    "options" : {
      "billingConfigOverride" : {
        "billingMode" : 1,
        "extendParam" : {
          "periodNum" : 1,
          "periodType" : "month",
          "isAutoRenew" : false,
          "isAutoPay" : false
        }
      }
    }
  }
}

响应示例

无

SDK代码示例

SDK代码示例如下。

  • 扩容节点池默认伸缩组(按需)

     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
    		 
    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 ScaleNodePoolSolution {

    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();
        ScaleNodePoolRequest request = new ScaleNodePoolRequest();
        request.withClusterId("{cluster_id}");
        request.withNodepoolId("{nodepool_id}");
        ScaleNodePoolRequestBody body = new ScaleNodePoolRequestBody();
        List<String> listSpecScaleGroups = new ArrayList<>();
        listSpecScaleGroups.add("default");
        ScaleNodePoolSpec specbody = new ScaleNodePoolSpec();
        specbody.withDesiredNodeCount(1)
            .withScaleGroups(listSpecScaleGroups);
        body.withSpec(specbody);
        body.withApiVersion("v3");
        body.withKind("NodePool");
        request.withBody(body);
        try {
            ScaleNodePoolResponse response = client.scaleNodePool(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());
        }
    }
}

  • 扩容节点池默认伸缩组(包年包月)

     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
    		 
    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 ScaleNodePoolSolution {

    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();
        ScaleNodePoolRequest request = new ScaleNodePoolRequest();
        request.withClusterId("{cluster_id}");
        request.withNodepoolId("{nodepool_id}");
        ScaleNodePoolRequestBody body = new ScaleNodePoolRequestBody();
        ScaleUpExtendParam extendParamBillingConfigOverride = new ScaleUpExtendParam();
        extendParamBillingConfigOverride.withPeriodNum(1)
            .withPeriodType("month")
            .withIsAutoRenew(false)
            .withIsAutoPay(false);
        ScaleUpBillingConfigOverride billingConfigOverrideOptions = new ScaleUpBillingConfigOverride();
        billingConfigOverrideOptions.withBillingMode(1)
            .withExtendParam(extendParamBillingConfigOverride);
        ScaleNodePoolOptions optionsSpec = new ScaleNodePoolOptions();
        optionsSpec.withBillingConfigOverride(billingConfigOverrideOptions);
        List<String> listSpecScaleGroups = new ArrayList<>();
        listSpecScaleGroups.add("default");
        ScaleNodePoolSpec specbody = new ScaleNodePoolSpec();
        specbody.withDesiredNodeCount(1)
            .withScaleGroups(listSpecScaleGroups)
            .withOptions(optionsSpec);
        body.withSpec(specbody);
        body.withApiVersion("v3");
        body.withKind("NodePool");
        request.withBody(body);
        try {
            ScaleNodePoolResponse response = client.scaleNodePool(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());
        }
    }
}

  • 扩容节点池默认伸缩组(按需)

     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
    		 
    # 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 = ScaleNodePoolRequest()
        request.cluster_id = "{cluster_id}"
        request.nodepool_id = "{nodepool_id}"
        listScaleGroupsSpec = [
            "default"
        ]
        specbody = ScaleNodePoolSpec(
            desired_node_count=1,
            scale_groups=listScaleGroupsSpec
        )
        request.body = ScaleNodePoolRequestBody(
            spec=specbody,
            api_version="v3",
            kind="NodePool"
        )
        response = client.scale_node_pool(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 扩容节点池默认伸缩组(包年包月)

     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
    		 
    # 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 = ScaleNodePoolRequest()
        request.cluster_id = "{cluster_id}"
        request.nodepool_id = "{nodepool_id}"
        extendParamBillingConfigOverride = ScaleUpExtendParam(
            period_num=1,
            period_type="month",
            is_auto_renew=False,
            is_auto_pay=False
        )
        billingConfigOverrideOptions = ScaleUpBillingConfigOverride(
            billing_mode=1,
            extend_param=extendParamBillingConfigOverride
        )
        optionsSpec = ScaleNodePoolOptions(
            billing_config_override=billingConfigOverrideOptions
        )
        listScaleGroupsSpec = [
            "default"
        ]
        specbody = ScaleNodePoolSpec(
            desired_node_count=1,
            scale_groups=listScaleGroupsSpec,
            options=optionsSpec
        )
        request.body = ScaleNodePoolRequestBody(
            spec=specbody,
            api_version="v3",
            kind="NodePool"
        )
        response = client.scale_node_pool(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • 扩容节点池默认伸缩组(按需)

     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
    		 
    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.ScaleNodePoolRequest{}
	request.ClusterId = "{cluster_id}"
	request.NodepoolId = "{nodepool_id}"
	var listScaleGroupsSpec = []string{
        "default",
    }
	specbody := &model.ScaleNodePoolSpec{
		DesiredNodeCount: int32(1),
		ScaleGroups: listScaleGroupsSpec,
	}
	request.Body = &model.ScaleNodePoolRequestBody{
		Spec: specbody,
		ApiVersion: "v3",
		Kind: "NodePool",
	}
	response, err := client.ScaleNodePool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 扩容节点池默认伸缩组(包年包月)

     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
    		 
    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.ScaleNodePoolRequest{}
	request.ClusterId = "{cluster_id}"
	request.NodepoolId = "{nodepool_id}"
	isAutoRenewExtendParam:= false
	isAutoPayExtendParam:= false
	extendParamBillingConfigOverride := &model.ScaleUpExtendParam{
		PeriodNum: int32(1),
		PeriodType: "month",
		IsAutoRenew: &isAutoRenewExtendParam,
		IsAutoPay: &isAutoPayExtendParam,
	}
	billingConfigOverrideOptions := &model.ScaleUpBillingConfigOverride{
		BillingMode: int32(1),
		ExtendParam: extendParamBillingConfigOverride,
	}
	optionsSpec := &model.ScaleNodePoolOptions{
		BillingConfigOverride: billingConfigOverrideOptions,
	}
	var listScaleGroupsSpec = []string{
        "default",
    }
	specbody := &model.ScaleNodePoolSpec{
		DesiredNodeCount: int32(1),
		ScaleGroups: listScaleGroupsSpec,
		Options: optionsSpec,
	}
	request.Body = &model.ScaleNodePoolRequestBody{
		Spec: specbody,
		ApiVersion: "v3",
		Kind: "NodePool",
	}
	response, err := client.ScaleNodePool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

202

表示节点池伸缩已经被接受，节点池将根据伸缩后的节点池期望节点数增加或者删除节点池中的节点

错误码

请参见错误码。

父主题： 节点池管理