Creating an AS Policy

Function

This API is used to create an AS policy.

An AS policy defines whether to increase or decrease the number of instances in an AS group. If the number and the expected number of instances in an AS group are different due to the execution of the AS policy, AS automatically adjusts the number of instances to the expected.
AS supports the following policies: alarm-triggered policy, periodic policy, and scheduled policy.
In the execution of the AS policy, you can set the number of instances to be scaled or perform a scaling action according to a percentage specified in the AS policy.

Authorization

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

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permission listed below is required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

as:scalingPolicy:create

write

-

g:EnterpriseProjectId

as:policies:create

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
as:scalingPolicy:create	write	-	g:EnterpriseProjectId	as:policies:create	-

URI

POST /autoscaling-api/v1/{project_id}/scaling_policy

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Specifies the project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
scaling_policy_name	Yes	String	Definition Specifies the AS policy name. Constraints N/A Range The value can contain 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Default Value N/A
scaling_group_id	Yes	String	Definition Specifies the AS group ID, which can be obtained using the API for querying AS groups. For details, see Querying AS Groups. Constraints N/A Range N/A Default Value N/A
scaling_policy_type	Yes	String	Definition Specifies the AS policy type. Constraints N/A Range ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm. SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled. RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically. Default Value N/A
alarm_id	No	String	Definition Specifies the alarm rule ID. After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value. You can obtain the parameter value by querying Cloud Eye alarm rules. For details, see Querying the Alarm Rule List in Cloud Eye API Reference. Constraints This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect. Range N/A Default Value N/A
scheduled_policy	No	scheduled_policy object	Definition Specifies the periodic or scheduled AS policy. For details, see Table 3. Constraints This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect.
scaling_policy_action	No	scaling_policy_action object	Definition Specifies the scaling action of the AS policy. For details, see Table 4. Constraints N/A
cool_down_time	No	Integer	Definition Specifies the cooldown period, in seconds. Constraints During the cooldown period, AS denies all scaling requests triggered by alarm-based policies. Scaling requests triggered manually or by scheduled or periodic policies are not affected. Range 0s to 86,400s Default Value 300

**Table 3** **scheduled_policy** field description
Parameter	Mandatory	Type	Description
launch_time	Yes	String	Definition Specifies the time when the scaling action is triggered. The time format complies with UTC. Constraints If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ. If scaling_policy_type is set to RECURRENCE, the time format is hh:mm. Range N/A Default Value N/A
recurrence_type	No	String	Definition Specifies the type of a periodically triggered scaling action. Constraints This parameter is mandatory when scaling_policy_type is set to RECURRENCE. Range Daily: The scaling action is triggered once a day. Weekly: The scaling action is triggered once a week. Monthly: The scaling action is triggered once a month. Default Value N/A
recurrence_value	No	String	Definition Specifies the day when a periodic scaling action is triggered. Constraints This parameter is mandatory when scaling_policy_type is set to RECURRENCE. Range If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day. If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5. If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28. Default Value N/A
start_time	No	String	Definition Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The time format is YYYY-MM-DDThh:mmZ. Constraints N/A Range N/A Default Value The default value is the current time.
end_time	No	String	Definition Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. The time format is YYYY-MM-DDThh:mmZ. Constraints This parameter is mandatory when scaling_policy_type is set to RECURRENCE. When the scaling action is triggered periodically, the end time cannot be earlier than the current or the start time. Range N/A Default Value N/A

**Table 4** **scaling_policy_action** field description
Parameter	Mandatory	Type	Description
operation	No	String	Definition Specifies the operation to be performed. Constraints N/A Range If scaling_resource_type is set to SCALING_GROUP, the following operations are supported: ADD: adds instances to the AS group. REMOVE/REDUCE: removes or reduces instances from the AS group. SET: sets the number of instances in the AS group. If scaling_resource_type is set to BANDWIDTH, the following operations are supported: ADD: increases the bandwidth. REDUCE: decreases the bandwidth. SET: sets the bandwidth to a fixed value. Default Value ADD
instance_number	No	Integer	Definition Specifies the number of instances to be operated. Constraints Either instance_number or instance_percentage is required. Range If operation is set to SET, the value ranges from 0 to 300. If operation is set to ADD, REMOVE, or REDUCE, the value ranges from 1 to 300. Default Value 1
instance_percentage	No	Integer	Definition Specifies the percentage of instances to be operated. You can increase, decrease, or set the number of instances in an AS group to the specified percentage of the current number of instances. Either instance_number or instance_percentage is required. Constraints If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1. Either instance_number or instance_percentage is required. Range If operation is set to ADD, REMOVE, or REDUCE, the value is an integer ranging from 1 to 20000. If operation is set to SET, the value is an integer ranging from 0 to 20000. Default Value N/A

Example Request

This example creates a periodic AS policy named as-policy-7a75. The policy takes effect from 2015-12-14T03:34Z to 2015-12-27T03:34Z. During this period, one instance will be added to AS group with ID 5bc3aa02-b83e-454c-aba1-4d2095c68f8b at 16:00 every day.

POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy

{
    "scaling_policy_name": "as-policy-7a75",
    "scaling_policy_action": {
        "operation": "ADD",
        "instance_number": 1
    },
    "cool_down_time": 900,
    "scheduled_policy": {
        "launch_time": "16:00",
        "recurrence_type": "Daily",
        "start_time": "2015-12-14T03:34Z",
        "end_time": "2015-12-27T03:34Z"
    },
    "scaling_policy_type": "RECURRENCE",
    "scaling_group_id": "5bc3aa02-b83e-454c-aba1-4d2095c68f8b"
}

Response

**Table 5** Response parameters
Parameter	Type	Description
scaling_policy_id	String	Definition Specifies the AS policy ID. Range N/A

Example Response

{
    "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"
}

Returned Values

Normal
200

Abnormal

Returned Value	Description
400 Bad Request	The server failed to process the request.
401 Unauthorized	You must enter the username and password to access the requested page.
403 Forbidden	You are forbidden to access the requested page.
404 Not Found	The server could not find the requested page.
405 Method Not Allowed	You are not allowed to use the method specified in the request.
406 Not Acceptable	The response generated by the server could not be accepted by the client.
407 Proxy Authentication Required	You must use the proxy server for authentication to process the request.
408 Request Timeout	The request timed out.
409 Conflict	The request could not be processed due to a conflict.
500 Internal Server Error	Failed to complete the request because of an internal service error.
501 Not Implemented	Failed to complete the request because the server does not support the requested function.
502 Bad Gateway	Failed to complete the request because the request is invalid.
503 Service Unavailable	Failed to complete the request because the system is unavailable.
504 Gateway Timeout	A gateway timeout error occurred.

Error Codes

See Error Codes.

Parent topic: AS Policies

Previous topic: AS Policies

Next topic: Creating an AS Policy (V2)