# 逻辑集群缩容 - ShrinkLogicalCluster
#### 功能介绍
逻辑集群缩容，支持从逻辑集群中缩容、从弹性池中缩容。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dws/dws_02_0062.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dws/dws_02_0056.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别  | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dws:cluster:shrinkLogicalCluster | Write | cluster \*  | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId    | -  | -      |
     
  
 
#### URI
POST /v1/{project_id}/clusters/{cluster_id}/logical-clusters/{logical_cluster_id}/shrink
表1路径参数 
| 参数                 | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| project_id         | 是    | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dws/dws_02_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                |
| cluster_id         | 是    | String | **参数解释**： 集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-dws/dws_02_00068.html)。 **约束限制**： 必须是有效的dws集群ID。 **取值范围**： 36位UUID。 **默认取值**： 不涉及。 |
| logical_cluster_id | 是    | String | **参数解释**： 逻辑集群id。 **约束限制**： 必须是有效的dws逻辑集群ID。 **取值范围**： 36位UUID。 **默认取值**： 不涉及。                                                                        |
   
#### 请求参数
表2请求Body参数 
| 参数              | 是否必选 | 参数类型                                                                                                            | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| cluster_rings   | 否    | Array of [ClusterRing] objects | **参数解释**： 缩容主机环信息。 **约束限制**： 与shrink_node_num缩容节点个数两个参数任选其一，两者都存在，优先取cluster_rings缩容主机环信息参数。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                                        |
| parallel_jobs   | 否    | Integer                                                                                                         | **参数解释**： 重分布并发配置数。 **约束限制**： 不涉及。 **取值范围**： 1\~200。 **默认取值**： 4。                                                                                                 |
| mode            | 否    | String                                                                                                          | **参数解释**： 缩容模式。 **约束限制**： 不涉及。 **取值范围**： read-only：离线模式 insert：在线模式 **默认取值**： insert |
| shrink_node_num | 否    | Integer                                                                                                         | **参数解释**： 缩容节点个数。 **约束限制**： 与cluster_rings缩容主机环信息两个参数任选其一，两者都存在，优先取cluster_rings缩容主机环信息参数。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                                          |
   
 表3ClusterRing 
| 参数                         | 是否必选 | 参数类型                                                                                                      | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| ring_hosts                 | 是    | Array of [RingHost] objects | **参数解释**： 集群主机信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| un_shrinkable_cluster_ring | 否    | Boolean                                                                                                   | **参数解释**： 是否不可缩容。 **约束限制**： 不涉及。 **取值范围**： - true：不可缩容。   - false：可缩容。    **默认取值**： 不涉及。 |
   
 表4RingHost 
| 参数        | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| host_name | 是    | String  | **参数解释**： 主机名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。    |
| back_ip   | 是    | String  | **参数解释**： 后端IP地址。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。  |
| cpu_cores | 是    | Integer | **参数解释**： 主机CPU核数。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 |
| memory    | 是    | Double  | **参数解释**： 主机内存。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。    |
| disk_size | 是    | Double  | **参数解释**： 主机磁盘大小。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。  |
   
#### 响应参数
**状态码：200**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。  |
| error_msg  | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 |
   
#### 请求示例
逻辑集群缩容。
```
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
    } ]
  } ]
}
```
#### 响应示例
**状态码：200**
```
{
  "error_code" : "DWS.0000",
  "error_msg" : null
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  逻辑集群缩容。
  ```
  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());
          }
      }
  }
  ```
- [Python]
  逻辑集群缩容。
  ```
  # 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)
  ```
- [Go]
  逻辑集群缩容。
  ```
  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)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ShrinkLogicalCluster)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述          |
|:---|:---|
| 200 | 缩容逻辑集群提交成功。 |
| 400 | 请求错误。       |
| 401 | 鉴权失败。       |
| 403 | 没有操作权限。     |
| 500 | 服务内部错误。     |
| 503 | 服务不可用。      |
   
