Creating an AS Policy (V2)¶
Function¶
This API is used to create an AS policy for an AS group or bandwidth.
The difference between the V2 and V1 APIs for creating an AS policy is that V2 supports creating an AS policy for adjusting bandwidth and differentiating scaling resources by their types.
URI¶
POST /autoscaling-api/v2/{project_id}/scaling_policy
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Specifies the project ID. |
Request¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
scaling_policy_name | Yes | String | Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters. |
scaling_resource_id | Yes | String | Specifies the scaling resource ID, which is the unique ID of an AS group or bandwidth.
|
scaling_resource_type | Yes | String | Specifies the scaling resource type.
|
scaling_policy_type | Yes | String | Specifies the AS policy type.
|
alarm_id | No | String | Specifies the alarm rule ID. 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. 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. |
scheduled_policy | No | scheduled_policy object | Specifies the periodic or scheduled AS policy. 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. For details, see Table 3. |
scaling_policy_action | No | scaling_policy_action object | Specifies the scaling action of the AS policy. For details, see Table 4. |
cool_down_time | No | Integer | Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default. |
description | No | String | Specifies the description of the AS policy. The value can contain 1 to 256 characters. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
launch_time | Yes | String | Specifies the time when the scaling action is triggered. The time format complies with UTC.
|
recurrence_type | No | String | Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.
|
recurrence_value | No | String | Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.
|
start_time | No | String | Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time. The time format is YYYY-MM-DDThh:mmZ. |
end_time | No | String | Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. 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 and start time. The time format is YYYY-MM-DDThh:mmZ. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
operation | No | String | Specifies the operation to be performed. The default operation is ADD.
|
size | No | Integer | Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET.
|
percentage | No | Integer | Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.
|
limits | No | Integer | Specifies the operation restrictions. If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.
|
Example Request¶
This example creates an alarm-based scaling policy named hth_aspolicy_1 using the alarm rule with ID al1513822380493GvlJKZwA8. The action defined in the policy is to increase the bandwidth with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6 by 1 Mbit/s when the alarm threshold configured in the alarm rule is reached until the bandwidth reaches 10 Mbit/s.
POST https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy
{
"alarm_id": "al1513822380493GvlJKZwA8",
"cool_down_time": 900,
"scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
"scaling_resource_type": "BANDWIDTH",
"scaling_policy_action": {
"size": 1,
"operation": "ADD",
"limits": 10
},
"scaling_policy_name": "hth_aspolicy_1",
"scaling_policy_type": "ALARM"
}
Response¶
Parameter | Type | Description |
|---|---|---|
scaling_policy_id | String | Specifies the AS policy ID. |
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.