# 设置Serverless自定义扩容策略 - UpdateServerlessScalingPolicy #### 功能介绍 设置Serverless自定义扩容策略。 #### 接口约束 该接口目前公测阶段，如需使用，请提交工单联系客服人员申请权限。 #### 调用方法 请参见[如何调用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:serverless:updateScalingPolicy | Write | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | gaussdb:serverless:updateScalingPolicy | - | #### URI PUT /v3/{project_id}/instances/{instance_id}/serverless/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值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | X-Language | 否 | String | **参数解释**： 请求语言类型。 **约束限制**： 不涉及。 **取值范围**： - en-us：英文。 - zh-cn：中文。 **默认取值**： en-us。 | | Content-Type | 是 | String | **参数解释**： 内容类型。 **约束限制**： 不涉及。 **取值范围**： application/json。 **默认取值**： application/json。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enlarge_step_size | 否 | String | **参数解释**： 自定义扩容步长。 **约束限制**： 不涉及。 **取值范围**： 2-算力上限的一半。 **默认取值**： 不涉及。 | | custom_scaling_config | 否 | [CustomScalingConfig] object | **参数解释**： 自定义扩容策略。 **约束限制**： 不涉及。 | 表4CustomScalingConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enlarge_scene | 否 | [ScalingScene] object | **参数解释**： 自定义扩容策略。 **约束限制**： 不涉及。 | 表5ScalingScene | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | conditions | 否 | Array of [ScalingCondition] objects | **参数解释**: 变配条件。 **约束限制**： 不涉及。 | 表6ScalingCondition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | condition_id | 否 | String | **参数解释**: 变配条件名称。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字和中划线组成，且长度不超过32个字符，不能为空。 **默认取值**： 不涉及。 | | duration | 否 | Integer | **参数解释**： 持续时间，单位是毫秒。 **约束限制**： 不涉及。 **取值范围**： 2000-5000。 **默认取值**： 不涉及。 | | interval | 否 | Integer | **参数解释**: 间隔时间，单位是毫秒。 **约束限制**： 不涉及。 **取值范围**： 1000-5000。 **默认取值**： 不涉及。 | | metric_conditions | 否 | Array of [MetricCondition] objects | **参数解释**: 指标变配条件。 **约束条件**： 不涉及。 | 表7MetricCondition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | metric_name | 否 | String | **参数解释**: 指标名称。 **约束限制**： 不涉及。 **取值范围**： - cpuTotalUsage：CPU使用率。 - memoryTotalUsage：内存使用率。 **默认取值**： 不涉及。 | | metric_value | 否 | Integer | **参数解释**： 指标变配阈值。 **约束限制**： 取值为百分比的10000倍，比如50%对应的参数值为5000。 **取值范围**： 6000-8000。 **默认取值**： 不涉及。 | | compare_mode | 否 | String | **参数解释**： 比较模式。 **约束限制**： 不涉及。 **取值范围**： GT：大于。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 无 **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误消息。 | #### 请求示例 设置Serverless自定义扩容策略。 ``` PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/c70a7eed50b14ee4969449ab5166aa7bin07/serverless/scaling-policy { "enlarge_step_size" : "2", "custom_scaling_config" : { "enlarge_scene" : { "conditions" : [ { "condition_id" : "enlarge-custom-01", "metric_conditions" : [ { "metric_name" : "cpuTotalUsage", "metric_value" : 8000, "compare_mode" : "GT" } ], "duration" : 3000, "interval" : 1000 }, { "condition_id" : "enlarge-custom-02", "metric_conditions" : [ { "metric_name" : "cpuTotalUsage", "metric_value" : 6000, "compare_mode" : "GT" } ], "duration" : 5000, "interval" : 2000 }, { "condition_id" : "enlarge-custom-03", "metric_conditions" : [ { "metric_name" : "memoryTotalUsage", "metric_value" : 8000, "compare_mode" : "GT" } ], "duration" : 3000, "interval" : 2000 } ] } } } ``` #### 响应示例 **状态码：200** ``` { } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 设置Serverless自定义扩容策略。 ``` 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.*; import java.util.List; import java.util.ArrayList; public class UpdateServerlessScalingPolicySolution { 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(); UpdateServerlessScalingPolicyRequest request = new UpdateServerlessScalingPolicyRequest(); request.withInstanceId("{instance_id}"); ServerlessScalingPolicy body = new ServerlessScalingPolicy(); List listConditionsMetricConditions = new ArrayList<>(); listConditionsMetricConditions.add( new MetricCondition() .withMetricName("memoryTotalUsage") .withMetricValue(8000) .withCompareMode("GT") ); List listConditionsMetricConditions1 = new ArrayList<>(); listConditionsMetricConditions1.add( new MetricCondition() .withMetricName("cpuTotalUsage") .withMetricValue(6000) .withCompareMode("GT") ); List listConditionsMetricConditions2 = new ArrayList<>(); listConditionsMetricConditions2.add( new MetricCondition() .withMetricName("cpuTotalUsage") .withMetricValue(8000) .withCompareMode("GT") ); List listEnlargeSceneConditions = new ArrayList<>(); listEnlargeSceneConditions.add( new ScalingCondition() .withConditionId("enlarge-custom-01") .withDuration(3000) .withInterval(1000) .withMetricConditions(listConditionsMetricConditions2) ); listEnlargeSceneConditions.add( new ScalingCondition() .withConditionId("enlarge-custom-02") .withDuration(5000) .withInterval(2000) .withMetricConditions(listConditionsMetricConditions1) ); listEnlargeSceneConditions.add( new ScalingCondition() .withConditionId("enlarge-custom-03") .withDuration(3000) .withInterval(2000) .withMetricConditions(listConditionsMetricConditions) ); ScalingScene enlargeSceneCustomScalingConfig = new ScalingScene(); enlargeSceneCustomScalingConfig.withConditions(listEnlargeSceneConditions); CustomScalingConfig customScalingConfigbody = new CustomScalingConfig(); customScalingConfigbody.withEnlargeScene(enlargeSceneCustomScalingConfig); body.withCustomScalingConfig(customScalingConfigbody); body.withEnlargeStepSize("2"); request.withBody(body); try { UpdateServerlessScalingPolicyResponse response = client.updateServerlessScalingPolicy(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] 设置Serverless自定义扩容策略。 ``` # 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 = UpdateServerlessScalingPolicyRequest() request.instance_id = "{instance_id}" listMetricConditionsConditions = [ MetricCondition( metric_name="memoryTotalUsage", metric_value=8000, compare_mode="GT" ) ] listMetricConditionsConditions1 = [ MetricCondition( metric_name="cpuTotalUsage", metric_value=6000, compare_mode="GT" ) ] listMetricConditionsConditions2 = [ MetricCondition( metric_name="cpuTotalUsage", metric_value=8000, compare_mode="GT" ) ] listConditionsEnlargeScene = [ ScalingCondition( condition_id="enlarge-custom-01", duration=3000, interval=1000, metric_conditions=listMetricConditionsConditions2 ), ScalingCondition( condition_id="enlarge-custom-02", duration=5000, interval=2000, metric_conditions=listMetricConditionsConditions1 ), ScalingCondition( condition_id="enlarge-custom-03", duration=3000, interval=2000, metric_conditions=listMetricConditionsConditions ) ] enlargeSceneCustomScalingConfig = ScalingScene( conditions=listConditionsEnlargeScene ) customScalingConfigbody = CustomScalingConfig( enlarge_scene=enlargeSceneCustomScalingConfig ) request.body = ServerlessScalingPolicy( custom_scaling_config=customScalingConfigbody, enlarge_step_size="2" ) response = client.update_serverless_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] 设置Serverless自定义扩容策略。 ``` 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.UpdateServerlessScalingPolicyRequest{} request.InstanceId = "{instance_id}" metricNameMetricConditions:= "memoryTotalUsage" metricValueMetricConditions:= int32(8000) compareModeMetricConditions:= "GT" var listMetricConditionsConditions = []model.MetricCondition{ { MetricName: &metricNameMetricConditions, MetricValue: &metricValueMetricConditions, CompareMode: &compareModeMetricConditions, }, } metricNameMetricConditions1:= "cpuTotalUsage" metricValueMetricConditions1:= int32(6000) compareModeMetricConditions1:= "GT" var listMetricConditionsConditions1 = []model.MetricCondition{ { MetricName: &metricNameMetricConditions1, MetricValue: &metricValueMetricConditions1, CompareMode: &compareModeMetricConditions1, }, } metricNameMetricConditions2:= "cpuTotalUsage" metricValueMetricConditions2:= int32(8000) compareModeMetricConditions2:= "GT" var listMetricConditionsConditions2 = []model.MetricCondition{ { MetricName: &metricNameMetricConditions2, MetricValue: &metricValueMetricConditions2, CompareMode: &compareModeMetricConditions2, }, } conditionIdConditions:= "enlarge-custom-01" durationConditions:= int32(3000) intervalConditions:= int32(1000) conditionIdConditions1:= "enlarge-custom-02" durationConditions1:= int32(5000) intervalConditions1:= int32(2000) conditionIdConditions2:= "enlarge-custom-03" durationConditions2:= int32(3000) intervalConditions2:= int32(2000) var listConditionsEnlargeScene = []model.ScalingCondition{ { ConditionId: &conditionIdConditions, Duration: &durationConditions, Interval: &intervalConditions, MetricConditions: &listMetricConditionsConditions2, }, { ConditionId: &conditionIdConditions1, Duration: &durationConditions1, Interval: &intervalConditions1, MetricConditions: &listMetricConditionsConditions1, }, { ConditionId: &conditionIdConditions2, Duration: &durationConditions2, Interval: &intervalConditions2, MetricConditions: &listMetricConditionsConditions, }, } enlargeSceneCustomScalingConfig := &model.ScalingScene{ Conditions: &listConditionsEnlargeScene, } customScalingConfigbody := &model.CustomScalingConfig{ EnlargeScene: enlargeSceneCustomScalingConfig, } enlargeStepSizeServerlessScalingPolicy:= "2" request.Body = &model.ServerlessScalingPolicy{ CustomScalingConfig: customScalingConfigbody, EnlargeStepSize: &enlargeStepSizeServerlessScalingPolicy, } response, err := client.UpdateServerlessScalingPolicy(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=UpdateServerlessScalingPolicy)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success. | | 400 | Client error. | | 500 | Server error. | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。