设置自动变配
接口约束
该接口目前公测阶段,如需使用,请提交工单联系客服人员申请权限。
URI
PUT /v3/{project_id}/instances/{instance_id}/auto-scaling/policy
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认取值: application/json。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
status |
是 |
String |
参数解释: 自动变配开关状态。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
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 |
参数解释: 是否开启自动回缩。 约束限制: 开启自动变配时必填。 取值范围: 默认取值: 不涉及。 |
max_read_only_count |
否 |
Integer |
参数解释: 只读节点数量上限。 约束限制: 开启增删只读节点时必填。 取值范围: 2-15。 默认取值: 不涉及。 |
read_only_weight |
否 |
Integer |
参数解释: 只读节点读写分离权重。 约束限制: 开启增删只读节点时必填。 取值范围: 不涉及。 默认取值: 0-1000。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
flavor_switch |
是 |
String |
参数解释: 扩缩规格开关。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
read_only_switch |
是 |
String |
参数解释: 增删只读节点开关。 约束限制: 自动增删只读节点功能需要先开启数据库代理,且只能有一个代理。 取值范围: 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instance_id |
String |
参数解释: 实例ID。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
instance_name |
String |
参数解释: 实例名称。 取值范围: 最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。 |
switch_status |
AutoScalingSwitchStatus object |
参数解释: 开关状态。 |
参数 |
参数类型 |
描述 |
---|---|---|
scaling_switch |
String |
参数解释: 自动变配开关状态。 取值范围: |
flavor_switch |
String |
参数解释: 扩缩规格开关状态。 取值范围: |
read_only_switch |
String |
参数解释: 增删只读节点开关状态。 取值范围: |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
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" } }
状态码
请参见状态码。
错误码
请参见错误码。