API Overview
Last updated: 2019-12-14 14:24:34
PDF
API |
Action Name |
Description |
Create Scaling Configuration |
CreateScalingConfiguration |
Create a new scaling configuration and the user can specify its name and the CVM instance configuration it uses, and so on. |
Query Scaling Configuration |
DescribeScalingConfiguration |
Query the details of the corresponding scaling configuration based on the user input information, such as the scaling configuration ID, name, and so on. |
Delete Scaling Configuration |
DeleteScalingConfiguration |
Delete the corresponding scaling configuration according to the scaling configuration ID. |
API |
Action Name |
Description |
Create Scaling Group |
CreateScalingGroup |
Create a new scaling group, and the user can specify its name, the maximum and minimum group size and so on. |
Query Scaling Group List |
DescribeScalingGroup |
Query the details of the corresponding scaling group based on user input information such as the scaling group ID, name and so on. |
Modify Scaling Group |
ModifyScalingGroup |
Modify scaling group configuration, such as its name, the maximum and minimum scalability and so on. |
Query CVM Bound to Scaling Group |
DescribeScalingInstance |
Query the details of CVM bound to the scaling group based on its ID. |
Bind CVM to Scaling Group |
AttachInstance |
Bind CVM to scaling group based on the CVM ID and scaling group ID. |
Unbind CVM from Scaling Group |
DetachInstance |
Unbind CVM from scaling group based on the CVM ID and scaling group ID. |
Delete Scaling Group |
DeleteScalingGroup |
Delete the corresponding scaling group according to its ID. |
API |
Action Name |
Description |
Create Alarm Trigger Policy |
CreateScalingPolicy |
Create a new alarm trigger policy that allows users to create a scaling policy for a specific scaling group based on the scaling group ID. |
Query Alarm Trigger Policy |
DescribeScalingPolicy |
Query the specific scaling strategy used in the scaling activity triggered by the alarm according to the scaling group ID. |
Delete Alarm Trigger Policy |
DeleteScalingPolicy |
Delete a specific scaling policy in the specified scaling group based on the scaling group ID and the scaling policy ID. |
API Function |
Action Name |
Function Description |
Creates Scheduled Task |
CreateScheduledTask |
Creates a new scheduled task. The user can create a specific scheduled task for the specified scaling group according to the scaling group ID. |
Query Scheduled Task |
DescribeScheduledTask |
Query the details of all or specific scheduled tasks in a scaling group based on the scaling group ID or scheduled task ID. |
Modify Scheduled Task |
ModifyScheduledTask |
Modify the scheduled task configuration, such as modifying the scheduled task name, and setting the maximum and minimum size of the scaling group when the scheduled task is triggered. |
Delete Scheduled Task |
DeleteScheduledTask |
Delete a specific scheduled task in a specific scaling group based on the scaling group ID and the scheduled task ID. |
API Function |
Action Name |
Function Description |
Create Notification |
CreateScalingNotification |
Create a new notification; the user can create a specific scaling activity result notification for the specified scaling group according to the scaling group ID. |
Query Notification |
DescribeScalingNotification |
Query the details of all or specific notifications in a scaling group based on the scaling group ID or notification ID. |
Modify Notification |
ModifyScalingNotification |
Modify notification configuration, such as the notification type or recipient, and so on. |
Delete notification |
DeleteScalingNotification |
Delete a specific notification in a specific scaling group based on the scaling group ID and notification ID. |
API Function |
Action Name |
Function Description |
Create Lifecycle Hook |
CreateLifeCycleHook |
You can create up to 10 lifecycle hooks for each scaling group, but only one lifecycle hook takes effect at a time (you can call API "Bind Lifecycle Hook" to trigger the lifecycle hook to take effect). |
Modify Lifecycle Hook |
ModifyLifeCycleHook |
Modify the parameters of a lifecycle hook, including the name, timeout, default timeout action, callback trigger condition, and notification group of the life cycle hook. |
Query Lifecycle Hook |
DescribeLIfeCycleHook |
Query all lifecycle hooks or a specific lifecycle hook under a user group. |
Delete lifecycle Hook |
DeleteLifeCycleHook |
Delete a specific lifecycle hook in the scaling group. |
Bind Lifecycle Hook |
AttachLifeCycleHookId |
Bind the lifecycle hooks to the scaling group, activating the lifecycle hook that the scaling group currently needs to use. |
Unbind Lifecycle Hook |
DetachLifeCycleHookId |
Unbind lifecycle hooks from the scaling group; if you need to activate the lifecycle hooks, you should rebind them |
Lifecycle Hook Callback Completion Notification |
CompleteLifeCycleHookAction |
This API is used to complete the lifecycle hook callback in advance. |
Lifecycle Hook Timeout Renewal |
RecordLifeCycleHookTimeout |
It is used to renew a lifecycle hook timeout. |