平安云|Ping An Cloud- Building Your Smart Future

API Description

1. AddVmToScalingGroup Interface Description Manually add ECS into the scaling group (1) to check whether the ECS can join the scaling group, whether it is in the same vpc, region, and available area, and whether it exceeds the maximum number of ECS instances. Besides that the status of both the ECS and the scaling group must be Running (2) only if there is a health problem the instance will remove scaling groups, modify configuration, schedule tasks and alert tasks. Manually added ECS which participate only in counting will not be removed. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> InstanceIds </td> <td> String </td> <td> Yes </td> <td> ECS instance ID array: ECS instance added into the scaling group must be in the same region, the same available area, and the same VPC with the group, and the status of the ECS must be in the Running mode. </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> Yes </td> <td> The unique identification of scaling group: scaling group Id </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   2. CreateAutoScalingAlarmTask Interface Description CreateAutoScalingAlarmTask： Alarm tasks of  scaling groups is to monitor the performance of ECS such as cpu.busy. Users need to set monitoring items, monitoring functions, alarm times, alarm threshold, and scaling rules. When the alarm task is triggered, the scaling group will scale according to the current scaling rules. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> yes </td> <td> Display name of the alarm tasks of scaling groups. </td> <td>   </td> </tr> <tr> <td> GroupId </td> <td> String </td> <td> yes </td> <td> The unique identification of elastic scaling groups: scaling group Id. </td> <td>   </td> </tr> <tr> <td> RuleId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling rules: scaling rules Id. </td> <td>   </td> </tr> <tr> <td> MonitorItemType </td> <td> MonitorItemType </td> <td> yes </td> <td> Monitoring Item: Monitor items are  available at this stage: lvxRealServer("lvx.RealServer.Status"),CPU("cpu.busy"), MEM("mem.memused.percent"),NET("net.if.total.bytes") </td> <td>   </td> </tr> <tr> <td> MonitorFunType </td> <td> MonitorFunType </td> <td> yes </td> <td> Monitoring <a href="http://dict.youdao.com/w/statistical%20function/#keyfrom=E2Ctranslation">statistical function</a>：min、max、avg、count、rate count </td> <td>   </td> </tr> <tr> <td> Times </td> <td> Integer </td> <td> yes </td> <td> Continuous alarming times. </td> <td>   </td> </tr> <tr> <td> Operator </td> <td> OperatorType </td> <td> yes </td> <td> Example of defining expression function: lt("<"),elt("<="),eq("=="),neq("!="),gt(">"),egt(">="), </td> <td>   </td> </tr> <tr> <td> RightValue </td> <td> Double </td> <td> yes </td> <td> <a href="http://dict.youdao.com/w/threshold%20value/#keyfrom=E2Ctranslation">Threshold value</a> </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   3. CreateAutoScalingGroup Interface Description CreateAutoScalingGroup： Creating a scaling group requires setting up ELB, listener, minimum and maximum instance number, quiet strategies, etc. ELB and listener provide the data sources for health checks. The minimum and maximum instance number specify the instance scope of the ECS scaling groups. Quiet strategies: the way of the ECS quiet from scaling groups during scaling activities. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region information could be obtained by calling the interface of ListRegions, details please refer to ListRegions interface. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> Zone information could be obtained by calling listZone interface, details please refer to listZone interface. </td> <td>   </td> </tr> <tr> <td> MaxNum </td> <td> Integer </td> <td> yes </td> <td> Maximum instance number: Maximum ECS running data in the scaling group, with a range of [1,20] </td> <td>   </td> </tr> <tr> <td> MinNum </td> <td> Integer </td> <td> yes </td> <td> Minimum instance number: The smallest numbers of running ECS in the scaling group, with a range of [1,10] </td> <td>   </td> </tr> <tr> <td> QuitPolicy </td> <td> QuitPolicyType </td> <td> yes </td> <td> Quit Policy: There are two quit policies for ECS to exit the scaling groups: Latest Exit and First Exit. The latest exit policy: Based on the creation time, the newly created ECS will exit the scaling groups when conducting scaling tasks. The first exit policy: Based on the creation time, the earliest created ECS will exit the scaling groups when conducting scaling tasks. </td> <td>   </td> </tr> <tr> <td> CoolingTime </td> <td> Integer </td> <td> yes </td> <td> Cooling time: The time interval between the two scaling tasks of the group. There is no scaling activities triggered during the cooling time, and the value range is: [300,9999] </td> <td>   </td> </tr> <tr> <td> LoadbalanceId </td> <td> String </td> <td> yes </td> <td> ELB: The information about Loadbalance could be obtained by calling the interface of ListLoadbalances, details please refer to ListLoadbalances interface. </td> <td>   </td> </tr> <tr> <td> ListenerId </td> <td> String </td> <td> yes </td> <td> Listener: Obtain corresponding listener according to the ELB, details please refer to ListListeners interface. </td> <td>   </td> </tr> <tr> <td> IsRelResources </td> <td> Boolean </td> <td> yes </td> <td> Whether to release resources: Whether to conduct release action to the ECS (now shutdown) when it exits the scaling group, which defaults as no release. </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> no </td> <td> Description：matching this expression function： "^[一-龥a-zA-Z][一-龥a-zA-Z0-9-_@]{0,19}$" </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   4. CreateAutoScalingGroupConfig Interface Description Creating configuration for the scaling group. When a scaling group is triggered to conducting scaling activities, an ECS is created on the bases of the scaling group configuration and is defined in it. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region：This region decide the location of ECS created by users. The information of Region could be obtained by calling the interface of ListRegions, details please refer to ListEegions interface. </td> <td>   </td> </tr> <tr> <td> ZoneId </td> <td> String </td> <td> yes </td> <td> Available zone: The information of Zone could be obtained by calling the interface of listZones, details pleaserefer to listZones interface. </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> yes </td> <td> High available zone: The information of High available Zone could be obtained by calling the interface of ListPods, details please refer to ListPods interface. </td> <td>   </td> </tr> <tr> <td> NetworkId </td> <td> String </td> <td> yes </td> <td> Network domain: Vpc and its network domain should be selected when creating ECS. The information of Vpc could be obtained by calling the interface of SelectVpcItem,  with the Id of Vpc as parameter and call SelectNetworkItem interface to obtain information about network. </td> <td>   </td> </tr> <tr> <td> Port </td> <td> Integer </td> <td> yes </td> <td> Listen port: range[1, 65535] </td> <td>   </td> </tr> <tr> <td> Weight </td> <td> Integer </td> <td> no </td> <td> Weight: range  [1, 100]，and default value is 10. </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> yes </td> <td> Mirror image: Creating template for ECS and can be obtained by calling the interface of ListImages. Specific information may refer to ListImges interface. </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> no </td> <td> Safety groups: The information of safety groups could be obtained by calling the interface of ListSecurityGroups. details please  refer to ListSecurityGroups interface. </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> yes </td> <td> ECS specification：The product name of ECS is Instance. Product series can be obtained by calling  the interface of ListProductSeries as in parameter. Products has its own specification, and the corresponding specifications of one product can be obtained by calling the interface of ListInstanceTypes by product series in parameter. Details please  refer to the interface of ListProductSeries and ListInstanceTypes. </td> <td>   </td> </tr> <tr> <td> ChargeType </td> <td> ChargeType </td> <td> no </td> <td> Billing Method: charge by the hour, usage, preusage, monthly, free and annual. </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> no </td> <td> Disk type: Each kind of ECS has its own disk series. Corresponding disk series can be obtained by calling interface  ListEbsProductSeries with the series of ECS as parameter. Disk series can be obtained by calling interface  ListEbsTypes Details please  refer to the interfaces of ListProductSeries，ListEbsProductSeries and ListEbsTypes. </td> <td>   </td> </tr> <tr> <td> DiskSizes </td> <td> Integer[] </td> <td> no </td> <td> The size of Disk, range[20，5000] </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> no </td> <td> Notes </td> <td>   </td> </tr> <tr> <td> ASGroupId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling groups Id. </td> <td>   </td> </tr> <tr> <td> FunctionNames </td> <td> String </td> <td> no </td> <td> Function name. </td> <td>   </td> </tr> <tr> <td> PodSelectStrategy </td> <td> PodSelectStrategy </td> <td> no </td> <td> High available zone selecting policy: When scaling groups conduct scaling tasks and creating ECS, there are two choice of selecting high available zone. Polling and Specify. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   5. CreateAutoScalingRule Interface Description Creating scaling rules: when creating alarm tasks and timed tasks, and when the task performing scaling groups uses this group to scale, scaling rules are needed. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of scaling rules: Matching with this expression function: "^[一-龥a-zA-Z][一-龥a-zA-Z0-9-_@]{0,19}$" </td> <td>   </td> </tr> <tr> <td> ChangeNum </td> <td> Integer </td> <td> yes </td> <td> The number of ECS added or removed  from scaling groups during every scaling activities. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   6. CreateAutoScalingScheduledTask Interface Description Creating scheduled tasks for scaling groups: If scaling groups are configured with scheduled tasks, they will perform tasks according to the scaling rules. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> yes </td> <td> Display name of scheduled tasks. </td> <td>   </td> </tr> <tr> <td> GroupId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> <tr> <td> RuleId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling rules: scaling rule Id. </td> <td>   </td> </tr> <tr> <td> ExecuteTime </td> <td> String </td> <td> yes </td> <td> Execute Time. </td> <td>   </td> </tr> <tr> <td> RepeatType </td> <td> RepeatType </td> <td> yes </td> <td> Timed task repeat period：Once, Daily, Weekly, Monthly </td> <td>   </td> </tr> <tr> <td> SpecificTime </td> <td> String </td> <td> no </td> <td> Repeat type as weekly: need to specify the day of a week, and usually marked as MON, FRI ect. Repeat type as monthly: need to specify the day of a month, and usually marked with number or L (refers to the last day of a month.) </td> <td>   </td> </tr> <tr> <td> BeginTime </td> <td> String </td> <td> no </td> <td> The begin time of timed tasks. </td> <td>   </td> </tr> <tr> <td> EndTime </td> <td> String </td> <td> no </td> <td> The end time of timed tasks. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   7. DeleteAutoScalingAlarmTask Interface Description Delete alarm tasks of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of alarm tasks: alarm tasks Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   8. DeleteAutoScalingGroup Interface Description The action of deleting scaling group. Prerequisite of deleting: Only stopped Status scaling group can conduct this action. Process of deleting： (1) Remove ECS from the ELB resource pool (2) Set the enableFlag of the corresponding ECS in ASGroupInstance to 0 (3) Set the configuration status of the scaling groups configuration to InActive (4) Delete listener on the scaling group. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   9. DeleteAutoScalingGroupScheduledTask Interface Description Delete timed tasks of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of the timed tasks of scaling groups:  the timed tasks Id for scaling groups. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   10. DeleteAutoScalingRule Interface Description Delete scaling rules. Prerequisite： Scaling rules are not referenced by timed tasks or alarm tasks. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling rules: scaling rules Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   11. GetAutoScalingAlarmTask Interface Description Obtain details about the elastic scaling alarm tasks. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of the elastic scaling alarm tasks: alarm tasks Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ASAlarmTaskDetail </td> <td> AutoScalingAlarmTaskBean </td> <td> Detailed information about the elastic alarm tasks of scaling groups. </td> <td>   </td> </tr> </tbody> </table>   12. GetAutoScalingGroup Interface Description Obtain details about scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ASGroupDetail </td> <td> AutoScalingGroupBean </td> <td> Obtain details about scaling groups. </td> <td>   </td> </tr> </tbody> </table>   13. GetAutoScalingGroupConfig Interface Description Obtain configuration details about scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of the configuration of scaling groups: The configuration Id of scaling groups. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ASGroupConfigDetail </td> <td> AutoScalingGroupConfigBean </td> <td> Obtain details about the configuration of scaling groups. </td> <td>   </td> </tr> </tbody> </table>   14. GetAutoScalingRule Interface Description Obtain details about scaling rules. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> Obtain details about scaling rules. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> AutoScalingRule </td> <td> AutoScalingRuleBean </td> <td> Obtain details about scaling rules. </td> <td>   </td> </tr> </tbody> </table>   15. GetAutoScalingScheduledTask Interface Description Obtain details about timed tasks of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> Timed tasks Id of scaling groups. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> ASScheduledTask </td> <td> AutoScalingScheduledTaskBean </td> <td> Obtain details of timed tasks of scaling groups. </td> <td>   </td> </tr> </tbody> </table>   16. ListASGroupInstances Interface Description Obtain instance list of ECS in scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> Yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> <tr> <td> ScaleType </td> <td> String </td> <td> no </td> <td> Scale type: Auto and Manual. </td> <td>   </td> </tr> <tr> <td> Status </td> <td> InstanceScalingStatus[] </td> <td> no </td> <td> ECS Status existing in scaling groups: Adding, AddFailed, Serving, Removing, RemoveFailed,Removed. </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page number. </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Instances </td> <td> List<ASGroupInstanceBean> </td> <td> Instance list of ECS in scaling groups. </td> <td>   </td> </tr> <tr> <td> Total </td> <td> Long </td> <td> List Size. </td> <td>   </td> </tr> </tbody> </table>   17. ListAutoScalingAlarmTasks Interface Description Obtain alarm task list of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Name </td> <td> String </td> <td> No </td> <td> Name </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> No </td> <td> Display Name </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sort Keywords </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Sort Options </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> AsAlarmTasks </td> <td> List<AutoScalingAlarmTaskBean> </td> <td> Alarm task list of scaling groups. </td> <td>   </td> </tr> </tbody> </table>   18. ListAutoScalingGroupActives Interface Description Obtain detailed list of scaling activities. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> no </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> List Size </td> <td>   </td> </tr> <tr> <td> Actives </td> <td> List<AutoScalingGroupActiveBean> </td> <td> Detailed list of scaling activities. </td> <td>   </td> </tr> </tbody> </table>   19. ListAutoScalingGroupActivityDetail Interface Description Present detailed list of scaling activities. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> yes </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Details </td> <td> List<ASGroupActivityDetailBean> </td> <td> Details about scaling activities. </td> <td>   </td> </tr> <tr> <td> Total </td> <td> Long </td> <td> List Size </td> <td>   </td> </tr> </tbody> </table>   20. ListAutoScalingGroups Interface Description Obtain the list of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name </td> <td>   </td> </tr> <tr> <td> ZoneName </td> <td> String </td> <td> no </td> <td> Available Name Zone </td> <td>   </td> </tr> <tr> <td> Status </td> <td> AutoScalingStatus[] </td> <td> no </td> <td> Status of elastic scaling groups </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sort Keywords </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Sort Options </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> no </td> <td> Region Id </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> AutoScalingGroups </td> <td> List<AutoScalingGroupBean> </td> <td> List of scaling groups </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> List Size </td> <td>   </td> </tr> </tbody> </table>   21. ListAutoScalingRules Interface Description Obtain the list of scaling rules. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display Name </td> <td>   </td> </tr> <tr> <td> ChangeNum </td> <td> Integer </td> <td> no </td> <td> The number of ECS added or removed  from scaling groups during each scaling activities. </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sort Keywords </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Sort Options </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> AutoScalingRules </td> <td> List<AutoScalingRuleBean> </td> <td> List of scaling rules. </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> List Size </td> <td>   </td> </tr> </tbody> </table>   22. ListAutoScalingScheduledTasks Interface Description Obtain the scheduled tasks list of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display Name </td> <td>   </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sort Keywords </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Sort Options </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> AutoScalingScheduledTasks </td> <td> List<AutoScalingScheduledTaskBean> </td> <td> List of the timed tasks of scaling groups. </td> <td>   </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> List Size </td> <td>   </td> </tr> </tbody> </table>   23. ListAvailableInstances Interface Description Query ECS list activating in scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> PageNumber </td> <td> Integer </td> <td> no </td> <td> Page Number </td> <td>   </td> </tr> <tr> <td> PageSize </td> <td> Integer </td> <td> no </td> <td> Page Size </td> <td>   </td> </tr> <tr> <td> RegionId </td> <td> String </td> <td> yes </td> <td> Region Id </td> <td>   </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling groups Id. </td> <td>   </td> </tr> <tr> <td> OrderBy </td> <td> String </td> <td> no </td> <td> Sort Keywords </td> <td>   </td> </tr> <tr> <td> OrderType </td> <td> String </td> <td> no </td> <td> Sort Options </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> TotalCount </td> <td> Long </td> <td> List Size </td> <td>   </td> </tr> <tr> <td> Instances </td> <td> List<InstanceBean> </td> <td> ECS list activating in scaling activities. </td> <td>   </td> </tr> </tbody> </table>   24. StartAutoScalingGroup Interface Description Start scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> Yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   25. StopAutoScalingGroup Interface Description Closing scaling groups refers to stop the tasks of groups and do nothing to ECS. (1) Closing the scaling group is permitted only when the status of group is at runningstatus mode (2) Before stopping the scaling activity ,you should check if there are any ECS is being added or being removed, and if so, do not stop the scaling group. <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> JobId </td> <td> String </td> <td> Job Id </td> <td>   </td> </tr> </tbody> </table>   26. UpdateAutoScalingAlarmTask Interface Description Update the alarm tasks of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> Alarm tasks Id of scaling groups. </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> yes </td> <td> Display name of alarm tasks of scaling groups. </td> <td>   </td> </tr> <tr> <td> GroupId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> <tr> <td> RuleId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling rules: scaling rules Id. </td> <td>   </td> </tr> <tr> <td> MonitorItemType </td> <td> MonitorItemType </td> <td> yes </td> <td> Monitor Items available at this stage：lvxRealServer("lvx.RealServer.Status"),CPU("cpu.busy"), MEM("mem.memused.percent"),NET("net.if.total.bytes") </td> <td>   </td> </tr> <tr> <td> MonitorFunType </td> <td> MonitorFunType </td> <td> yes </td> <td> Monitoring statistical function：min、max、avg、count、rate count </td> <td>   </td> </tr> <tr> <td> Times </td> <td> Integer </td> <td> yes </td> <td> Continuous alarming times. </td> <td>   </td> </tr> <tr> <td> Operator </td> <td> OperatorType </td> <td> yes </td> <td> Examples of defining expression function: lt("<"),elt("<="),eq("=="),neq("!="),gt(">"),egt(">="), </td> <td>   </td> </tr> <tr> <td> RightValue </td> <td> Double </td> <td> yes </td> <td> Threshold values. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   27. UpdateAutoScalingGroup Interface Description Update the configuration of scaling groups: 1. To determine whether the vm number of current scaling groups is greater than the maximum value after modification, if so, it is necessary to eliminate the excess and conduct according to the entry order of  vm acquiescently; 2. To determine whether the vm number of current scalable group is less than the minimum value after modification, if so, it is necessary to increase the insufficient number of vm. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling group Id. </td> <td>   </td> </tr> <tr> <td> MaxNum </td> <td> Integer </td> <td> yes </td> <td> Maximum instance number: The maximum ECS data that can be run in the scaling group, with a range of [1,20] </td> <td>   </td> </tr> <tr> <td> MinNum </td> <td> Integer </td> <td> yes </td> <td> Minimum instance number: The smallest number of ECS data that can be run in the scaling group, with a range of [1,10] </td> <td>   </td> </tr> <tr> <td> QuitPolicy </td> <td> QuitPolicyType </td> <td> no </td> <td> Quit Policy: There are two quit policies for ECS to exit the scaling groups: Latest Exit and First Exit. The latest exit policy: Based on the creation time, the newly created ECS will exit the scaling groups when conducting scaling tasks. The first exit policy: Based on the creation time, the earliest created ECS will exit the scaling groups when conducting scaling tasks. </td> <td>   </td> </tr> <tr> <td> CoolingTime </td> <td> Integer </td> <td> no </td> <td> Cooling time: The time interval between the two scaling tasks of the group. There is no scaling activities triggered during the cooling time, and the value range is: [300,9999] </td> <td>   </td> </tr> <tr> <td> IsRelResources </td> <td> Boolean </td> <td> no </td> <td> Whether to release resources: Whether to conduct release action to the ECS (now shutdown) when it exits the scaling group, which defaults as no release. </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> no </td> <td> Description： Matching this expression function "^[一-龥a-zA-Z][一-龥a-zA-Z0-9-_@]{0,19}$" </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   28. UpdateAutoScalingGroupConfig Interface Description Update the configuration of scaling groups（1）Modifying of the back-end port and network are not allowed. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> Configuration Id of Scaling groups </td> <td>   </td> </tr> <tr> <td> PodId </td> <td> String </td> <td> no </td> <td> High available zone: The information of Pod could be obtained by calling  interface  of ListPods. Details please refer to ListPods interference. </td> <td>   </td> </tr> <tr> <td> Weight </td> <td> Integer </td> <td> no </td> <td> Weight: Range [1, 100]; default: 10. </td> <td>   </td> </tr> <tr> <td> ImageId </td> <td> String </td> <td> no </td> <td> Mirror image: Creating template for ECS and can be obtained by calling  interface of ListImages. Details please refer to ListImges interface. </td> <td>   </td> </tr> <tr> <td> SecurityGroupId </td> <td> String </td> <td> no </td> <td> Safety groups: The information of safety groups could be obtained by calling  interface of ListSecurityGroups. Details please refer to ListSecurityGroups interface. </td> <td>   </td> </tr> <tr> <td> InstanceType </td> <td> String </td> <td> no </td> <td> ECS specification：The product name of ECS is Instance. Product series can be obtained by calling the interface of ListProductSeries with product name as parameter. Products has its own specification, and the corresponding specifications of one product can be obtained by calling the interface of ListInstanceTypes with instance series as parameter. Details please refer to the interface of ListProductSeries and ListInstanceTypes. </td> <td>   </td> </tr> <tr> <td> DiskType </td> <td> String </td> <td> no </td> <td> Disk type: Each kind of ECS has its own disk series. Corresponding disk series can be obtained by calling interface  ListEbsProductSeries with the series of ECS as parameter. Disk series can be obtained by calling the interface of ListEbsTypes and with disk type as parameter. Details please refer to the interfaces of ListProductSeries，ListEbsProductSeries and ListEbsTypes. </td> <td>   </td> </tr> <tr> <td> DiskSizes </td> <td> Integer[] </td> <td> no </td> <td> The size of Disk, range[20，5000] </td> <td>   </td> </tr> <tr> <td> Name </td> <td> String </td> <td> no </td> <td> Name </td> <td>   </td> </tr> <tr> <td> Description </td> <td> String </td> <td> no </td> <td> Remarks </td> <td>   </td> </tr> <tr> <td> FunctionNames </td> <td> String </td> <td> no </td> <td> Function Name </td> <td>   </td> </tr> <tr> <td> PodSelectStrategy </td> <td> PodSelectStrategy </td> <td> no </td> <td> High available zone selecting policy: When scaling groups conduct scaling tasks and creating ECS, there are two choice of selecting high available zone. Polling and Specify. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   29. UpdateAutoScalingGroupScheduledTask Interface Description Updating elastic scheduled tasks of scaling groups. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> yes </td> <td> Timed  tasks Id </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Name of tasks </td> <td>   </td> </tr> <tr> <td> GroupId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling groups: scaling groups Id. </td> <td>   </td> </tr> <tr> <td> RuleId </td> <td> String </td> <td> yes </td> <td> The unique identification of scaling rules: scaling rule Id. </td> <td>   </td> </tr> <tr> <td> ExecuteTime </td> <td> String </td> <td> yes </td> <td> Execute Time </td> <td>   </td> </tr> <tr> <td> RepeatType </td> <td> RepeatType </td> <td> no </td> <td> The timed task repeat period：Once, Daily, Weekly, Monthly </td> <td>   </td> </tr> <tr> <td> SpecificTime </td> <td> String </td> <td> no </td> <td> Repeat type as weekly: need to specify the day of a week, and usually marked as MON, FRI etc.. Repeat type as monthly: need to specify the day of a month, and usually marked with number or L (refers to the last day of a month.) </td> <td>   </td> </tr> <tr> <td> BeginTime </td> <td> String </td> <td> no </td> <td> The begin time of timed tasks. </td> <td>   </td> </tr> <tr> <td> EndTime </td> <td> String </td> <td> no </td> <td> The end time of timed tasks. </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>   30. UpdateAutoScalingRule Interface Description Update scaling rules: there is no status for scaling rules, so every users can modify the scaling rules in any case. Request Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Required (yes/no) </td> <td> Parameter Description </td> <td> Remarks </td> </tr> <tr> <td> Id </td> <td> String </td> <td> Yes </td> <td> Scaling rules Id </td> <td>   </td> </tr> <tr> <td> ChangeNum </td> <td> Integer </td> <td> yes </td> <td> The number of ECS added or removed from scaling groups during every scaling activities. </td> <td>   </td> </tr> <tr> <td> DisplayName </td> <td> String </td> <td> no </td> <td> Display name of scaling rules: Matching with this expression function: "^[一-龥a-zA-Z][一-龥a-zA-Z0-9-_@]{0,19}$" </td> <td>   </td> </tr> </tbody> </table> Response Parameter <table border="1" cellpadding="0" cellspacing="0"> <tbody> <tr> <td> Parameter Name </td> <td> Parameter Type </td> <td> Parameter Description </td> <td> Remarks </td> </tr> </tbody> </table>

Did the above content solve your problem? Yes No