Creating an Auto Scaling policy - CreateAutoScalingPolicy

Function

This API is used to create an auto scaling policy.

Constraints

None

Debugging

You can debug this API in API Explorer, which supports automatic authentication and authorization. API Explorer can automatically generate sample SDK code and supports sample SDK code debugging.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

POST /v2/{project_id}/autoscaling-policy/{cluster_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Value range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default value N/A
cluster_id	Yes	String	Explanation Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
node_group_name	Yes	String	Definition Node group name. Constraints N/A Range This parameter is mandatory. If resource_pool_name is set to default, the auto scaling policies are created by node group. If resource_pool_name is not set to default, policies of the resource pool corresponding to the node group are created. Default Value N/A
resource_pool_name	Yes	String	Definition Pool name. Constraints N/A Range This parameter is mandatory. If the cluster version does not support auto scaling for a specified resource pool, set this parameter to default. If this parameter is not default, the auto scaling policy of the specified resource pool is deleted. Default Value N/A
auto_scaling_policy	Yes	AutoScalingPolicyInfo object	Definition Auto scaling rule. For details about the parameters, see Table 3. Constraints N/A Range N/A Default Value N/A

**Table 3** AutoScalingPolicyInfo
Parameter	Mandatory	Type	Description
auto_scaling_enable	No	Boolean	Definition Whether to enable the auto scaling rule. Constraints N/A Range true: Enable the auto scaling rule. false: Disable the autoscaling rule. Default Value N/A
min_capacity	No	Integer	Definition Minimum number of nodes left in the node group. Constraints N/A Range 0-500 Default Value N/A
max_capacity	No	Integer	Definition Maximum number of nodes in the node group. Constraints N/A Range 0-500 Default Value N/A
resources_plans	No	Array of ResourcesPlan objects	Definition Resource plans. For details, see Table 4. If this parameter is left blank, the resource plan is disabled. Constraints When auto_scaling_enable is set to true, either this parameter or rules must be configured. A maximum of five records are allowed. Range N/A Default Value N/A
rules	No	Array of Rule objects	Definition Auto scaling rules. For details, see Table 5. Constraints When auto_scaling_enable is set to true, either this parameter or rules must be configured. The number of records cannot exceed 10. Range N/A Default Value N/A
tags	No	Array of Tag objects	Definition Tags of an auto scaling rule. For details about the parameters, see Table 7. Constraints The number of records cannot exceed 100. Range N/A Default Value N/A

**Table 4** ResourcesPlan
Parameter	Mandatory	Type	Description
period_type	Yes	String	Definition Cycle type of a resource plan. This parameter can be set to daily only. Constraints N/A Range daily: Charges are calculated by day. Default Value N/A
start_time	Yes	String	Definition Start time of a resource plan. The value is in the format of hour:minute, indicating that the time ranges from 00:00 to 23:59. Constraints N/A Range N/A Default Value N/A
end_time	Yes	String	Definition End time of a resource plan. The format is the same as that of start_time. Constraints The value cannot be earlier than the start_time, and the interval between start_time and start_time cannot be less than 30 minutes. Range N/A Default Value N/A
min_capacity	Yes	Integer	Definition Minimum number of the preserved nodes in a node group in a resource plan. Constraints N/A Range 0-500 Default Value N/A
max_capacity	Yes	Integer	Definition Maximum number of the preserved nodes in a node group in a resource plan. Constraints N/A Range 0-500 Default Value N/A
effective_days	No	Array of strings	Definition The effective date of a resource plan. If this parameter is left blank, it indicates that the resource plan takes effect every day. The options are as follows: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY Constraints N/A Range N/A Default Value N/A

**Table 5** Rule
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Name of an auto scaling rule. Constraints N/A Range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Rule names must be unique in a node group. Default Value N/A
description	No	String	Definition Description about an auto scaling rule. Constraints N/A Range The value can contain 0 to 1024 characters. Default Value N/A
adjustment_type	Yes	String	Definition Adjustment type of an auto scaling rule. Constraints N/A Range scale_out: cluster scale-out scale_in: cluster scale-in Default Value N/A
cool_down_minutes	Yes	Integer	Definition Cluster cooling time after an auto scaling rule is triggered, when no auto scaling operation is performed. The unit is minute. Constraints N/A Range The value ranges from 0 to 10080. 10080 indicates the number of minutes in a week. Default Value N/A
scaling_adjustment	Yes	Integer	Definition Number of nodes that can be adjusted once. Constraints N/A Range 1-100 Default Value N/A
trigger	Yes	Trigger object	Definition Condition for triggering a rule. For details, see Table 6. Constraints N/A Range N/A Default Value N/A

**Table 6** Trigger
Parameter	Mandatory	Type	Description
metric_name	Yes	String	Definition Metric name. This triggering condition makes a judgment according to the value of the metric. Constraints N/A Range For details about the value range, see Auto scaling metrics. Default Value N/A
metric_value	Yes	String	Definition Metric threshold to trigger a rule. The value must be an integer or a number with two decimal places. Constraints N/A Range Only integers or numbers with two decimal places are allowed. Default Value N/A
comparison_operator	No	String	Definition Metric judgment logic operator. Constraints N/A Range LT: less than GT: greater than LTOE: less than or equal to GTOE: greater than or equal to Default Value N/A
evaluation_periods	Yes	Integer	Definition Number of consecutive five-minute periods, during which a metric threshold is reached. Constraints N/A Range 1-288 Default Value N/A

**Table 7** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Definition Tag key. Constraints N/A Range A tag key can contain letters, digits, spaces, and special characters _.:=+-@, but cannot start or end with a space or start with _sys_. The tag key of a resource must be unique. It can contain a maximum of 128 Unicode characters and cannot be an empty string. Default Value N/A
value	Yes	String	Definition Tag value. Constraints N/A Range The value can contain letters, digits, spaces, and special characters _.:=+-@, but cannot start or end with a space or start with _sys_. The value can contain a maximum of 255 Unicode characters and can be an empty string. Default Value N/A

Response Parameters

None

Example Request

Create an auto scaling policy, set the number of node groups in node_group_1 to 0 to 5, and configure two scaling rules. If the value of YARNAppRunning is greater than or equal to 75 for one 5-minute period, add one Task node. If the value of YARNAppRunning is less than or equal to 25 for one 5-minute period, stop one Task node. The cooling duration is 20 minutes, and the aaa=bbb label is added to the involved nodes.

/v2/{project_id}/autoscaling-policy/{cluster_id}

{
  "node_group_name" : "node_group_1",
  "auto_scaling_policy" : {
    "auto_scaling_enable" : true,
    "min_capacity" : 0,
    "max_capacity" : 5,
    "rules" : [ {
      "name" : "default-expand-1",
      "adjustment_type" : "scale_out",
      "cool_down_minutes" : 20,
      "scaling_adjustment" : 1,
      "trigger" : {
        "metric_name" : "YARNAppRunning",
        "metric_value" : "75",
        "comparison_operator" : "GT",
        "evaluation_periods" : 1
      }
    }, {
      "name" : "default-shrink-1",
      "adjustment_type" : "scale_in",
      "cool_down_minutes" : 20,
      "scaling_adjustment" : 1,
      "trigger" : {
        "metric_name" : "YARNAppRunning",
        "metric_value" : "25",
        "comparison_operator" : "LT",
        "evaluation_periods" : 1
      }
    } ],
    "resources_plans" : [ {
      "period_type" : "daily",
      "start_time" : "06:00",
      "end_time" : "20:00",
      "min_capacity" : "0",
      "max_capacity" : "2",
      "effective_days" : [ "MONDAY" ]
    } ],
    "tags" : [ {
      "key" : "aaa",
      "value" : "bbb"
    } ]
  },
  "resource_pool_name" : "default"
}