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

Scaling In a Cluster

Function

This API is used to scales in a cluster.

Call Method

For details, see Calling APIs.

URI

1
POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrink
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

cluster_id

Yes

String

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

shrink_number

Yes

Integer

Number of scale-in nodes.

  • The cluster is configured in the ring mode. A ring is the smallest unit for scale-in. Three or four hosts form a ring. The primary, standby, and secondary DNs are deployed in this ring.
  • The scale-in must be performed in reverse order of the scale-out. For example, if three nodes are added and then four nodes are added, you can reduce four nodes or seven nodes.

online

Yes

Boolean

Online scale-in

type

Yes

String

Database type.

  • dws: standard data warehouse.
  • stream: stream data warehouse.
  • hybrid: hybrid data warehouse.

retry

No

Boolean

Whether to retry

force_backup

Yes

Boolean

Whether to perform back up

need_agency

Yes

Boolean

Whether an agency is required If scale-in takes a long time, you need to authorize an agency. Otherwise, scale-in may fail.

Response Parameters

Table 3 Response parameters

Parameter

Type

Description

error_code

String

Error code

error_code

String

Error message

Example Request

Scale in the standard data warehouse cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 offline by reducing 3 nodes, perform backup, and do not use agency:

1
2
3
4
5
6
7
8
POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/cluster-shrink
{
  "shrink_number": 3,
  "online": false,
  "type": "dws",
  "force_backup": true,
  "need_agency": false
}

Example Response

Status code: 200

1
2
3
4
{
        "error_code": "DWS.0000",
        "error_msg": "Request successfully processed."
}     

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

    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("cn-north-4"))
                .build();
        ShrinkClusterRequest request = new ShrinkClusterRequest();
        ClusterShrinkReq body = new ClusterShrinkReq();
        body.withNeedAgency(false);
        body.withForceBackup(true);
        body.withType("dws");
        body.withOnline(false);
        body.withShrinkNumber(3);
        request.withBody(body);
        try {
            ShrinkClusterResponse response = client.shrinkCluster(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
# 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("cn-north-4")) \
        .build()

    try:
        request = ShrinkClusterRequest()
        request.body = ClusterShrinkReq(
            need_agency=False,
            force_backup=True,
            type="dws",
            online=False,
            shrink_number=3
        )
        response = client.shrink_cluster(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
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("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ShrinkClusterRequest{}
	request.Body = &model.ClusterShrinkReq{
		NeedAgency: false,
		ForceBackup: true,
		Type: "dws",
		Online: false,
		ShrinkNumber: int32(3),
	}
	response, err := client.ShrinkCluster(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-in request is successfully sent.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.