文档首页/ 云搜索服务 CSS/ API参考/ API V1/ 集群管理/ 扩容实例的数量和存储容量
更新时间:2025-08-15 GMT+08:00

扩容实例的数量和存储容量

功能介绍

该接口用于集群扩容不同类型实例的个数以及存储容量。已经存在独立Master、Client、冷数据节点的集群使用该接口扩容。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法请参见获取项目ID和名称

约束限制

不涉及

取值范围

账户的项目ID。

默认取值

不涉及

cluster_id

String

参数解释

指定待扩容的集群ID。获取方法请参见获取集群ID

约束限制

不涉及

取值范围

集群ID。

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

grow

Array of RoleExtendGrowReq objects

参数解释

集群扩容请求详细描述。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

is_auto_pay

Integer

参数解释

是否自动支付。下单订购后,是否自动从客户的华为云账户中支付,而不需要客户手动去进行支付。

约束限制

该参数适用于包周期集群。

取值范围

  • 1:是(会自动选择折扣和优惠券进行优惠,然后自动从客户华为云账户中支付),自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”,等待客户手动支付(手动支付时,客户还可以修改系统自动选择的折扣和优惠券)。

  • 0:否(需要客户手动去支付,客户可以选择折扣和优惠券)。

默认取值

0

表3 RoleExtendGrowReq

参数

是否必选

参数类型

描述

type

String

参数解释

扩容实例类型。

约束限制

ess-master、ess-client节点只支持增加实例个数。

取值范围

  • ess:数据节点。

  • ess-master:Master节点。

  • ess-client:Client节点。

可以选择其中一个或多个之间的组合但不可以重复选择。

默认取值

不涉及

nodesize

Integer

参数解释

扩容实例个数。

约束限制

集群扩容后,各类型节点的数量需要满足以下要求:

  • 数据节点:集群没有Master节点时:1~32,集群有Master节点时:1~200。

  • Master节点:3、5、7、9(必须是3~9之间的奇数)。

  • Client节点:1~32。

  • 冷数据节点:1~32。

取值范围

参考约束限制。

默认取值

不涉及

disksize

Integer

参数解释

扩容实例存储容量。集群原实例存储容量和扩容实例存储容量之和不能超过创建集群时对应默认实例存储容量上限。若无需扩容该参数将该参数设置为0即可。当集群为包周期集群时不支持同时修改节点个数和磁盘容量。

单位:GB

约束限制

  • ess节点、ess-cold节点扩容步长为20。

  • ess-master节点、ess-client节点不允许扩容存储。

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释

集群ID。

取值范围

不涉及

请求示例

修改当前集群的实例个数与存储容量。

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/role_extend

{
  "grow" : [ {
    "type" : "ess-master",
    "nodesize" : 2,
    "disksize" : 0
  }, {
    "type" : "ess",
    "nodesize" : 0,
    "disksize" : 40
  }, {
    "type" : "ess-client",
    "nodesize" : 1,
    "disksize" : 0
  } ],
  "is_auto_pay" : 1
}

响应示例

状态码:200

请求已成功。

{
  "id" : "4f3deec3-efa8-4598-bf91-560aad1377a3"
}

SDK代码示例

SDK代码示例如下。

Java

修改当前集群的实例个数与存储容量。

 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
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.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;

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

public class UpdateExtendInstanceStorageSolution {

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

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateExtendInstanceStorageRequest request = new UpdateExtendInstanceStorageRequest();
        request.withClusterId("{cluster_id}");
        RoleExtendReq body = new RoleExtendReq();
        List<RoleExtendGrowReq> listbodyGrow = new ArrayList<>();
        listbodyGrow.add(
            new RoleExtendGrowReq()
                .withType("ess-master")
                .withNodesize(2)
                .withDisksize(0)
        );
        listbodyGrow.add(
            new RoleExtendGrowReq()
                .withType("ess")
                .withNodesize(0)
                .withDisksize(40)
        );
        listbodyGrow.add(
            new RoleExtendGrowReq()
                .withType("ess-client")
                .withNodesize(1)
                .withDisksize(0)
        );
        body.withIsAutoPay(1);
        body.withGrow(listbodyGrow);
        request.withBody(body);
        try {
            UpdateExtendInstanceStorageResponse response = client.updateExtendInstanceStorage(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());
        }
    }
}

Python

修改当前集群的实例个数与存储容量。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 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 = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateExtendInstanceStorageRequest()
        request.cluster_id = "{cluster_id}"
        listGrowbody = [
            RoleExtendGrowReq(
                type="ess-master",
                nodesize=2,
                disksize=0
            ),
            RoleExtendGrowReq(
                type="ess",
                nodesize=0,
                disksize=40
            ),
            RoleExtendGrowReq(
                type="ess-client",
                nodesize=1,
                disksize=0
            )
        ]
        request.body = RoleExtendReq(
            is_auto_pay=1,
            grow=listGrowbody
        )
        response = client.update_extend_instance_storage(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

修改当前集群的实例个数与存储容量。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/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 := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateExtendInstanceStorageRequest{}
	request.ClusterId = "{cluster_id}"
	var listGrowbody = []model.RoleExtendGrowReq{
        {
            Type: "ess-master",
            Nodesize: int32(2),
            Disksize: int32(0),
        },
        {
            Type: "ess",
            Nodesize: int32(0),
            Disksize: int32(40),
        },
        {
            Type: "ess-client",
            Nodesize: int32(1),
            Disksize: int32(0),
        },
    }
	isAutoPayRoleExtendReq:= int32(1)
	request.Body = &model.RoleExtendReq{
		IsAutoPay: &isAutoPayRoleExtendReq,
		Grow: listGrowbody,
	}
	response, err := client.UpdateExtendInstanceStorage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

404

所请求的资源不存在。

建议直接修改该请求,不要重试该请求。

错误码

请参见错误码