文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 实例管理> 设置自动变配
更新时间：2024-02-27 GMT+08:00
在线调试
CLI示例
查看PDF

设置自动变配

功能介绍

设置自动变配。

接口约束

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

Content-Type

是

String

内容类型。

取值：application/json。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

status

是

String

自动变配开关状态。

取值：

  • ON：开启。
  • OFF：关闭。

scaling_strategy

是

ScalingStrategyReqInfo object

自动变配策略。

monitor_cycle

否

Integer

监测周期（单位：秒）。 在整个观测窗口期内，若CPU平均使用率大于等于设定值，则在观测窗口结束后，进行扩容。

取值范围：300、600、900、1800。

status为ON时必填。

silence_cycle

否

Integer

静默周期（单位：秒）。 两次自动扩容或自动回缩的最小间隔时间。

取值范围：300、600、1800、3600、7200、10800、86400、604800。

status为ON时必填。

enlarge_threshold

否

Integer

CPU平均使用率（百分比数值）。

取值范围：50-100。

status为ON时必填。

max_flavor

否

String

扩容规格上限。开启扩缩规格时必填。

reduce_enabled

否

Boolean

是否开启自动回缩。开启自动变配时必填。

  • true：是。
  • false：否。

max_read_only_count

否

Integer

只读节点数量上限。开启增删只读节点时必填。

read_only_weight

否

Integer

只读节点读写分离权重。开启增删只读节点时必填。
表4 ScalingStrategyReqInfo

参数

是否必选

参数类型

描述

flavor_switch

是

String

扩缩规格开关。

  • ON：开启。
  • OFF：关闭。

read_only_switch

是

String

增删只读节点开关。自动增删只读节点功能需要先开启数据库代理，且只能有一个代理。

  • ON：开启。
  • OFF：关闭。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

instance_id

String

实例ID。

instance_name

String

实例名称。

switch_status

AutoScalingSwitchStatus object

开关状态。
表6 AutoScalingSwitchStatus

参数

参数类型

描述

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

Success.

{
  "instance_id" : "61a4ea66210545909d74a05c27a7179ein07",
  "instance_name" : "gauss-test-1",
  "switch_status" : {
    "scaling_switch" : "ON",
    "flavor_switch" : "ON",
    "read_only_switch" : "ON"
  }
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理