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

Editing a Logical Cluster

Function

This API is used to modify a logical cluster.

Call Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}
Table 1 URI parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

ID of the cluster to be edited. 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.

logical_cluster_id

Yes

String

ID of the logical cluster to be edited.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

cluster_rings

Yes

Array of ClusterRing objects

Information about the edited logical cluster ring.

mode

No

String

Mode

waiting_for_killing

No

Integer

Indicates whether the cluster is waiting for destruction.

Table 3 ClusterRing

Parameter

Mandatory

Type

Description

ring_hosts

Yes

Array of RingHost objects

Cluster host information

Table 4 RingHost

Parameter

Mandatory

Type

Description

host_name

Yes

String

Host name

back_ip

Yes

String

Backend IP address

cpu_cores

Yes

Integer

Number of host CPUs

memory

Yes

Double

Host memory

disk_size

Yes

Double

Disk size of the host

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

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 Response

Status code: 200

The logical cluster is edited successfully.

{
  "error_code" : "DWS.0000",
  "error_msg" : null
}

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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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");

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateLogicalClusterRequest request = new UpdateLogicalClusterRequest();
        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());
        }
    }
}
 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
# 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 = UpdateLogicalClusterRequest()
        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)
 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
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.UpdateLogicalClusterRequest{}
	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 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 logical cluster is edited 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.