Editing a Logical Cluster
Function
This API is used to edit a logical cluster. The API determines whether to scale out or scale in a logical cluster based on the submitted request body.
Scenario 1: The original logical cluster has six nodes (two rings). If the request body submitted contains only one ring, the logical cluster is scaled in.
Scenario 2: The original logical cluster has six nodes (two rings). If the request body submitted contains three rings, the logical cluster is scaled out.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| cluster_id | Yes | String | Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints N/A Range N/A Default Value N/A |
| 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 |
| logical_cluster_id | Yes | String | Definition ID of the logical cluster to be edited. Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| cluster_rings | Yes | Array of ClusterRing objects | Definition Information for editing the ring list of the logical cluster. Constraints N/A Range N/A Default Value N/A |
| mode | No | String | Definition Redistribution mode. Constraints N/A Range N/A Default Value N/A |
| waiting_for_killing | No | Integer | Definition Time before job termination. Constraints N/A 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
Submit the request for scaling in the logical cluster. After the request is submitted, the logical cluster has only one ring (three nodes).
PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-clusters/0b494d0d-8431-4c4f-8a06-2cc42d0d0c7d
{
"cluster_rings" : [ {
"ring_hosts" : [ {
"host_name" : "host-172-16-20-246",
"back_ip" : "172.16.73.90",
"cpu_cores" : 8,
"memory" : 32.0,
"disk_size" : 800.0
}, {
"host_name" : "host-172-16-4-26",
"back_ip" : "172.16.123.5",
"cpu_cores" : 8,
"memory" : 32.0,
"disk_size" : 800.0
}, {
"host_name" : "host-172-16-43-90",
"back_ip" : "172.16.92.175",
"cpu_cores" : 8,
"memory" : 32.0,
"disk_size" : 800.0
} ]
} ],
"mode" : null,
"waiting_for_killing" : 0
} Example Responses
Status code: 200
Request for editing a logical cluster submitted.
{
"error_code" : "DWS.0000",
"error_msg" : null
} SDK Sample Code
The SDK sample code is as follows.
Submit the request for scaling in the logical cluster. After the request is submitted, the logical cluster has only one ring (three nodes).
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 85 | 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 UpdateLogicalClusterSolution { 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(); UpdateLogicalClusterRequest request = new UpdateLogicalClusterRequest(); request.withClusterId("{cluster_id}"); request.withLogicalClusterId("{logical_cluster_id}"); UpdateLogicalClusterRequestBody body = new UpdateLogicalClusterRequestBody(); List<RingHost> listClusterRingsRingHosts = new ArrayList<>(); listClusterRingsRingHosts.add( new RingHost() .withHostName("host-172-16-20-246") .withBackIp("172.16.73.90") .withCpuCores(8) .withMemory((double)32.0) .withDiskSize((double)800.0) ); listClusterRingsRingHosts.add( new RingHost() .withHostName("host-172-16-4-26") .withBackIp("172.16.123.5") .withCpuCores(8) .withMemory((double)32.0) .withDiskSize((double)800.0) ); listClusterRingsRingHosts.add( new RingHost() .withHostName("host-172-16-43-90") .withBackIp("172.16.92.175") .withCpuCores(8) .withMemory((double)32.0) .withDiskSize((double)800.0) ); List<ClusterRing> listbodyClusterRings = new ArrayList<>(); listbodyClusterRings.add( new ClusterRing() .withRingHosts(listClusterRingsRingHosts) ); body.withWaitingForKilling(0); body.withClusterRings(listbodyClusterRings); request.withBody(body); try { UpdateLogicalClusterResponse response = client.updateLogicalCluster(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()); } } } |
Submit the request for scaling in the logical cluster. After the request is submitted, the logical cluster has only one ring (three nodes).
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 | # 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 = UpdateLogicalClusterRequest() request.cluster_id = "{cluster_id}" request.logical_cluster_id = "{logical_cluster_id}" listRingHostsClusterRings = [ RingHost( host_name="host-172-16-20-246", back_ip="172.16.73.90", cpu_cores=8, memory=32.0, disk_size=800.0 ), RingHost( host_name="host-172-16-4-26", back_ip="172.16.123.5", cpu_cores=8, memory=32.0, disk_size=800.0 ), RingHost( host_name="host-172-16-43-90", back_ip="172.16.92.175", cpu_cores=8, memory=32.0, disk_size=800.0 ) ] listClusterRingsbody = [ ClusterRing( ring_hosts=listRingHostsClusterRings ) ] request.body = UpdateLogicalClusterRequestBody( waiting_for_killing=0, cluster_rings=listClusterRingsbody ) response = client.update_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) |
Submit the request for scaling in the logical cluster. After the request is submitted, the logical cluster has only one ring (three nodes).
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 | 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.UpdateLogicalClusterRequest{} request.ClusterId = "{cluster_id}" request.LogicalClusterId = "{logical_cluster_id}" var listRingHostsClusterRings = []model.RingHost{ { HostName: "host-172-16-20-246", BackIp: "172.16.73.90", CpuCores: int32(8), Memory: float64(32.0), DiskSize: float64(800.0), }, { HostName: "host-172-16-4-26", BackIp: "172.16.123.5", CpuCores: int32(8), Memory: float64(32.0), DiskSize: float64(800.0), }, { HostName: "host-172-16-43-90", BackIp: "172.16.92.175", CpuCores: int32(8), Memory: float64(32.0), DiskSize: float64(800.0), }, } var listClusterRingsbody = []model.ClusterRing{ { RingHosts: listRingHostsClusterRings, }, } waitingForKillingUpdateLogicalClusterRequestBody:= int32(0) request.Body = &model.UpdateLogicalClusterRequestBody{ WaitingForKilling: &waitingForKillingUpdateLogicalClusterRequestBody, ClusterRings: listClusterRingsbody, } response, err := client.UpdateLogicalCluster(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 | Request for editing a logical cluster submitted. |
| 400 | Request error. |
| 401 | Authentication failed. |
| 403 | You do not have required permissions. |
| 404 | No resources found. |
| 500 | Internal server error. |
| 503 | Service unavailable. |
Feedback
Was this page helpful?
Provide feedbackThank 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