文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ 实例管理/ 设置Serverless自定义扩容策略 - UpdateServerlessScalingPolicy
更新时间:2025-10-16 GMT+08:00
分享

设置Serverless自定义扩容策略 - UpdateServerlessScalingPolicy

功能介绍

设置Serverless自定义扩容策略。

接口约束

该接口目前公测阶段,如需使用,请提交工单联系客服人员申请权限。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:serverless:updateScalingPolicy

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    • gaussdb:serverless:updateScalingPolicy

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/serverless/scaling-policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“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

参数描述

自定义扩容策略。

约束限制

不涉及。

表4 CustomScalingConfig

参数

是否必选

参数类型

描述

enlarge_scene

ScalingScene object

参数描述

自定义扩容策略。

约束限制

不涉及。

表5 ScalingScene

参数

是否必选

参数类型

描述

conditions

Array of ScalingCondition objects

参数解释:

变配条件。

约束限制

不涉及。

表6 ScalingCondition

参数

是否必选

参数类型

描述

condition_id

String

参数描述:

变配条件名称。

约束限制

不涉及。

取值范围

只能由英文字母、数字和中划线组成,且长度不超过32个字符,不能为空。

默认取值

不涉及。

duration

Integer

参数描述

持续时间,单位是毫秒。

约束限制

不涉及。

取值范围

2000-5000。

默认取值

不涉及。

interval

Integer

参数解释:

间隔时间,单位是毫秒。

约束限制

不涉及。

取值范围

1000-5000。

默认取值

不涉及。

metric_conditions

Array of MetricCondition objects

参数描述:

指标变配条件。

约束条件

不涉及。

表7 MetricCondition

参数

是否必选

参数类型

描述

metric_name

String

参数描述:

指标名称。

约束限制

不涉及。

取值范围

  • cpuTotalUsage:CPU使用率。

  • memoryTotalUsage:内存使用率。

默认取值

不涉及。

metric_value

Integer

参数描述

指标变配阈值。

约束限制

取值为百分比的10000倍,比如50%对应的参数值为5000。

取值范围

6000-8000。

默认取值

不涉及。

compare_mode

String

参数描述

比较模式。

约束限制

不涉及。

取值范围

GT:大于。

默认取值

不涉及。

响应参数

状态码:200

表8 响应Body参数

参数

参数类型

描述

enlarge_step_size

String

参数描述

自定义扩容步长。

约束限制

不涉及。

取值范围

2-算力上限的一半。

默认取值

不涉及。

custom_scaling_config

CustomScalingConfig object

参数描述

自定义扩容策略。

约束限制

不涉及。

表9 CustomScalingConfig

参数

参数类型

描述

enlarge_scene

ScalingScene object

参数描述

自定义扩容策略。

约束限制

不涉及。

表10 ScalingScene

参数

参数类型

描述

conditions

Array of ScalingCondition objects

参数解释:

变配条件。

约束限制

不涉及。

表11 ScalingCondition

参数

参数类型

描述

condition_id

String

参数描述:

变配条件名称。

约束限制

不涉及。

取值范围

只能由英文字母、数字和中划线组成,且长度不超过32个字符,不能为空。

默认取值

不涉及。

duration

Integer

参数描述

持续时间,单位是毫秒。

约束限制

不涉及。

取值范围

2000-5000。

默认取值

不涉及。

interval

Integer

参数解释:

间隔时间,单位是毫秒。

约束限制

不涉及。

取值范围

1000-5000。

默认取值

不涉及。

metric_conditions

Array of MetricCondition objects

参数描述:

指标变配条件。

约束条件

不涉及。

表12 MetricCondition

参数

参数类型

描述

metric_name

String

参数描述:

指标名称。

约束限制

不涉及。

取值范围

  • cpuTotalUsage:CPU使用率。

  • memoryTotalUsage:内存使用率。

默认取值

不涉及。

metric_value

Integer

参数描述

指标变配阈值。

约束限制

取值为百分比的10000倍,比如50%对应的参数值为5000。

取值范围

6000-8000。

默认取值

不涉及。

compare_mode

String

参数描述

比较模式。

约束限制

不涉及。

取值范围

GT:大于。

默认取值

不涉及。

状态码:400

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表14 响应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

Success.

{ }

SDK代码示例

SDK代码示例如下。

设置Serverless自定义扩容策略。

  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
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
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("<YOUR REGION>"))
                .build();
        UpdateServerlessScalingPolicyRequest request = new UpdateServerlessScalingPolicyRequest();
        request.withInstanceId("{instance_id}");
        ServerlessScalingPolicy body = new ServerlessScalingPolicy();
        List<MetricCondition> listConditionsMetricConditions = new ArrayList<>();
        listConditionsMetricConditions.add(
            new MetricCondition()
                .withMetricName("memoryTotalUsage")
                .withMetricValue(8000)
                .withCompareMode("GT")
        );
        List<MetricCondition> listConditionsMetricConditions1 = new ArrayList<>();
        listConditionsMetricConditions1.add(
            new MetricCondition()
                .withMetricName("cpuTotalUsage")
                .withMetricValue(6000)
                .withCompareMode("GT")
        );
        List<MetricCondition> listConditionsMetricConditions2 = new ArrayList<>();
        listConditionsMetricConditions2.add(
            new MetricCondition()
                .withMetricName("cpuTotalUsage")
                .withMetricValue(8000)
                .withCompareMode("GT")
        );
        List<ScalingCondition> 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());
        }
    }
}

设置Serverless自定义扩容策略。

 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
82
83
# 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("<YOUR REGION>")) \
        .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)

设置Serverless自定义扩容策略。

  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
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档