Querying Auto Scaling Policies

Function

This API is used to query auto scaling policies. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain the value, call the API for obtaining a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value.
Content-Type	Yes	String	Content type. Value: application/json
X-Language	No	String	Request language type. The default value is en-us. Value range: en-us zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	ID of querying auto scaling policies.
instance_id	String	Instance ID.
instance_name	String	Instance name.
status	String	Whether auto scaling is enabled. Value: ON: enabled OFF: disabled
monitor_cycle	Integer	Observation period, in seconds. During the entire observation period, if the average CPU usage is greater than or equal to the preset value, a scale-up is triggered.
silence_cycle	Integer	Silent period, in seconds. It indicates the minimum interval between two auto scale-up operations or two scale-down operations.
enlarge_threshold	Integer	Average CPU usage.
max_flavor	String	Maximum specifications.
reduce_enabled	Boolean	Whether auto scale-down is enabled. Value: true: enabled false: disabled
min_flavor	String	Minimum instance specifications.
silence_start_at	String	Start time of the silent period (end time of the last change). The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.
scaling_strategy	ScalingStrategyInfo object	Auto scaling policy.
max_read_only_count	Integer	Maximum number of read replicas.
min_read_only_count	Integer	Minimum number of read replicas.
read_only_weight	Integer	Read weights of read replicas.

**Table 4** ScalingStrategyInfo
Parameter	Type	Description
flavor_switch	String	Whether instance specifications can be automatically scaled up or down. ON: Yes OFF: No
read_only_switch	String	Whether read replicas can be automatically added or deleted. ON: Yes OFF: No

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying auto scaling policies

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

Example Response

Status code: 200

Success.

Performing a query after auto scaling is enabled

{
  "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
}

Performing a query after auto scaling is disabled

{
  "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
}