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	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition Content type. Constraints N/A Range application/json Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition ID of an auto scaling policy. Range N/A
instance_id	String	Definition Instance ID. Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.
instance_name	String	Definition Instance name. Range The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.
status	String	Definition Whether auto scaling is enabled. Range ON: enabled OFF: disabled
monitor_cycle	Integer	Definition 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. Range 300 600 900 1800
silence_cycle	Integer	Definition Silent period, in seconds. It indicates the minimum interval between two auto scale-up operations or two auto scale-down operations. Range 300 600 1800 3600 7200 10800 86400 604800
enlarge_threshold	Integer	Definition Average CPU usage. Range 50-100
max_flavor	String	Definition Maximum specifications. Range Maximum specifications that can be changed for an instance at the current site.
reduce_enabled	Boolean	Definition Whether auto scale-down is enabled. Range true: enabled false: disabled
min_flavor	String	Definition Minimum specifications. Range Minimum specifications that can be changed for an instance at the current site.
silence_start_at	String	Definition 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 offset is +0800. Range N/A
scaling_strategy	ScalingStrategyInfo object	Definition Auto scaling policy.
max_read_only_count	Integer	Definition Maximum number of read replicas. Range 2 ≤ Number of current read replicas < Preset value ≤ 15
min_read_only_count	Integer	Definition Minimum number of read replicas. Range 1–14
read_only_weight	Integer	Definition Read weights of read replicas. Range 0–1000

**Table 4** ScalingStrategyInfo
Parameter	Type	Description
flavor_switch	String	Definition Whether instance specifications can be automatically scaled up or down. Range ON: Yes OFF: No
read_only_switch	String	Definition Whether read replicas can be automatically added or deleted. Range 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
}