# 集群缩容 - ShrinkCluster #### 功能介绍 该接口用于缩容集群。 #### 调用方法 请参见[如何调用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:scaleIn | Write | cluster \* | - g:ResourceTag/\ - g:EnterpriseProjectId | dws:cluster:shrink | - | #### URI POST /v1.0/{project_id}/clusters/{cluster_id}/cluster-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。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | shrink_number | 否 | Integer | **参数解释**： 缩容节点个数。 **约束限制**： 该值不能为空。 **取值范围**： 大于0的整数。 **默认取值**： 不涉及。 | | online | 否 | Boolean | **参数解释**： 是否是在线缩容。 **约束限制**： 不涉及。 **取值范围**： - true：在线缩容。 - false：非在线缩容（离线缩容）。 **默认取值**： false。 | | retry | 否 | Boolean | **参数解释**： 是否是缩容失败后重试。 **约束限制**： 不涉及。 **取值范围**： - true：缩容失败后重试。 - false：非缩容失败后重试。 **默认取值**： false。 | | need_agency | 否 | Boolean | **参数解释**： 是否需要委托。 **约束限制**： 不涉及。 **取值范围**： - true：需要委托。 - false：不需要委托。 **默认取值**： false。 | | parallel_jobs | 否 | Integer | **参数解释**： 重分布并发配置数。 **约束限制**： 不涉及。 **取值范围**： 1\~200。 **默认取值**： 4。 | | type | 否 | String | **参数解释**： 类型字段，字段已废弃不再生效。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | force_backup | 否 | Boolean | **参数解释**： 操作前是否执行备份，字段已废弃不再生效。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | job_id | String | **参数解释**： 缩容的任务ID信息。 **取值范围**： 不涉及。 | #### 请求示例 离线缩容ID为"4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90"的标准数仓集群3个节点，并执行创建委托。 ``` POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/cluster-shrink { "shrink_number" : 3, "online" : false, "retry" : false, "need_agency" : true, "parallel_jobs" : 2 } ``` #### 响应示例 **状态码：200** ``` { "job_id" : "2c9081c88418ed420184197c8bc80001" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 离线缩容ID为"4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90"的标准数仓集群3个节点，并执行创建委托。 ``` 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("")) .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()); } } } ``` - [Python] 离线缩容ID为"4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90"的标准数仓集群3个节点，并执行创建委托。 ``` # 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("")) \ .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) ``` - [Go] 离线缩容ID为"4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90"的标准数仓集群3个节点，并执行创建委托。 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ShrinkClusterRequest{} request.ClusterId = "{cluster_id}" parallelJobsClusterShrinkReq:= int32(2) needAgencyClusterShrinkReq:= true retryClusterShrinkReq:= false onlineClusterShrinkReq:= false shrinkNumberClusterShrinkReq:= int32(3) request.Body = &model.ClusterShrinkReq{ ParallelJobs: ¶llelJobsClusterShrinkReq, 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ShrinkCluster)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 缩容请求提交成功。 | | 400 | 请求错误。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 500 | 服务内部错误。 | | 503 | 服务不可用。 |