Updated on 2026-06-22 GMT+08:00

Scaling In a Cluster

Function

This API is used to scale in a cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-shrink

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

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

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

shrink_number

No

Integer

Definition

Number of nodes to be scaled in.

Constraints

This parameter cannot be left blank.

Range

An integer greater than 0

Default Value

N/A

online

No

Boolean

Definition

Whether the scale-in is online.

Constraints

N/A

Range

false or true

Default Value

false

retry

No

Boolean

Definition

Whether to retry after a scale-in failure.

Constraints

N/A

Range

false or true

Default Value

false

need_agency

No

Boolean

Definition

Whether an agency is required.

Constraints

N/A

Range

false or true

Default Value

false

parallel_jobs

No

Integer

Definition

Number of concurrent redistribution tasks.

Constraints

N/A

Range

1 to 200

Default Value

4

type

No

String

Definition

Type. This field has been deprecated and does not take effect.

Constraints

N/A

Range

N/A

Default Value

N/A

force_backup

No

Boolean

Definition

Whether to back up data before the operation. This parameter has been deprecated and does not take effect.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Definition

ID of a scale-in task.

Range

N/A

Example Requests

Scale in three nodes in the standard data warehouse cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 offline and create an agency.

POST https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/shrink

{
  "shrink_number" : 3,
  "online" : false,
  "retry" : false,
  "need_agency" : true,
  "parallel_jobs" : 2
}

Example Responses

Status code: 200

The scale-in request is submitted successfully.

{
  "job_id" : "2c9081c88418ed420184197c8bc80001"
}

SDK Sample Code

The SDK sample code is as follows.

Scale in three nodes in the standard data warehouse cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 offline and create an agency.

 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
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");
        String projectId = "{project_id}";

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ShrinkClusterRequest request = new ShrinkClusterRequest();
        request.withClusterId("{cluster_id}");
        ClusterShrinkReq body = new ClusterShrinkReq();
        body.withParallelJobs(2);
        body.withNeedAgency(true);
        body.withRetry(false);
        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());
        }
    }
}

Scale in three nodes in the standard data warehouse cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 offline and create an agency.

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

import os
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.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ShrinkClusterRequest()
        request.cluster_id = "{cluster_id}"
        request.body = ClusterShrinkReq(
            parallel_jobs=2,
            need_agency=True,
            retry=False,
            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)

Scale in three nodes in the standard data warehouse cluster whose ID is 4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90 offline and create an agency.

 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
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")
    projectId := "{project_id}"

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

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

    request := &model.ShrinkClusterRequest{}
	request.ClusterId = "{cluster_id}"
	parallelJobsClusterShrinkReq:= int32(2)
	needAgencyClusterShrinkReq:= true
	retryClusterShrinkReq:= false
	onlineClusterShrinkReq:= false
	shrinkNumberClusterShrinkReq:= int32(3)
	request.Body = &model.ClusterShrinkReq{
		ParallelJobs: &parallelJobsClusterShrinkReq,
		NeedAgency: &needAgencyClusterShrinkReq,
		Retry: &retryClusterShrinkReq,
		Online: &onlineClusterShrinkReq,
		ShrinkNumber: &shrinkNumberClusterShrinkReq,
	}
	response, err := client.ShrinkCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

The scale-in request is submitted successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.