文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 实例管理/ 设置Serverless自定义扩容策略- UpdateServerlessScalingPolicy
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置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值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表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.

{ }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理