Scaling In a Logical Cluster
Function
This API is used to scale in a logical cluster in an elastic pool.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
POST /v1/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/shrink
| 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 |
| logical_cluster_id | Yes | String | Definition Logical cluster ID. Constraints The value must be a valid DWS logical cluster ID. Range It is a 36-digit UUID. Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| cluster_rings | No | Array of ClusterRing objects | Definition Host ring scale-in information. Constraints N/A Range N/A Default Value N/A |
| parallel_jobs | No | Integer | Definition Number of concurrent redistribution tasks. Constraints N/A Range 1 to 200 Default Value 4. |
| mode | No | String | Definition Scale-in mode. Constraints N/A Range read-only: offline mode insert: online mode Default Value insert |
| shrink_node_num | No | Integer | Definition Number of nodes to be deleted. Constraints Either the number of hosts to be deleted in cluster_rings or the number of hosts to be deleted in cluster_rings is required. If both of them are specified, the number of hosts to be deleted in cluster_rings is used. Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| ring_hosts | Yes | Array of RingHost objects | Definition Cluster host information. Constraints N/A Range N/A Default Value N/A |
| un_shrinkable_cluster_ring | No | Boolean | Definition Whether scale-in is supported. Constraints N/A Range false or true Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| host_name | Yes | String | Definition Host name. Constraints N/A Range N/A Default Value N/A |
| back_ip | Yes | String | Definition Backend IP address. Constraints N/A Range N/A Default Value N/A |
| cpu_cores | Yes | Integer | Definition Number of host CPUs. Constraints N/A Range N/A Default Value N/A |
| memory | Yes | Double | Definition Host memory. Constraints N/A Range N/A Default Value N/A |
| disk_size | Yes | Double | Definition Disk size of the host. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. Range N/A |
| error_msg | String | Definition Error message. Range N/A |
Example Requests
Scale in a logical cluster.
POST https://{Endpoint}/v1/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/d29fd79b-d445-4e90-8fea-2f7d8b216bff/logical-clusters/7dc7a0a9-1f43-4f3c-974e-4a5ee2070836/shrink
{
"cluster_rings" : [ {
"ring_hosts" : [ {
"back_ip" : "192.168.88.41",
"cpu_cores" : 4,
"disk_size" : 110,
"host_name" : "host-192-168-37-200",
"memory" : 16
}, {
"back_ip" : "192.168.72.33",
"cpu_cores" : 4,
"disk_size" : 110,
"host_name" : "host-192-168-6-50",
"memory" : 16
}, {
"back_ip" : "192.168.90.60",
"cpu_cores" : 4,
"disk_size" : 110,
"host_name" : "host-192-168-8-183",
"memory" : 16
} ]
} ]
} Example Responses
Status code: 200
The logical cluster scale-in request submitted.
{
"error_code" : "DWS.0000",
"error_msg" : null
} SDK Sample Code
The SDK sample code is as follows.
Scale in a logical 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 74 75 76 77 78 79 80 81 82 83 84 | 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.*; import java.util.List; import java.util.ArrayList; public class ShrinkLogicalClusterSolution { 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(); ShrinkLogicalClusterRequest request = new ShrinkLogicalClusterRequest(); request.withClusterId("{cluster_id}"); request.withLogicalClusterId("{logical_cluster_id}"); ShrinkLogicalClusterRequestBody body = new ShrinkLogicalClusterRequestBody(); List<RingHost> listClusterRingsRingHosts = new ArrayList<>(); listClusterRingsRingHosts.add( new RingHost() .withHostName("host-192-168-37-200") .withBackIp("192.168.88.41") .withCpuCores(4) .withMemory((double)16) .withDiskSize((double)110) ); listClusterRingsRingHosts.add( new RingHost() .withHostName("host-192-168-6-50") .withBackIp("192.168.72.33") .withCpuCores(4) .withMemory((double)16) .withDiskSize((double)110) ); listClusterRingsRingHosts.add( new RingHost() .withHostName("host-192-168-8-183") .withBackIp("192.168.90.60") .withCpuCores(4) .withMemory((double)16) .withDiskSize((double)110) ); List<ClusterRing> listbodyClusterRings = new ArrayList<>(); listbodyClusterRings.add( new ClusterRing() .withRingHosts(listClusterRingsRingHosts) ); body.withClusterRings(listbodyClusterRings); request.withBody(body); try { ShrinkLogicalClusterResponse response = client.shrinkLogicalCluster(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 a logical 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 | # 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 = ShrinkLogicalClusterRequest() request.cluster_id = "{cluster_id}" request.logical_cluster_id = "{logical_cluster_id}" listRingHostsClusterRings = [ RingHost( host_name="host-192-168-37-200", back_ip="192.168.88.41", cpu_cores=4, memory=16, disk_size=110 ), RingHost( host_name="host-192-168-6-50", back_ip="192.168.72.33", cpu_cores=4, memory=16, disk_size=110 ), RingHost( host_name="host-192-168-8-183", back_ip="192.168.90.60", cpu_cores=4, memory=16, disk_size=110 ) ] listClusterRingsbody = [ ClusterRing( ring_hosts=listRingHostsClusterRings ) ] request.body = ShrinkLogicalClusterRequestBody( cluster_rings=listClusterRingsbody ) response = client.shrink_logical_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 a logical 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 74 75 76 77 78 79 80 81 82 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ShrinkLogicalClusterRequest{} request.ClusterId = "{cluster_id}" request.LogicalClusterId = "{logical_cluster_id}" var listRingHostsClusterRings = []model.RingHost{ { HostName: "host-192-168-37-200", BackIp: "192.168.88.41", CpuCores: int32(4), Memory: float64(16), DiskSize: float64(110), }, { HostName: "host-192-168-6-50", BackIp: "192.168.72.33", CpuCores: int32(4), Memory: float64(16), DiskSize: float64(110), }, { HostName: "host-192-168-8-183", BackIp: "192.168.90.60", CpuCores: int32(4), Memory: float64(16), DiskSize: float64(110), }, } var listClusterRingsbody = []model.ClusterRing{ { RingHosts: listRingHostsClusterRings, }, } request.Body = &model.ShrinkLogicalClusterRequestBody{ ClusterRings: &listClusterRingsbody, } response, err := client.ShrinkLogicalCluster(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 logical cluster scale-in request submitted. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot