Help Center/ Cloud Search Service/ API Reference/ API V1/ Cluster Management/ Adding Instances and Expanding Instance Storage Capacity
Updated on 2025-08-15 GMT+08:00

Adding Instances and Expanding Instance Storage Capacity

Function

This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold data nodes.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints:

N/A

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster you want to scale out. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

grow

Yes

Array of RoleExtendGrowReq objects

Definition:

Detailed description about the cluster scale-out request.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

is_auto_pay

No

Integer

Definition:

Whether to enable automatic payment from your Huawei Cloud account.

Constraints:

This parameter takes effect only for yearly/monthly clusters.

Value range:

  • 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.)

  • 0: No. (The customer needs to manually pay for the bill. Discounts and coupons can be used.)

Default value:

0

Table 3 RoleExtendGrowReq

Parameter

Mandatory

Type

Description

type

Yes

String

Definition:

Type of the instance to be scaled out.

Constraints:

You can only add instances, rather than increase storage capacity, on nodes of the ess-master and ess-client types.

Value range:

  • ess: data node

  • ess-master: master node

  • ess-client: client node

You can select multiple node types, but cannot select the same node for different roles.

Default value:

N/A

nodesize

Yes

Integer

Definition:

Number of instances you want to add.

Constraints:

After scaling, the number of nodes of each type must meet the following requirements:

  • Data nodes: If the cluster does not have master nodes, the value ranges from 1 to 32. Otherwise, the value ranges from 1 to 200.

  • Master nodes: 3, 5, 7, or 9 (must be an odd number from 3 to 9)

  • Client nodes: 1 to 32.

  • Cold data nodes: 1 to 32.

Value range:

See Constraints.

Default value:

N/A

disksize

Yes

Integer

Definition:

Storage capacity of the instance to be expanded. The sum of the original instance storage capacity plus the expanded instance storage capacity cannot exceed the default upper limit of storage capacity set during cluster creation. If there is no need to add more instances, set this parameter to 0. With a yearly/monthly cluster, you cannot change the number of nodes and disk capacity at the same time.

Unit: GB

Constraints:

  • The scale-out step of ESS and ESS-cold nodes is 20.

  • Storage capacity of ess-master and ess-client nodes cannot be expanded.

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition:

Cluster ID.

Value range:

N/A

Example Requests

Change the number of instances and storage capacity of the current cluster.

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
}

Example Responses

Status code: 200

Request succeeded.

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

SDK Sample Code

The SDK sample code is as follows.

Java

Change the number of instances and storage capacity of the current cluster.

 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

Change the number of instances and storage capacity of the current cluster.

 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

Change the number of instances and storage capacity of the current cluster.

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

More

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

Request succeeded.

400

Invalid request.

Modify the request before retry.

404

The requested resource could not be found.

Modify the request before retry.

Error Codes

See Error Codes.