# 设置自动变配 - UpdateAutoScalingPolicy #### 功能介绍 设置自动变配。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-taurusdb/taurusdb_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbformysql:autoscaling:createPolicy | Permission_management | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:autoscaling:createPolicy | - | #### URI PUT /v3/{project_id}/instances/{instance_id}/auto-scaling/policy 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID，此参数是实例的唯一标识。 通过调用[查询实例列表](https://support.huaweicloud.com/api-taurusdb/ListGaussMySqlInstancesUnifyStatus.html)接口获取实例ID。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | Content-Type | 是 | String | **参数解释**： 内容类型。 **约束限制**： 不涉及。 **取值范围**： application/json。 **默认取值**： application/json。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | status | 是 | String | **参数解释**： 自动变配开关状态。 **约束限制**： 不涉及。 **取值范围**： - ON：开启。 - OFF：关闭。 **默认取值**: 不涉及。 | | scaling_strategy | 是 | [ScalingStrategyReqInfo] object | **参数解释**： 变配策略配置信息。 **约束限制**： 不涉及。 | | monitor_cycle | 否 | Integer | **参数解释**： 监测周期（单位：秒）。 在整个观测窗口期内，若CPU平均使用率大于等于设定值，则在观测窗口结束后，进行扩容。 **约束限制**： status为ON时必填。 **取值范围**： 300、600、900、1800。 **默认取值**： 不涉及。 | | silence_cycle | 否 | Integer | **参数解释**： 静默周期（单位：秒）。 两次自动扩容或自动回缩的最小间隔时间。 **约束限制**： status为ON时必填。 **取值范围**： 300、600、1800、3600、7200、10800、86400、604800。 **默认取值**： 不涉及。 | | enlarge_threshold | 否 | Integer | **参数解释**： 自动扩容的CPU平均使用率阈值（百分比数值）。 **约束限制**： status为ON时必填。 **取值范围**： 50-100。 **默认取值**： 不涉及。 | | max_flavor | 否 | String | **参数解释**： 扩容规格上限。 **约束限制**： 开启扩缩规格时必填, 规格需要与原规格的CPU内存比一致。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | reduce_enabled | 否 | Boolean | **参数解释**： 是否开启自动回缩。 **约束限制**： 开启自动变配时必填。 **取值范围**： - true：是。 - false：否。 **默认取值**： 不涉及。 | | reduce_threshold | 否 | Integer | **参数解释**： 自动回缩的CPU平均使用率阈值（百分比数值）。 **约束限制**： 不涉及。 **取值范围**： 10-30。 **默认取值**： 不涉及。 | | max_read_only_count | 否 | Integer | **参数解释**： 只读节点数量上限。 **约束限制**： 开启增删只读节点时必填。 **取值范围**： 2-15。 **默认取值**： 不涉及。 | | read_only_weight | 否 | Integer | **参数解释**： 只读节点读写分离权重。 **约束限制**： 开启增删只读节点时必填。 **取值范围**： 不涉及。 **默认取值**： 0-1000。 | 表4ScalingStrategyReqInfo | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | flavor_switch | 是 | String | **参数解释**： 扩缩规格开关。 **约束限制**： 不涉及。 **取值范围**： - ON：开启。 - OFF：关闭。 **默认取值**： 不涉及。 | | read_only_switch | 是 | String | **参数解释**： 增删只读节点开关。 **约束限制**： 自动增删只读节点功能需要先[开启数据库代理](https://support.huaweicloud.com/api-taurusdb/CreateGaussMySqlProxy.html)，且只能有一个代理。 **取值范围**： - ON：开启。 - OFF：关闭。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 | | instance_name | String | **参数解释**： 实例名称。 **取值范围**： 最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 | | switch_status | [AutoScalingSwitchStatus] object | **参数解释**： 开关状态。 | 表6AutoScalingSwitchStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | scaling_switch | String | **参数解释**： 自动变配开关状态。 **取值范围**： - ON：开启。 - OFF：关闭。 | | flavor_switch | String | **参数解释**： 扩缩规格开关状态。 **取值范围**： - ON：开启。 - OFF：关闭。 | | read_only_switch | String | **参数解释**： 增删只读节点开关状态。 **取值范围**： - ON：开启。 - OFF：关闭。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 设置自动变配。 ``` PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/auto-scaling/policy { "enlarge_threshold" : 50, "max_flavor" : "gaussdb.mysql.large.x86.4", "max_read_only_count" : 2, "monitor_cycle" : 300, "read_only_weight" : 10, "reduce_enabled" : false, "scaling_strategy" : { "flavor_switch" : "ON", "read_only_switch" : "ON" }, "silence_cycle" : 300, "status" : "ON" } ``` #### 响应示例 **状态码：200** ``` { "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "instance_name" : "gauss-test-1", "switch_status" : { "scaling_switch" : "ON", "flavor_switch" : "ON", "read_only_switch" : "ON" } } ``` #### 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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class UpdateAutoScalingPolicySolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("")) .build(); UpdateAutoScalingPolicyRequest request = new UpdateAutoScalingPolicyRequest(); request.withInstanceId("{instance_id}"); UpdateAutoScalingPolicyRequestBody body = new UpdateAutoScalingPolicyRequestBody(); ScalingStrategyReqInfo scalingStrategybody = new ScalingStrategyReqInfo(); scalingStrategybody.withFlavorSwitch("ON") .withReadOnlySwitch("ON"); body.withScalingStrategy(scalingStrategybody); body.withReadOnlyWeight(10); body.withMaxReadOnlyCount(2); body.withReduceEnabled(false); body.withMaxFlavor("gaussdb.mysql.large.x86.4"); body.withEnlargeThreshold(50); body.withSilenceCycle(300); body.withMonitorCycle(300); body.withStatus("ON"); request.withBody(body); try { UpdateAutoScalingPolicyResponse response = client.updateAutoScalingPolicy(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 huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("")) \ .build() try: request = UpdateAutoScalingPolicyRequest() request.instance_id = "{instance_id}" scalingStrategybody = ScalingStrategyReqInfo( flavor_switch="ON", read_only_switch="ON" ) request.body = UpdateAutoScalingPolicyRequestBody( scaling_strategy=scalingStrategybody, read_only_weight=10, max_read_only_count=2, reduce_enabled=False, max_flavor="gaussdb.mysql.large.x86.4", enlarge_threshold=50, silence_cycle=300, monitor_cycle=300, status="ON" ) response = client.update_auto_scaling_policy(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" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.UpdateAutoScalingPolicyRequest{} request.InstanceId = "{instance_id}" scalingStrategybody := &model.ScalingStrategyReqInfo{ FlavorSwitch: "ON", ReadOnlySwitch: "ON", } readOnlyWeightUpdateAutoScalingPolicyRequestBody:= int32(10) maxReadOnlyCountUpdateAutoScalingPolicyRequestBody:= int32(2) reduceEnabledUpdateAutoScalingPolicyRequestBody:= false maxFlavorUpdateAutoScalingPolicyRequestBody:= "gaussdb.mysql.large.x86.4" enlargeThresholdUpdateAutoScalingPolicyRequestBody:= int32(50) silenceCycleUpdateAutoScalingPolicyRequestBody:= int32(300) monitorCycleUpdateAutoScalingPolicyRequestBody:= int32(300) request.Body = &model.UpdateAutoScalingPolicyRequestBody{ ScalingStrategy: scalingStrategybody, ReadOnlyWeight: &readOnlyWeightUpdateAutoScalingPolicyRequestBody, MaxReadOnlyCount: &maxReadOnlyCountUpdateAutoScalingPolicyRequestBody, ReduceEnabled: &reduceEnabledUpdateAutoScalingPolicyRequestBody, MaxFlavor: &maxFlavorUpdateAutoScalingPolicyRequestBody, EnlargeThreshold: &enlargeThresholdUpdateAutoScalingPolicyRequestBody, SilenceCycle: &silenceCycleUpdateAutoScalingPolicyRequestBody, MonitorCycle: &monitorCycleUpdateAutoScalingPolicyRequestBody, Status: "ON", } response, err := client.UpdateAutoScalingPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDB/sdk?api=UpdateAutoScalingPolicy)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。