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

查询自动变配

功能介绍

查询自动变配。

URI

GET /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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

自动变配策略ID。

instance_id

String

实例ID。

instance_name

String

实例名称。

status

String

自动变配开关状态。

取值：

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

monitor_cycle

Integer

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

silence_cycle

Integer

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

enlarge_threshold

Integer

扩容阈值（百分比数值），指CPU平均使用率。

max_flavor

String

扩容规格上限。

reduce_enabled

Boolean

自动回缩开关状态。

取值：

  • true：已开启
  • false：已关闭

min_flavor

String

缩容规格下限。

silence_start_at

String

静默期开始时间（上一次变更结束时间）。

格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

scaling_strategy

ScalingStrategyInfo object

自动变配策略。

max_read_only_count

Integer

只读节点数量上限。

min_read_only_count

Integer

只读节点数量下限。

read_only_weight

Integer

只读节点读写分离权重。
表4 ScalingStrategyInfo

参数

参数类型

描述

flavor_switch

String

扩缩规格开关。

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

read_only_switch

String

增删只读节点开关。

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

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询自动变配。

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/auto-scaling/policy

响应示例

状态码： 200

Success.

  • 自动变配开启时查询自动变配。
    {
  "id" : "26d8e193-1ea0-4adb-89d0-d1343399d0e7",
  "instance_id" : "41ff7519e22d44eea6066615fa5b17c7in07",
  "instance_name" : "gauss-test-1",
  "status" : "ON",
  "monitor_cycle" : 300,
  "silence_cycle" : 300,
  "enlarge_threshold" : 50,
  "max_flavor" : "gaussdb.mysql.large.x86.4",
  "reduce_enabled" : false,
  "min_flavor" : "gaussdb.mysql.medium.x86.4",
  "silence_start_at" : "2023-08-31T08:59:09+0000",
  "scaling_strategy" : {
    "flavor_switch" : "ON",
    "read_only_switch" : "ON"
  },
  "max_read_only_count" : 2,
  "min_read_only_count" : 1,
  "read_only_weight" : 10
}
  • 自动变配关闭时查询自动变配。
    {
  "id" : null,
  "instance_id" : "41ff7519e22d44eea6066615fa5b17c7in07",
  "instance_name" : "gauss-test-1",
  "status" : "OFF",
  "monitor_cycle" : null,
  "silence_cycle" : null,
  "enlarge_threshold" : null,
  "max_flavor" : null,
  "reduce_enabled" : null,
  "min_flavor" : null,
  "silence_start_at" : "",
  "scaling_strategy" : {
    "flavor_switch" : "",
    "read_only_switch" : ""
  },
  "max_read_only_count" : null,
  "min_read_only_count" : null,
  "read_only_weight" : null
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 实例管理