Information on eligible scaling activities.
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
ActivityId | String | Scaling activity ID. |
ActivityType | String | Type of the scaling activity. Valid values:SCALE_OUT : Scale out. SCALE_IN : Scale in. ATTACH_INSTANCES : Add instances. REMOVE_INSTANCES : Terminate instances. DETACH_INSTANCES : Remove instances. TERMINATE_INSTANCES_UNEXPECTEDLY : Terminate instances in the CVM console. REPLACE_UNHEALTHY_INSTANCE : Replace an unhealthy instance.START_INSTANCES : Starts up instances.STOP_INSTANCES : Shut down instances.INVOKE_COMMAND : Execute commands |
StatusCode | String | Scaling activity status. Value range: |
StatusMessage | String | Description of the scaling activity status. |
Cause | String | Cause of the scaling activity. |
Description | String | Description of the scaling activity. |
StartTime | Timestamp ISO8601 | Start time of the scaling activity. |
EndTime | Timestamp ISO8601 | End time of the scaling activity. |
CreatedTime | Timestamp ISO8601 | Creation time of the scaling activity. |
StatusMessageSimplified | String | Brief description of the scaling activity status. |
LifecycleActionResultSet | Array of LifecycleActionResultInfo | Result of the lifecycle hook action in the scaling activity |
DetailedStatusMessageSet | Array of DetailedStatusMessage | Detailed description of scaling activity status |
InvocationResultSet | Array of InvocationResult | Result of the command execution |
RelatedInstanceSet | Array of RelatedInstance | Information set of the instances related to the scaling activity. |
Suggestions for scaling group configurations.
Used by actions: DescribeAutoScalingAdvices.
Name | Type | Description |
---|---|---|
Problem | String | Problem Description |
Detail | String | Problem Details |
Solution | String | Recommended resolutions |
Level | String | Risk level of the scaling group configuration. Valid values: |
Suggestions for scaling group configurations.
Used by actions: DescribeAutoScalingAdvices.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Scaling group ID |
Level | String | Scaling group warning level. Valid values: |
Advices | Array of Advice | A collection of suggestions for scaling group configurations. |
Auto scaling group
Used by actions: DescribeAutoScalingGroups.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID |
AutoScalingGroupName | String | Auto scaling group name |
AutoScalingGroupStatus | String | Current scaling group status. Valid values: |
CreatedTime | Timestamp ISO8601 | Creation time in UTC format |
DefaultCooldown | Integer | Default cooldown period in seconds |
DesiredCapacity | Integer | Desired number of instances |
EnabledStatus | String | Enabled status. Value range: ENABLED , DISABLED |
ForwardLoadBalancerSet | Array of ForwardLoadBalancer | List of application load balancers |
InstanceCount | Integer | Number of instances |
InServiceInstanceCount | Integer | Number of instances in IN_SERVICE status |
LaunchConfigurationId | String | Launch configuration ID |
LaunchConfigurationName | String | Launch configuration name |
LoadBalancerIdSet | Array of String | List of Classic load balancer IDs |
MaxSize | Integer | Maximum number of instances |
MinSize | Integer | Minimum number of instances |
ProjectId | Integer | Project ID |
SubnetIdSet | Array of String | List of subnet IDs |
TerminationPolicySet | Array of String | Termination policy |
VpcId | String | VPC ID |
ZoneSet | Array of String | List of availability zones |
RetryPolicy | String | Retry policy |
InActivityStatus | String | Whether the auto scaling group is performing a scaling activity. IN_ACTIVITY indicates yes, and NOT_IN_ACTIVITY indicates no. |
Tags | Array of Tag | List of auto scaling group tags |
ServiceSettings | ServiceSettings | Service settings |
Ipv6AddressCount | Integer | The number of IPv6 addresses that an instance has. |
MultiZoneSubnetPolicy | String | The policy applied when there are multiple availability zones/subnets |
HealthCheckType | String | Health check type of instances in a scaling group. |
LoadBalancerHealthCheckGracePeriod | Integer | Grace period of the CLB health check |
InstanceAllocationPolicy | String | Specifies how to assign instances. Valid values: LAUNCH_CONFIGURATION and SPOT_MIXED .LAUNCH_CONFIGURATION : the launch configuration mode.SPOT_MIXED : a mixed instance mode. Currently, this mode is supported only when the launch configuration takes the pay-as-you-go billing mode. With this mode, the scaling group can provision a combination of pay-as-you-go instances and spot instances to meet the configured capacity. Note that the billing mode of the associated launch configuration cannot be modified when this mode is used. |
SpotMixedAllocationPolicy | SpotMixedAllocationPolicy | Specifies how to assign pay-as-you-go instances and spot instances. A valid value will be returned only when InstanceAllocationPolicy is set to SPOT_MIXED . |
CapacityRebalance | Boolean | Indicates whether the capacity rebalancing feature is enabled. This parameter is only valid for spot instances in the scaling group. Valid values:TRUE : yes. Before the spot instances in the scaling group are about to be automatically repossessed, AS will terminate them. The scale-in hook (if configured) will take effect before the termination. After the termination process starts, AS will asynchronously initiate a scaling activity to meet the desired capacity.FALSE : no. AS will add instances to meet the desired capacity only after the spot instances are terminated. |
InstanceNameIndexSettings | InstanceNameIndexSettings | Instance name sequencing settings. Note: This field may return null, indicating that no valid value can be obtained. |
Brief information of a scaling group.
Used by actions: DescribeLaunchConfigurations.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Scaling group ID |
AutoScalingGroupName | String | Auto scaling group name. |
AS event notification
Used by actions: DescribeNotificationConfigurations.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
NotificationUserGroupIds | Array of String | List of user group IDs. |
NotificationTypes | Array of String | List of notification events. |
AutoScalingNotificationId | String | Event notification ID. |
TargetType | String | Notification receiver type. |
QueueName | String | CMQ queue name. |
TopicName | String | CMQ topic name. |
Configuration information of data disk in launch configuration. If this parameter is not specified, no data disk will be purchased by default. You can specify only one data disk when purchasing it.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | No | Data disk type. For restrictions on data disk type, see Cloud Block Storage Types. Valid values: The default value is consistent with the system disk type (SystemDisk.DiskType). Note: This field may return null, indicating that no valid values can be obtained. |
DiskSize | Integer | No | Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. For more information on limits, see CVM Instance Configuration. The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation. Note: This field may return null, indicating that no valid values can be obtained. |
SnapshotId | String | No | Data disk snapshot ID, such as snap-l8psqwnt .Note: This field may return null, indicating that no valid values can be obtained. |
DeleteWithInstance | Boolean | No | Whether the data disk is terminated along with the instance. Valid values: Note: This field may return null, indicating that no valid values can be obtained. |
Encrypt | Boolean | No | Whether the data disk is encrypted. Valid values: Note: This field may return null, indicating that no valid values can be obtained. |
ThroughputPerformance | Integer | No | Cloud disk performance (MB/s). This parameter is used to purchase extra performance for the cloud disk. For details on the feature and limits, see [Enhanced SSD Performance](https://www.tencentcloud.com/document/product/362/51896?from_cn_redirect=1#. E5.A2.9E.E5.BC.BA.E5.9E.8B-ssd-.E4.BA.91.E7.A1.AC.E7.9B.98.E9.A2.9D.E5.A4.96 .E6.80.A7.E8.83.BD). This feature is only available to enhanced SSD ( CLOUD_HSSD ) and tremendous SSD (CLOUD_TSSD ) disks with a capacity greater than 460 GB.Note: This field may return null , indicating that no valid value can be obtained. |
BurstPerformance | Boolean | No | Burst performance: Whether to enable burst performance. The default value is false. Note: This feature is in beta test and requires a ticket to be submitted for usage. Note: This field may return null, indicating that no valid values can be obtained. |
Detailed description of scaling activity status
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
Code | String | Error type |
Zone | String | AZ information |
InstanceId | String | Instance ID |
InstanceChargeType | String | Instance billing mode |
SubnetId | String | Subnet ID |
Message | String | Error message |
InstanceType | String | Instance type |
This describes the conditions and configurations of the enhanced services of the instance, such as cloud security, cloud monitor, TencentCloud Automation Tools, and other instance agents.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
SecurityService | RunSecurityServiceEnabled | No | Enables the Cloud Security service. If this parameter is not specified, the Cloud Security service will be enabled by default. |
MonitorService | RunMonitorServiceEnabled | No | Enables the Cloud Monitor service. If this parameter is not specified, the Cloud Monitor service will be enabled by default. |
AutomationToolsService | RunAutomationServiceEnabled | No | Enable TAT service. If this parameter is not specified, the default logic is the same as that of the CVM instance. Note: This field may return null , indicating that no valid values can be obtained. |
Describes key-value pair filters used for conditional queries, such as filtering results by ID, name and state.
- If there are multiple
Filter
parameters, the relationship among them will be logicalAND
.- If there are multiple
Values
for the sameFilter
, the relationship among theValues
for the sameFilter
will be logicalOR
.
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroups, DescribeAutoScalingInstances, DescribeLaunchConfigurations, DescribeLifecycleHooks, DescribeNotificationConfigurations, DescribeRefreshActivities, DescribeScalingPolicies, DescribeScheduledActions.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Field to be filtered. |
Values | Array of String | Yes | Filter value of the field. |
Application load balancer
Used by actions: AttachLoadBalancers, CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancerTargetAttributes, ModifyLoadBalancers.
Name | Type | Required | Description |
---|---|---|---|
LoadBalancerId | String | Yes | Load balancer ID |
ListenerId | String | Yes | Application load balancer listener ID |
TargetAttributes | Array of TargetAttribute | Yes | List of target rule attributes |
LocationId | String | No | ID of a forwarding rule. This parameter is required for layer-7 listeners. |
Region | String | No | The region of CLB instance. It defaults to the region of AS service and is in the format of the common parameter Region , such as ap-guangzhou . |
Application CLB IDs
Used by actions: DetachLoadBalancers.
Name | Type | Required | Description |
---|---|---|---|
LoadBalancerId | String | Yes | ID of the CLB |
ListenerId | String | Yes | Application CLB listener ID |
LocationId | String | No | ID of a forwarding rule. This parameter is required for layer-7 listeners. |
CVM HostName settings
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
HostName | String | Yes | CVM HostName. Note: This field may return null, indicating that no valid values can be obtained. |
HostNameStyle | String | No | The style of the CVM HostName. Valid values include ORIGINAL and UNIQUE, and the default value is ORIGINAL. Note: This field may return null, indicating that no valid values can be obtained. |
HostNameSuffix | String | No | HostName suffix for CVM. Assume the suffix name is suffix and the original HostName is test.0, then the final HostName is test.0.suffix. Note: This field may return null, indicating that no valid values can be obtained. |
This describes the IPv6 address public network accessibility of the instance created by a launch configuration and declares the public network usage billing method of the IPv6 address and the maximum bandwidth.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
InternetChargeType | String | No | Network billing mode. Valid values: TRAFFIC_POSTPAID_BY_HOUR, BANDWIDTH_PACKAGE. Default value: TRAFFIC_POSTPAID_BY_HOUR. For the current account type, see Account Type Description.TRAFFIC_POSTPAID_BY_HOUR under a bill-by-IP account.BANDWIDTH_PACKAGE under a bill-by-CVM account.Note: This field may return null , indicating that no valid values can be obtained. |
InternetMaxBandwidthOut | Integer | No | Outbound bandwidth cap of the public network (in Mbps). It defaults to 0 , which indicates no public network bandwidth is allocated to IPv6. The value range of bandwidth caps varies with the model, availability zone and billing mode. For more information, see Public Network Bandwidth Cap.Note: This field may return null , indicating that no valid values can be obtained. |
BandwidthPackageId | String | No | Bandwidth package ID. You can obtain the ID from the BandwidthPackageId field in the response of the DescribeBandwidthPackages API.Note: This field may return null , indicating that no valid values can be obtained. |
Instance information
Used by actions: DescribeAutoScalingInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
AutoScalingGroupId | String | Auto scaling group ID |
LaunchConfigurationId | String | Launch configuration ID |
LaunchConfigurationName | String | Launch configuration name |
LifeCycleState | String | Lifecycle status. Valid values:IN_SERVICE : The instance is running.CREATING : The instance is being created.CREATION_FAILED : The instance fails to be created.TERMINATING : The instance is being terminated.TERMINATION_FAILED : The instance fails to be terminated.ATTACHING : The instance is being bound.ATTACH_FAILED : The instance fails to be bound.DETACHING : The instance is being unbound.DETACH_FAILED : The instance fails to be unbound.ATTACHING_LB : The LB is being bound.MODIFYING_LB : The LB is being modified.STARTING : The instance is being started up.START_FAILED : The instance fails to be started up.STOPPING : The instance is being shut down.STOP_FAILED : The instance fails to be shut down.STOPPED : The instance is shut down.IN_LAUNCHING_HOOK : The lifecycle hook is being scaled out.IN_TERMINATING_HOOK : The lifecycle hook is being scaled in. |
HealthStatus | String | Health status. Value range: HEALTHY, UNHEALTHY |
ProtectedFromScaleIn | Boolean | Whether to add scale-in protection |
Zone | String | Availability zone |
CreationType | String | Creation type. Value range: AUTO_CREATION, MANUAL_ATTACHING. |
AddTime | Timestamp ISO8601 | Instance addition time |
InstanceType | String | Instance type |
VersionNumber | Integer | Version number |
AutoScalingGroupName | String | Auto scaling group name |
WarmupStatus | String | Warming up status. Valid values:WAITING_ENTER_WARMUP : The instance is waiting to be warmed up.NO_NEED_WARMUP : Warming up is not required.IN_WARMUP : The instance is being warmed up.AFTER_WARMUP : Warming up is completed. |
DisasterRecoverGroupIds | Array of String | Placement group ID. Only one is allowed. Note: This field may return null , indicating that no valid values can be obtained. |
This API is used to describe the billing mode of an instance.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Period | Integer | Yes | Purchased usage period of an instance in months. Value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. |
RenewFlag | String | No | Auto-renewal flag. Valid values: |
Options related to a CVM bidding request
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
SpotOptions | SpotMarketOptions | Yes | Bidding-related options |
MarketType | String | No | Market option type. Currently, this only supports the value "spot" Note: This field may return null, indicating that no valid values can be obtained. |
Instance name sequencing settings.
Used by actions: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup.
Name | Type | Required | Description |
---|---|---|---|
Enabled | Boolean | No | Whether to enable instance creation sequencing, which is disabled by default. Valid values: Note: This field may return null, indicating that no valid value can be obtained. |
BeginIndex | Integer | No | Initial sequence number, with a value range of [0, 99,999,999]. When the sequence number exceeds this range after incrementing, scale-out activities will fail. Note: This field may return null, indicating that no valid value can be obtained. |
Settings of CVM instance names.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
InstanceName | String | Yes | CVM instance name. Value range: 2-108. |
InstanceNameStyle | String | No | Type of CVM instance name. Valid values: ORIGINAL and UNIQUE . Default value: ORIGINAL .ORIGINAL : Auto Scaling sends the input parameter InstanceName to the CVM directly. The CVM may append a serial number to the InstanceName . The InstanceName of the instances within the scaling group may conflict.UNIQUE : the input parameter InstanceName is the prefix of an instance name. Auto Scaling and CVM expand it. The InstanceName of an instance in the scaling group is unique. |
InstanceNameSuffix | String | No | CVM instance name suffix. The length of the character is within the range of [1, 105], and the combined length with InstanceName should not exceed 107. Assume the suffix name is suffix and the original instance name is test.0, then the final instance name is test.0.suffix. Note: This field may return null, indicating that no valid values can be obtained. |
Instance tag. This parameter is used to bind tags to newly added instances.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Tag key |
Value | String | Yes | Tag value |
This describes the internet accessibility of the instance created by a launch configuration and declares the internet usage billing method of the instance and the maximum bandwidth
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
InternetChargeType | String | No | Network billing method. Value range: Default value: TRAFFIC_POSTPAID_BY_HOUR. Note: This field may return null, indicating that no valid values can be obtained. |
InternetMaxBandwidthOut | Integer | No | The maximum outbound bandwidth in Mbps of the public network. The default value is 0 Mbps. The upper limit of bandwidth varies by model. For more information, see Purchase Network Bandwidth. Note: This field may return null, indicating that no valid values can be obtained. |
PublicIpAssigned | Boolean | No | Whether to assign a public IP. Value range: If the public network bandwidth is greater than 0 Mbps, you are free to choose whether to enable the public IP (which is enabled by default). If the public network bandwidth is 0 Mbps, no public IP will be allowed to be assigned. Note: This field may return null, indicating that no valid values can be obtained. |
BandwidthPackageId | String | No | Bandwidth package ID. You can obtain the ID from the BandwidthPackageId field in the response of the DescribeBandwidthPackages API.Note: this field may return null, indicating that no valid value was found. |
Result of the command execution
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. Note: This field may return null, indicating that no valid values can be obtained. |
InvocationId | String | Execution activity ID. Note: This field may return null, indicating that no valid values can be obtained. |
InvocationTaskId | String | Execution task ID. Note: This field may return null, indicating that no valid values can be obtained. |
CommandId | String | Command ID. Note: This field may return null, indicating that no valid values can be obtained. |
TaskStatus | String | Execution Status Note: This field may return null, indicating that no valid values can be obtained. |
ErrorMessage | String | Execution exception information Note: This field may return null, indicating that no valid values can be obtained. |
Information set of eligible launch configurations.
Used by actions: DescribeLaunchConfigurations.
Name | Type | Description |
---|---|---|
ProjectId | Integer | Project ID of the instance. |
LaunchConfigurationId | String | Launch configuration ID |
LaunchConfigurationName | String | Launch configuration name. |
InstanceType | String | Instance model. |
SystemDisk | SystemDisk | Information of the instance's system disk configuration. |
DataDisks | Array of DataDisk | Information of the instance's data disk configuration. |
LoginSettings | LimitedLoginSettings | Instance login settings. |
InternetAccessible | InternetAccessible | Information of the public network bandwidth configuration. |
SecurityGroupIds | Array of String | Security group of the instance. |
AutoScalingGroupAbstractSet | Array of AutoScalingGroupAbstract | Auto scaling group associated with the launch configuration. |
UserData | String | Custom data. Note: This field may return null, indicating that no valid values can be obtained. |
CreatedTime | Timestamp ISO8601 | Creation time of the launch configuration. |
EnhancedService | EnhancedService | Conditions of enhancement services for the instance and their settings. |
ImageId | String | Image ID. |
LaunchConfigurationStatus | String | Current status of the launch configuration. Valid values: |
InstanceChargeType | String | Instance billing type, with the CVM default value processed as POSTPAID_BY_HOUR. |
InstanceMarketOptions | InstanceMarketOptionsRequest | Market options of the instance, such as parameters related to spot instances. This parameter is required for spot instances. Note: This field may return null, indicating that no valid values can be obtained. |
InstanceTypes | Array of String | List of instance models. |
InstanceTags | Array of InstanceTag | List of instance tags, which will be added to instances created by the scale-out activity. Up to 10 tags allowed. |
Tags | Array of Tag | Tag list. Note: This field may return null, indicating that no valid values can be obtained. |
VersionNumber | Integer | Version |
UpdatedTime | Timestamp ISO8601 | Update time |
CamRoleName | String | CAM role name. This parameter can be obtained from the roleName field returned by DescribeRoleList API. |
LastOperationInstanceTypesCheckPolicy | String | Value of InstanceTypesCheckPolicy upon the last operation. |
HostNameSettings | HostNameSettings | CVM hostname settings. |
InstanceNameSettings | InstanceNameSettings | Settings of CVM instance names |
InstanceChargePrepaid | InstanceChargePrepaid | Details of the monthly subscription, including the purchase period, auto-renewal. It is required if the InstanceChargeType is PREPAID . |
DiskTypePolicy | String | Cloud disk type selection policy. Valid values: |
HpcClusterId | String | HPC ID Note: This field is default to empty |
IPv6InternetAccessible | IPv6InternetAccessible | IPv6 public network bandwidth configuration. |
DisasterRecoverGroupIds | Array of String | Placement group ID, supporting specification of only one. |
ImageFamily | String | Image family name. Note: This field may return null, indicating that no valid values can be obtained. |
Result information of the lifecycle hook action
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
LifecycleHookId | String | ID of the lifecycle hook |
InstanceId | String | ID of the instance |
InvocationId | String | Execution task ID. You can query the result by using the DescribeInvocations API of TAT. |
InvokeCommandResult | String | Result of command invocation,SUCCESSFUL : Successful command invocation. It does mean that the task is successfully. You can query the task result with the InvocationId.</li><li> FAILED: Failed to invoke the command</li><li> NONE` |
NotificationResult | String | Notification result, which indicates whether it is successful to notify CMQ/TDMQ. |
LifecycleActionResult | String | Result of the lifecyle hook action. Values: CONTINUE, ABANDON |
ResultReason | String | Reason of the result HEARTBEAT_TIMEOUT : Heartbeat timed out. The setting of DefaultResult is used.NOTIFICATION_FAILURE : Failed to send the notification. The setting of DefaultResult is used.CALL_INTERFACE : Calls the CompleteLifecycleAction to set the resultABANDON by another operation. |
Remote command execution object.
Used by actions: CreateLifecycleHook, DescribeLifecycleHooks, ModifyLifecycleHook, UpgradeLifecycleHook.
Name | Type | Required | Description |
---|---|---|---|
CommandId | String | Yes | Remote command ID. It’s required to execute a command. Note: This field may return null, indicating that no valid values can be obtained. |
Parameters | String | No | Custom parameter. The field type is JSON encoded string. For example, {"varA": "222"}.key is the name of the custom parameter and value is the default value. Both key and value are strings.If this parameter is not specified, the DefaultParameters of Command is used.Up to 20 customer parameters allowed. The parameter name can contain up to 64 characters, including [a-z], [A-Z], [0-9] and [-_]. Note: This field may return null, indicating that no valid values can be obtained. |
Lifecycle hook
Used by actions: DescribeLifecycleHooks.
Name | Type | Description |
---|---|---|
LifecycleHookId | String | Lifecycle hook ID |
LifecycleHookName | String | Lifecycle hook name |
AutoScalingGroupId | String | Auto scaling group ID |
DefaultResult | String | Default result of the lifecycle hook |
HeartbeatTimeout | Integer | Wait timeout period of the lifecycle hook |
LifecycleTransition | String | Applicable scenario of the lifecycle hook |
NotificationMetadata | String | Additional information for the notification target |
CreatedTime | Timestamp ISO8601 | Creation time |
NotificationTarget | NotificationTarget | Notification target |
LifecycleTransitionType | String | Applicable scenario of the lifecycle hook |
LifecycleCommand | LifecycleCommand | Remote command execution object. Note: This field may return null, indicating that no valid values can be obtained. |
This describes the configuration and information related to instance login. For security reasons, sensitive information is not described.
Used by actions: DescribeLaunchConfigurations.
Name | Type | Description |
---|---|---|
KeyIds | Array of String | List of key IDs. |
Describes login settings of an instance.
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Password | String | No | Instance login password. ~!@#$%^&*-+=|{}[]:;',.?/]. <br><li>Windows: 12-16 characters. It should contain at least three sets of the following categories: [a-z], [A-Z], [0-9] and [() ~!@#$%^&*-+={}[]:;',.?/]. If this parameter is not specified, a random password is generated and sent to you via the Message Center. |
KeyIds | Array of String | No | List of key IDs. After an instance is associated with a key, you can access the instance with the private key in the key pair. You can call DescribeKeyPairs to obtain KeyId . Key and password cannot be specified at the same time. Windows instances do not support keys. Currently, you can only specify one key when purchasing an instance. |
KeepImageLogin | Boolean | No | Whether to keep the original settings of an image. It cannot be specified together with Password or KeyIds.N . You can specify this parameter as TRUE only when you create an instance using a custom image, a shared image, or an imported image. Valid values: TRUE : Keep the login settings of the image FALSE (Default): Do not keep the login settings of the image |
Alarming metric of AS
Used by actions: CreateScalingPolicy, DescribeScalingPolicies, ModifyScalingPolicy.
Name | Type | Required | Description |
---|---|---|---|
ComparisonOperator | String | Yes | Comparison operator. Value range: |
MetricName | String | Yes | Metric names, with the following optional fields: |
Threshold | Integer | Yes | Alarm threshold values: |
Period | Integer | Yes | Time period in seconds. Enumerated values: 60, 300. |
ContinuousTime | Integer | Yes | Number of repetitions. Value range: [1, 10] |
Statistic | String | No | Statistics type. Value range: Default value: AVERAGE |
PreciseThreshold | Float | No | Precise alarm threshold values. This parameter is not used as an input argument but is used solely as an output parameter for the query API: |
Notification target
Used by actions: CreateLifecycleHook, DescribeLifecycleHooks, ModifyLifecycleHook, UpgradeLifecycleHook.
Name | Type | Required | Description |
---|---|---|---|
TargetType | String | Yes | Target type. Valid values: CMQ_QUEUE , CMQ_TOPIC , TDMQ_CMQ_QUEUE and TDMQ_CMQ_TOPIC . |
QueueName | String | No | Queue name. This parameter is required when TargetType is CMQ_QUEUE or TDMQ_CMQ_QUEUE . |
TopicName | String | No | Topic name. This parameter is required when TargetType is CMQ_TOPIC or TDMQ_CMQ_TOPIC . |
Instance refresh activity.
Used by actions: DescribeRefreshActivities.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Scaling group ID. |
RefreshActivityId | String | Refresh activity ID. |
OriginRefreshActivityId | String | Original refresh activity ID, which exists only in the rollback refresh activity. Note: This field may return null, indicating that no valid value can be obtained. |
RefreshBatchSet | Array of RefreshBatch | Refresh batch information list. |
RefreshMode | String | Refresh mode. |
RefreshSettings | RefreshSettings | Instance update setting parameters. |
ActivityType | String | Refresh activity type. Valid values: |
Status | String | Refresh activity status. Valid values: |
CurrentRefreshBatchNum | Integer | Current refresh batch number. For example, a value of 2 indicates that the current activity is refreshing the second batch of instances. Note: This field may return null, indicating that no valid value can be obtained. |
StartTime | Timestamp ISO8601 | Refresh activity start time. Note: This field may return null, indicating that no valid value can be obtained. |
EndTime | Timestamp ISO8601 | Refresh activity end time. Note: This field may return null, indicating that no valid value can be obtained. |
CreatedTime | Timestamp ISO8601 | Refresh activity creation time. Note: This field may return null, indicating that no valid value can be obtained. |
Instance refresh batch information, containing the refresh status, instances, start and end time, etc., of the batch.
Used by actions: DescribeRefreshActivities.
Name | Type | Description |
---|---|---|
RefreshBatchNum | Integer | Refresh batch number. For example, a value of 2 indicates that the current batch of instances will be refreshed in the second batch. |
RefreshBatchStatus | String | Refresh batch status. Valid values: |
RefreshBatchRelatedInstanceSet | Array of RefreshBatchRelatedInstance | List of instances linked to a refresh batch. |
StartTime | Timestamp ISO8601 | Refresh batch start time. Note: This field may return null, indicating that no valid value can be obtained. |
EndTime | Timestamp ISO8601 | Refresh batch end time. Note: This field may return null, indicating that no valid value can be obtained. |
Refresh batch associated instances, including the refresh activity status of individual instances and related scaling activity information.
Used by actions: DescribeRefreshActivities.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. |
InstanceStatus | String | Refresh instance status. If an instance is removed or destroyed during the refresh process, its status will be updated to NOT_FOUND. Valid values: |
LastActivityId | String | The most recent scaling activity ID during instance refresh can be queried via the DescribeAutoScalingActivities API. Please note that scaling activities differ from instance refresh activities; a single instance refresh activity may involve multiple scaling activities. Note: This field may return null, indicating that no valid value can be obtained. |
InstanceStatusMessage | String | Instance refresh status information. Note: This field may return null, indicating that no valid value can be obtained. |
Instance refresh settings.
Used by actions: DescribeRefreshActivities, RollbackInstanceRefresh, StartInstanceRefresh.
Name | Type | Required | Description |
---|---|---|---|
RollingUpdateSettings | RollingUpdateSettings | Yes | Rolling update settings parameters. RefreshMode is the rolling update. This parameter must be filled in.Note: This field may return null, indicating that no valid value can be obtained. |
CheckInstanceTargetHealth | Boolean | No | Backend service health check status for instances, defaults to FALSE. This setting takes effect only for scaling groups bound with application load balancers. When enabled, if an instance fails the check after being refreshed, its load balancer port weight remains 0 and is marked as a refresh failure. Valid values: |
Information of the instances related to the current scaling activity.
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
InstanceStatus | String | Status of the instance in the scaling activity. Valid values:INIT : InitializingRUNNING : Processing the instanceSUCCESSFUL : Task succeeded on the instanceFAILED : Task failed on the instance |
Rolling update settings.
Used by actions: DescribeRefreshActivities, RollbackInstanceRefresh, StartInstanceRefresh.
Name | Type | Required | Description |
---|---|---|---|
BatchNumber | Integer | Yes | Batch quantity. The batch quantity should be a positive integer greater than 0, but cannot exceed the total number of instances pending refresh. |
BatchPause | String | No | Pause policy between batches. Default value: Automatic. Valid values: |
Status of TAT service.
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Enabled | Boolean | No | Whether to enable TencentCloud Automation Tools. Valid values:TRUE : EnableFALSE : Not enable.Note: This field may return null , indicating that no valid values can be obtained. |
This describes the information related to the Cloud Monitor service.
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Enabled | Boolean | No | Whether to enable the Cloud Monitor service. Value range: Default value: TRUE. | Note: This field may return null, indicating that no valid values can be obtained. |
This describes the information on the Cloud Security service
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
Enabled | Boolean | No | Whether to enable the Cloud Security service. Value range: Default value: TRUE. Note: This field may return null, indicating that no valid values can be obtained. |
Alarm trigger policy.
Used by actions: DescribeScalingPolicies.
Name | Type | Description |
---|---|---|
AutoScalingGroupId | String | Auto scaling group ID. |
AutoScalingPolicyId | String | Alarm trigger policy ID. |
ScalingPolicyType | String | Scaling policy type. Valid values: - SIMPLE : A simple policy.- TARGET_TRACKING : A target tracking policy. |
ScalingPolicyName | String | Alarm trigger policy name. |
AdjustmentType | String | The method to adjust the desired capacity after the alarm is triggered. It’s only available when ScalingPolicyType is Simple . Valid values: CHANGE_IN_CAPACITY : Increase or decrease the desired capacity EXACT_CAPACITY : Adjust to the specified desired capacity PERCENT_CHANGE_IN_CAPACITY : Adjust the desired capacity by percentage |
AdjustmentValue | Integer | The adjusted value of desired capacity after the alarm is triggered. This parameter is only applicable to a simple policy. |
Cooldown | Integer | Cooldown period. This parameter is only applicable to a simple policy. |
MetricAlarm | MetricAlarm | Alarm monitoring metrics of a simple policy. |
PredefinedMetricType | String | Preset monitoring item. It’s only available when ScalingPolicyType is TARGET_TRACKING . Valid values: Note: This field may return null , indicating that no valid values can be obtained. |
TargetValue | Integer | Target value. It’s only available when ScalingPolicyType is TARGET_TRACKING . Value ranges: ASG_AVG_CPU_UTILIZATION (in %): [1, 100)ASG_AVG_LAN_TRAFFIC_OUT (in Mbps): >0ASG_AVG_LAN_TRAFFIC_IN (in Mbps): >0ASG_AVG_WAN_TRAFFIC_OUT (in Mbps): >0ASG_AVG_WAN_TRAFFIC_IN (in Mbps): >0Note: This field may return null , indicating that no valid values can be obtained. |
EstimatedInstanceWarmup | Integer | Instance warm-up period (in seconds). It’s only available when ScalingPolicyType is TARGET_TRACKING . Value range: 0-3600.Note: This field may return null , indicating that no valid values can be obtained. |
DisableScaleIn | Boolean | Whether to disable scale-in. It’s only available when ScalingPolicyType is TARGET_TRACKING . Valid values: true : Scaling in is not allowed.false : Allows both scale-out and scale-inNote: This field may return null , indicating that no valid values can be obtained. |
MetricAlarms | Array of MetricAlarm | List of alarm monitoring metrics. This parameter is only applicable to a target tracking policy. Note: This field may return null , indicating that no valid values can be obtained. |
NotificationUserGroupIds | Array of String | Notification group ID, which is the set of user group IDs. |
This describes the information of a scheduled task.
Used by actions: DescribeScheduledActions.
Name | Type | Description |
---|---|---|
ScheduledActionId | String | Scheduled task ID. |
ScheduledActionName | String | Scheduled task name. |
AutoScalingGroupId | String | ID of the auto scaling group where the scheduled task is located. |
StartTime | Timestamp ISO8601 | Start time of the scheduled task. The value is in Beijing time (UTC+8) in the format of YYYY-MM-DDThh:mm:ss+08:00 according to the ISO8601 standard. |
Recurrence | String | Repeating mode of the scheduled task. |
EndTime | Timestamp ISO8601 | End time of the scheduled task. The value is in Beijing time (UTC+8) in the format of YYYY-MM-DDThh:mm:ss+08:00 according to the ISO8601 standard. |
MaxSize | Integer | Maximum number of instances set by the scheduled task. |
DesiredCapacity | Integer | Desired number of instances set by the scheduled task. |
MinSize | Integer | Minimum number of instances set by the scheduled task. |
CreatedTime | Timestamp ISO8601 | Creation time of the scheduled task. The value is in UTC time in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard. |
ScheduledType | String | Specifies how the scheduled action is executed. CRONTAB : execute repeatedly ONCE : execute only once |
Service settings
Used by actions: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup.
Name | Type | Required | Description |
---|---|---|---|
ReplaceMonitorUnhealthy | Boolean | No | Enables unhealthy instance replacement. If this feature is enabled, AS will replace instances that are flagged as unhealthy by Cloud Monitor. If this parameter is not specified, the value will be False by default. |
ScalingMode | String | No | Valid values: CLASSIC_SCALING: this is the typical scaling method, which creates and terminates instances to perform scaling operations. WAKE_UP_STOPPED_SCALING: this scaling method first tries to start stopped instances. If the number of instances woken up is insufficient, the system creates new instances for scale-out. For scale-in, instances are terminated as in the typical method. You can use the StopAutoScalingInstances API to stop instances in the scaling group. Scale-out operations triggered by alarms will still create new instances. Default value: CLASSIC_SCALING |
ReplaceLoadBalancerUnhealthy | Boolean | No | Enable unhealthy instance replacement. If this feature is enabled, AS will replace instances that are found unhealthy in the CLB health check. If this parameter is not specified, the default value False will be used. |
ReplaceMode | String | No | Replace mode of unhealthy replacement service. Valid values: RECREATE: Rebuild an instance to replace the original unhealthy instance. RESET: Performing a system reinstallation on unhealthy instances to keep information such as data disks, private IP addresses, and instance IDs unchanged. The instance login settings, HostName, enhanced services, and UserData will remain consistent with the current launch configuration. Default value: RECREATE. Note: This field may return null, indicating that no valid values can be obtained. |
Bidding-related options
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
MaxPrice | String | Yes | Bidding price such as "1.05" |
SpotInstanceType | String | No | Bid request type. Currently, only "one-time" type is supported. Default value: one-time Note: This field may return null, indicating that no valid values can be obtained. |
Specifies how to assign pay-as-you-go instances and spot instances in a mixed instance mode.
Used by actions: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup.
Name | Type | Required | Description |
---|---|---|---|
BaseCapacity | Integer | No | The minimum number of the scaling group’s capacity that must be fulfilled by pay-as-you-go instances. It defaults to 0 if not specified. Its value cannot exceed the max capacity of the scaling group. Note: this field may return null , indicating that no valid value can be obtained. |
OnDemandPercentageAboveBaseCapacity | Integer | No | Controls the percentage of pay-as-you-go instances for the additional capacity beyond BaseCapacity . Valid range: 0-100. The value 0 indicates that only spot instances are provisioned, while the value 100 indicates that only pay-as-you-go instances are provisioned. It defaults to 70 if not specified. The number of pay-as-you-go instances calculated on the percentage should be rounded up.For example, if the desired capacity is 3, the BaseCapacity is set to 1, and the OnDemandPercentageAboveBaseCapacity is set to 1, the scaling group will have 2 pay-as-you-go instance (one comes from the base capacity, and the other comes from the rounded up value of the proportion), and 1 spot instance.Note: this field may return null , indicating that no valid value can be obtained. |
SpotAllocationStrategy | String | No | Specifies how to assign spot instances in a mixed instance mode. Valid values: COST_OPTIMIZED and CAPACITY_OPTIMIZED ; default value: COST_OPTIMIZED .COST_OPTIMIZED : the lowest cost policy. For each model in the launch configuration, AS tries to purchase it based on the lowest unit price per core in each availability zone. If the purchase failed, try the second-lowest unit price.CAPACITY_OPTIMIZED : the optimal capacity policy. For each model in the launch configuration, AS tries to purchase it based on the largest stock in each availability zone, minimizing the automatic repossession probability of spot instances.Note: this field may return null , indicating that no valid value can be obtained. |
CompensateWithBaseInstance | Boolean | No | Whether to replace with pay-as-you go instances. Valid values:TRUE : yes. After the purchase of spot instances failed due to insufficient stock and other reasons, purchase pay-as-you-go instances.FALSE : no. The scaling group only tries the configured model of spot instances when it needs to add spot instances.Default value: TRUE .Note: this field may return null , indicating that no valid value can be obtained. |
System disk configuration of the launch configuration. If this parameter is not specified, the default value is assigned to it.
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
Name | Type | Required | Description |
---|---|---|---|
DiskType | String | No | System disk type. For more information on limits of system disk types, see Cloud Disk Types. Valid values:LOCAL_BASIC : local disk LOCAL_SSD : local SSD disk CLOUD_BASIC : HDD cloud disk CLOUD_PREMIUM : premium cloud storageCLOUD_SSD : SSD cloud disk Default value: CLOUD_PREMIUM .Note: this field may return null , indicating that no valid value can be obtained. |
DiskSize | Integer | No | System disk size in GB. Default value: 50 Note: This field may return null, indicating that no valid values can be obtained. |
Resource type and tag key-value pair
Used by actions: CreateAutoScalingGroup, CreateLaunchConfiguration, DescribeAutoScalingGroups, DescribeLaunchConfigurations.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Tag key |
Value | String | Yes | Tag value |
ResourceType | String | No | Type of the resource binded to the tag. Currently supported types include "auto-scaling-group" Note: This field may return null, indicating that no valid values can be obtained. |
Load balancer target attribute
Used by actions: AttachLoadBalancers, CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancerTargetAttributes, ModifyLoadBalancers.
Name | Type | Required | Description |
---|---|---|---|
Port | Integer | Yes | Port |
Weight | Integer | Yes | Weight |
Was this page helpful?