Updated on 2024-04-18 GMT+08:00

Scaling Out with Idle Nodes

Function

This API is used to scale out with idle nodes.

Call Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/clusters/{cluster_id}/resize-with-existed-nodes
Table 1 URI parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

ID of the cluster containing the specified idles nodes. For details about how to obtain the ID, see Obtaining the Cluster ID.

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

scale_out

Yes

ScaleOut object

Object to be scaled out

force_backup

No

Boolean

Whether to forcibly back up data

mode

No

String

Capacity expansion backup mode. The default value is offline read-only.

logical_cluster_name

No

String

Logical cluster name In non-logical cluster mode, this parameter is left blank. In logical cluster mode, the default value is elastic_group.

expand_with_existed_node

Yes

Boolean

Whether to use the added idle nodes for scale-out

auto_redistribute

No

Boolean

Whether to automatically start redistribution after scale-out. The default value is true.

redis_conf

No

RedisConfReq object

Redistribution configuration information

Table 3 ScaleOut

Parameter

Mandatory

Type

Description

count

Yes

Integer

Number of nodes to be added If there are idle nodes, all idle nodes must be used for scale-out.

Table 4 RedisConfReq

Parameter

Mandatory

Type

Description

redis_mode

Yes

String

Redistribution mode offLine and onLine. The default is offLine.

parallel_jobs

Yes

Integer

Number of parallel jobs The value ranges from 1 to 200. The default value is 4.

Response Parameters

None

Example Request

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize-with-existed-nodes

{
  "scale_out" : {
    "count" : 3
  },
  "expand_with_existed_node" : true,
  "auto_redistribute" : true,
  "redis_conf" : {
    "redis_mode" : "offLine",
    "parallel_jobs" : 4
  }
}

Example Response

Status code: 200

The scale-out using idle nodes is successful.

SDK Sample Code

The sample code is as follows:

 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
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ResizeClusterWithExistedNodesSolution {

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

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ResizeClusterWithExistedNodesRequest request = new ResizeClusterWithExistedNodesRequest();
        ResizeClusterWithExistedNodesRequestBody body = new ResizeClusterWithExistedNodesRequestBody();
        BuildTaskInfo buildTaskInfobody = new BuildTaskInfo();
        buildTaskInfobody.withBuildMode("read-only");
        RedisConf redisConfbody = new RedisConf();
        redisConfbody.withRedisMode("offLine")
            .withParallelJobs(4)
            .withParallelJob(4);
        ScaleOut scaleOutbody = new ScaleOut();
        scaleOutbody.withCount(3);
        body.withBuildTaskInfo(buildTaskInfobody);
        body.withRedisConf(redisConfbody);
        body.withIsSchedulerBuildMode(false);
        body.withAutoRedistribute(true);
        body.withCreateNodeOnly(true);
        body.withExpandWithExistedNode(true);
        body.withLogicalClusterName("test-logical-cluster");
        body.withMode("read-only");
        body.withForceBackup(false);
        body.withScaleOut(scaleOutbody);
        request.withBody(body);
        try {
            ResizeClusterWithExistedNodesResponse response = client.resizeClusterWithExistedNodes(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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ResizeClusterWithExistedNodesRequest()
        buildTaskInfobody = BuildTaskInfo(
            build_mode="read-only"
        )
        redisConfbody = RedisConf(
            redis_mode="offLine",
            parallel_jobs=4,
            parallel_job=4
        )
        scaleOutbody = ScaleOut(
            count=3
        )
        request.body = ResizeClusterWithExistedNodesRequestBody(
            build_task_info=buildTaskInfobody,
            redis_conf=redisConfbody,
            is_scheduler_build_mode=False,
            auto_redistribute=True,
            create_node_only=True,
            expand_with_existed_node=True,
            logical_cluster_name="test-logical-cluster",
            mode="read-only",
            force_backup=False,
            scale_out=scaleOutbody
        )
        response = client.resize_cluster_with_existed_nodes(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ResizeClusterWithExistedNodesRequest{}
	buildTaskInfobody := &model.BuildTaskInfo{
		BuildMode: "read-only",
	}
	redisConfbody := &model.RedisConf{
		RedisMode: "offLine",
		ParallelJobs: int32(4),
		ParallelJob: int32(4),
	}
	scaleOutbody := &model.ScaleOut{
		Count: int32(3),
	}
	request.Body = &model.ResizeClusterWithExistedNodesRequestBody{
		BuildTaskInfo: buildTaskInfobody,
		RedisConf: redisConfbody,
		IsSchedulerBuildMode: false,
		AutoRedistribute: true,
		CreateNodeOnly: true,
		ExpandWithExistedNode: true,
		LogicalClusterName: "test-logical-cluster",
		Mode: "read-only",
		ForceBackup: false,
		ScaleOut: scaleOutbody,
	}
	response, err := client.ResizeClusterWithExistedNodes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The scale-out using idle nodes is successful.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.