Auto Scaling Group
Overview
ZStack Cloud offers auto-scaling capabilities that can automatically add or remove VM instances from an auto-scaling group (ASG) in response to load balancing of VM instances, your business load changes, and predefined scaling policies. With the auto scaling service, you can better leverage the Cloud resources, reduce the O&M costs, and ensure smooth business operations. Currently, the auto scaling service is applicable to KVM VM instances.
Inventory
Auto Scaling Group Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.1.0 | |
| scalingResourceType | The type of the auto scaling resource: VM instance. | 3.1.0 | ||
| state | The state of the auto scaling group. | 3.1.0 | ||
| defaultCooldown | The default cooldown time of the auto scaling rule. | 3.1.0 | ||
| minResourceSize | The minimum number of VM instances in the auto scaling group. | 3.1.0 | ||
| maxResourceSize | The maximum number of VM instances in the auto scaling group. | 3.1.0 | ||
| removalPolicy | The default policy for removing a VM instance. | 3.1.0 | ||
| attachedTemplates | The templates of VM instances attached to the auto scaling group. | 3.1.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"name": "test-group2",
"uuid": "ed73d20804873d48bddee627a58ca71a",
"description": "just for test",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
Auto Scaling Group Activity Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.1.0 | |
| scalingGroupUuid | The UUID of the auto scaling group. | 3.1.0 | ||
| activityAction | The type of the auto scaling activity. | 3.1.0 | ||
| scalingGroupRuleUuid | The UUID of the auto scaling rule. | 3.1.0 | ||
| cause | The reason that triggered the auto scaling activity. | 3.1.0 | ||
| status | The status of the auto scaling activity. | 3.1.0 | ||
| activityActionResultMessage | The result of the auto scaling activity. | 3.1.0 | ||
| endDate | The date and time when the auto scaling activity ends. | 3.1.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"uuid": "036f189a51633ec5bfa2f7e77ec1f5ac",
"description": "just for test",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
Auto Scaling Rule Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| type | The type of the auto scaling group rule. | 3.1.0 | ||
| cooldown | The cooldown time. | 3.1.0 | ||
| scalingGroupUuid | 3.1.0 | |||
| state | 3.1.0 | |||
| status | 3.1.0 | |||
| ruleTriggers | 3.1.0 | |||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"type": "LoadBalanceProfile",
"description": "just for test",
"cooldown": 100.0,
"state": "Enabled",
"status": "Created",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM",
"name": "test-load-balance-profile",
"uuid": "a0d075cd82c13084b29f93325651fc65"
}
]
}
Auto Scaling Rule Trigger Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.1.0 | |
| type | The trigger type. | 3.1.0 | ||
| ruleUuid | The UUID of the auto scaling rule. | 3.1.0 | ||
| state | The trigger state. | 3.1.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"name": "test-load-balance-profile",
"uuid": "cf762471646230209faee02b6423625c",
"type": "Alarm",
"description": "just for test",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
Auto Scaling VM Template Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| name | The name. For more information, see Resource Property. | 3.1.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.1.0 | |
| vmInstanceName | The VM instance name. | 3.1.0 | ||
| vmInstanceType | The VM instance type. | 3.1.0 | ||
| vmInstanceDescription | The VM instance description. | 3.1.0 | ||
| vmInstanceOfferingUuid | The instance offering of the VM instance. | 3.1.0 | ||
| imageUuid | The image UUID of the VM instance. | 3.1.0 | ||
| l3NetworkUuids | The L3 networks of the VM instance. | 3.1.0 | ||
| rootDiskOfferingUuid | The disk offering of the VM instance root volume. | 3.1.0 | ||
| dataDiskOfferingUuids | The disk offerings of the VM instance data volumes. | 3.1.0 | ||
| vmInstanceZoneUuid | The zone to which the VM instance belongs. | 3.1.0 | ||
| vmInstanceClusterUuid | The cluster to which the VM instance belongs. | 3.1.0 | ||
| hostUuid | The host UUID of the VM instance. | 3.1.0 | ||
| primaryStorageUuidForRootVolume | The primary storage where the root volume of the VM instance locates. | 3.1.0 | ||
| defaultL3NetworkUuid | The default L3 network of the VM instance. | 3.1.0 | ||
| type | The template type. | 3.1.0 | ||
| state | The template state. | 3.1.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"l3NetworkUuids": [
"9f56c162374d382f9ddb7c383bce6887",
"8e07df171471330c83306d78063fba69"
],
"rootDiskOfferingUuid": "57fb695d2d033c1e849dac6fb87cebb5",
"dataDiskOfferingUuids": [
"52bfe290f5363130a1452e2ca1c57783",
"8022018c7f6834d4a7a62a02128672ed"
],
"vmInstanceZoneUuid": "cefa21204105347a82148c099c09a0cb",
"vmInstanceClusterUuid": "ad7fcc77266f34e8a64fd208a9b7ed38",
"hostUuid": "975ceb93de173b22a2b073ee856166e3",
"primaryStorageUuidForRootVolume": "87cf45bf5a37364d85ae9968af7d2bd1",
"defaultL3NetworkUuid": "8e07df171471330c83306d78063fba69",
"uuid": "785259bf48303b0d9a4a34ddc3774da5",
"name": "test-template",
"description": "just for test",
"type": "VmInstance",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
Auto Scaling Group Instance Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.1.0 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.1.0 | |
| instanceUuid | The VM instance UUID. | 3.1.0 | ||
| scalingGroupUuid | The UUID of the auto scaling group. | 3.1.0 | ||
| templateUuid | The UUID of the VM instance template in the auto scaling group. | 3.1.0 | ||
| scalingGroupActivityUuid | The UUID of the auto scaling activity. | 3.1.0 | ||
| status | The status of the VM instance in the auto scaling group. | 3.1.0 | ||
| healthStatus | The health status of the VM instance in the auto scaling group. | 3.1.0 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.1.0 | |
| createDate | The creation date. For more information, see Resource Property. | 3.1.0 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 |
Sample
{
"inventories": [
{
"uuid": "c23dc6fd3dd13436b5d65b0a4d328f2c",
"instanceUuid": "1dcb05b79b2b3a61b74114ff3aa00266",
"description": "just for test",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}
Operations
CreateAutoScalingGroup
Creates an auto scaling group. For example,
CreateAutoScalingGroup name=test scalingResourceType=VmInstance minResourceSize=2 maxResourceSize=5 defaultCooldown=60 removalPolicy=NewestInstance
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 3.1.0 | ||
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| scalingResourceType | The resource type of the auto scaling group. Current type: VM instance. |
|
3.1.0 | |
| minResourceSize | The minimum number of VM instances in the auto scaling group. | 3.1.0 | ||
| maxResourceSize | The maximum number of VM instances in the auto scaling group. | 3.1.0 | ||
| defaultCooldown | The default cooldown time of the auto scaling rule. | 3.1.0 | ||
| removalPolicy | The policy for removing a VM instance. |
|
3.1.0 | |
| defaultEnable | Whether to enable the auto scaling group after creation. | Yes | 3.1.0 | |
| resourceUuid | Yes | 3.1.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
DeleteAutoScalingGroup
Deletes an auto scaling group. For example,
DeleteAutoScalingGroup uuid=09121b25fdf330538288d1ac81025563
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
UpdateAutoScalingGroup
Modifies an auto scaling group. For example,
UpdateAutoScalingGroup uuid=17a8d07735b631a688d6f95f3323fe91 name=TEST
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| name | The resource name. | Yes | 3.1.0 | |
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| minResourceSize | The minimum number of VM instances in the auto scaling group. | Yes | 3.1.0 | |
| maxResourceSize | The maximum number of VM instances in the auto scaling group. | Yes | 3.1.0 | |
| removalPolicy | The policy for removing a VM instance. The oldest and newest VM instances take precedence. | Yes |
|
3.1.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
QueryAutoScalingGroup
Queries an auto scaling group. For example,
QueryAutoScalingGroup uuid=ed73d20804873d48bddee627a58ca71a
Primitive Fields of Query
QueryAutoScalingGroupActivity
Queries activities of an auto scaling group. For example,
QueryAutoScalingGroupActivity uuid=036f189a51633ec5bfa2f7e77ec1f5ac
Primitive Fields of Query
CreateAutoScalingGroupAddingNewInstanceRule
Creates a scale-out policy (a rule for adding VM instances) for an auto scaling group. For example,
CreateAutoScalingGroupAddingNewInstanceRule adjustmentType=QuantityChangeInCapacity adjustmentValue=1.0 name=test autoScalingGroupUuid=9e5900b0682d3eb8868637b455567cbd
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| adjustmentType | The scale-out method. Options:
|
|
3.1.0 | |
| adjustmentValue | The scale-out size. | 3.1.0 | ||
| name | The resource name. | 3.1.0 | ||
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| autoScalingGroupUuid | The UUID of the auto scaling group. | 3.1.0 | ||
| type | The type of the auto scaling rule. | Yes | 3.1.0 | |
| cooldown | The cooldown time after the auto scaling rule is triggered. | Yes | 3.1.0 | |
| resourceUuid | Yes | 3.1.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
CreateAutoScalingGroupRemovalInstanceRule
Creates a scale-in policy (a rule for removing VM instances) for an auto scaling group. For example,
CreateAutoScalingGroupRemovalInstanceRule adjustmentType=PercentChangeInCapacity adjustmentValue=1.0 removalPolicy=MinimumMemoryUsageInstance name=removalInstance autoScalingGroupUuid=8a8070f9926733478acad7bf0ba60a63
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| adjustmentType | The scale-in method. Options:
|
|
3.1.0 | |
| adjustmentValue | The scale-in size. | 3.1.0 | ||
| removalPolicy | The policy for removing a VM instance. |
|
3.1.0 | |
| name | The resource name. | 3.1.0 | ||
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| autoScalingGroupUuid | The UUID of the auto scaling group. | 3.1.0 | ||
| type | The type of the auto scaling rule. | Yes | 3.1.0 | |
| cooldown | The cooldown time after the auto scaling rule is triggered. | Yes | 3.1.0 | |
| resourceUuid | Yes | 3.1.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
DeleteAutoScalingRule
Deletes an auto scaling rule. For example,
DeleteAutoScalingRule uuid=55774c4baaea33c4a47b16c772446077
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID of the auto scaling rule. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
UpdateAutoScalingRule
Modifies the auto scaling rule of an auto scaling group. For example,
UpdateAutoScalingRule uuid=4e8be98cd3a93176b9d38f3f934f1c2a name=TEST
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| name | The resource name. | Yes | 3.1.0 | |
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| cooldown | The cooldown time. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
UpdateAutoScalingGroupAddingNewInstanceRule
Modifies the scale-out policy (a rule for adding VM instances) of an auto scaling group. For example,
UpdateAutoScalingGroupAddingNewInstanceRule uuid=e61646c51ac1396fb6d7d413dc5de3f8 adjustmentType=TotalCapacity
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| adjustmentType | The scale-out method. Options:
|
Yes |
|
3.1.0 |
| adjustmentValue | The scale-out size. | Yes | 3.1.0 | |
| uuid | The resource UUID. | 3.1.0 | ||
| name | The resource name. | Yes | 3.1.0 | |
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| cooldown | The cooldown time. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
UpdateAutoScalingGroupRemovalInstanceRule
Modifies the scale-in policy (a rule for removing VM instances) of an auto scaling group. For example,
UpdateAutoScalingGroupRemovalInstanceRule uuid=66d7d0b81f1c399bb98063dfb0d3beaf removalPolicy=NewestInstance
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| adjustmentType | The scale-in method. Options:
|
Yes |
|
3.1.0 |
| adjustmentValue | The scale-in size. | Yes | 3.1.0 | |
| removalPolicy | The policy for removing a VM instance. | Yes |
|
3.1.0 |
| uuid | The resource UUID. | 3.1.0 | ||
| name | The resource name. | Yes | 3.1.0 | |
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| cooldown | The cooldown time. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
QueryAutoScalingRule
Queries an auto scaling rule. For example,
QueryAutoScalingRule name=test-load-balance-profile
Primitive Fields of Query
CreateAutoScalingRuleAlarmTrigger
Creates an alarm trigger for an auto scaling rule. For example,
CreateAutoScalingRuleAlarmTrigger name=createAlarmTrigger ruleUuid=00f142f73b633bf0ab4a1e34aa84062b alarmUuid=14b74127a20634c6b6d3566ef33b0600
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| alarmUuid | The alarm UUID. | 3.1.0 | ||
| triggerType | The trigger type. | Yes | 3.1.0 | |
| name | The trigger name. | 3.1.0 | ||
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| ruleUuid | The UUID of the auto scaling rule. | 3.1.0 | ||
| resourceUuid | Yes | 3.1.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
CreateAutoScalingRuleSchedulerJobTrigger
Creates a trigger for the scheduled job of an auto-scaling rule. For example,
CreateAutoScalingRuleSchedulerJobTrigger name=createSchedulerJobTrigger schedulerJobUuid=00f142f73b633bf0ab4a1e34aa84062b alarmUuid=14b74127a20634c6b6d3566ef33b0600
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| schedulerJobUuid | The scheduled job UUID. | 4.1.0 | ||
| triggerType | The trigger type. | Yes | 4.1.0 | |
| name | The trigger name. | 4.1.0 | ||
| description | The detailed description of the trigger. | Yes | 4.1.0 | |
| ruleUuid | The rule UUID. | 4.1.0 | ||
| resourceUuid | The resource UUID. | Yes | 4.1.0 | |
| tagUuids | The tag UUIDs. | Yes | 4.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.1.0 | |
| timeout | Yes |
DeleteAutoScalingRuleTrigger
Deletes an alarm trigger from an auto scaling rule. For example,
DeleteAutoScalingRuleTrigger uuid=c81896a39caf320d988503625feb5a84
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
QueryAutoScalingRuleTrigger
Queries an alarm trigger of an auto scaling rule. For example,
QueryAutoScalingRuleTrigger uuid=cf762471646230209faee02b6423625c
Primitive Fields of Query
CreateAutoScalingVmTemplate
Creates a VM instance template in an auto scaling group. For example,
CreateAutoScalingVmTemplate name=test defaultL3NetworkUuid=22247b0705a43af7a47ed6428c537934 vmInstanceName=vm1 vmInstanceOfferingUuid=07e435acb1c230d5b328f23e5a840da2 imageUuid=77407eb341e732b2a45ad5bad4a2c76e l3NetworkUuids=93edf15377e233a291fe1ab1c4190241
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| vmInstanceName | The VM instance name. | 3.1.0 | ||
| vmInstanceDescription | The VM instance description. | Yes | 3.1.0 | |
| vmInstanceOfferingUuid | The instance offering of the VM instance. | 3.1.0 | ||
| imageUuid | The image UUID of the VM instance. | 3.1.0 | ||
| l3NetworkUuids | The L3 networks of the VM instance. | 3.1.0 | ||
| rootDiskOfferingUuid | The disk offering of the VM instance root volume. | Yes | 3.1.0 | |
| dataDiskOfferingUuids | The disk offerings of the VM instance data volumes. | Yes | 3.1.0 | |
| vmInstanceZoneUuid | The zone to which the VM instance belongs. | Yes | 3.1.0 | |
| vmInstanceClusterUuid | The cluster to which the VM instance belongs. | Yes | 3.1.0 | |
| hostUuid | The host UUID. | Yes | 3.1.0 | |
| primaryStorageUuidForRootVolume | The UUID of the primary storage where the root volume locates. | Yes | 3.1.0 | |
| defaultL3NetworkUuid | The default L3 network of the VM instance. | 3.1.0 | ||
| name | The resource name. | 3.1.0 | ||
| description | The detailed description of the resource. | Yes | 3.1.0 | |
| type | The template type. | Yes | 3.1.0 | |
| resourceUuid | Yes | 3.1.0 | ||
| tagUuids | The tag UUID list. | Yes | 3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
AttachAutoScalingTemplateToGroup
Adds a VM instance template to an auto scaling group. For example,
AttachAutoScalingTemplateToGroup uuid=a53e0f84df15313bba8560f6567da2d9 groupUuid=284172349b50324a9c2b8a09a28b3294
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The template UUID. | 3.1.0 | ||
| groupUuid | The UUID of the auto scaling group. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
DeleteAutoScalingTemplate
Deletes an auto scaling group template. For example,
DeleteAutoScalingTemplate uuid=5c9e41a7d5c9335f99d639e75c294392
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
DetachAutoScalingTemplateFromGroup
Detaches an auto scaling template from an auto scaling group. For example,
DetachAutoScalingTemplateFromGroup templateUuid=801a456fff0a355f9159d74af32026b9 groupUuid=bdbbb1d168023ec7b9331bddd1b55b88
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| templateUuid | The template UUID. | 3.1.0 | ||
| groupUuid | The UUID of the auto scaling group. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
QueryAutoScalingVmTemplate
Queries a VM instance template in an auto scaling group. For example,
QueryAutoScalingVmTemplate rootDiskOfferingUuid=57fb695d2d033c1e849dac6fb87cebb5
Primitive Fields of Query
See Auto Scaling VM Template Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| autoScalingGroup | Auto Scaling Group Inventory | The associated auto scaling groups. | 3.1.0 |
DeleteAutoScalingGroupInstance
Manually deletes a VM instance in an auto scaling group. For example,
DeleteAutoScalingGroupInstance instanceUuid=3f55b1b15c273122b6b815218282efe5
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| instanceUuid | The VM instance UUID. | 3.1.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
QueryAutoScalingGroupInstance
Queries the VM instances in an auto scaling group. For example,
QueryAutoScalingGroupInstance uuid=c23dc6fd3dd13436b5d65b0a4d328f2c
Primitive Fields of Query
ChangeAutoScalingGroupState
Changes the state of an auto scaling group. For example,
ChangeAutoScalingGroupState uuid=384ac055e3113366907f06e8aaefb12d stateEvent=disable
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.1.0 | ||
| stateEvent | Whether to enable or disable the auto scaling group. |
|
3.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.1.0 | |
| timeout | Yes |
ExecuteAutoScalingRule
Manually executes an auto scaling rule. For example,
ExecuteAutoScalingRule uuid=9311aaae28333775b3339b644961c990
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID of the auto scaling rule. | 3.9.0 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.9.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.9.0 | |
| timeout | Yes |
UpdateAutoScalingGroupInstance
Updates information about a VM instance in an auto scaling group. For example,
UpdateAutoScalingGroupInstance groupUuid=a3b7616d6e6a3ed6bdf5dd5a640a4548 instanceUuid=a6dcd12ee95e345787a34175327df816
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| groupUuid | The UUID of the auto scaling group. | 3.9.0 | ||
| instanceUuid | The UUID of the VM instance in the auto scaling group. | 3.9.0 | ||
| protectionStrategy | The VM protection strategy of the auto scaling group. | Yes |
|
3.9.0 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.9.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.9.0 | |
| timeout | Yes |
UpdateAutoScalingVmTemplate
Updates a VM template in an auto scaling group. For example,
UpdateAutoScalingVmTemplate uuid=dfb4e8245e32361db57b92c95c84c01b name=template
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The VM template UUID. | 3.9.0 | ||
| name | The template name. | Yes | 3.9.0 | |
| description | The detailed description. | Yes | 3.9.0 | |
| vmInstanceName | The name of the VM instance. | Yes | 3.9.0 | |
| vmInstanceDescription | The description of the VM instance. | Yes | 3.9.0 | |
| vmInstanceOfferingUuid | The instance offering UUID of the VM instance. | Yes | 3.9.0 | |
| imageUuid | The UUID of the VM image. | Yes | 3.9.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.9.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.9.0 | |
| timeout | Yes |
Tags
You can create a user tag on an auto scaling group by using resourceType=AutoScalingGroupVO. For example,
CreateUserTag resourceType=AutoScalingGroupVO tag=golden-ResourceStack
resourceUuid=e4464da741324c7b8705fc4704ec5877
