History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Information of auto scaling activity.
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
| Name | Type | Description |
|---|---|---|
| AutoScalingGroupId | String | Auto scaling group ID. |
| ActivityId | String | Scaling activity ID. |
| ActivityType | String | Scaling activity type. Valid values: |
| StatusCode | String | Scaling activity status. Valid values: |
| 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 auto scaling activity in UTC standard time. |
| EndTime | Timestamp ISO8601 | End time of the scaling activity in UTC standard time. |
| CreatedTime | Timestamp ISO8601 | Create time of the scaling activity in UTC standard time. |
| 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 the scaling activity status |
| InvocationResultSet | Array of InvocationResult | Result of the command execution |
| RelatedInstanceSet | Array of RelatedInstance | Related instance information set of 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 | Scaling suggestion warning level. 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 status of the scaling group. 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 | Destruction policy. valid values are as follows:. |
| VpcId | String | VPC ID. |
| ZoneSet | Array of String | List of availability zones |
| RetryPolicy | String | Retry policy. a partially successful scaling operation is considered a failed activity. valid values are as follows:. |
| 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. valid values: 0 and 1. default value: 0, which means the instance does not allocate an IPv6 address. use a private network that supports ip and enable IPv6 CIDR in the subnet. for usage restrictions, see IPv6 usage limits. |
| MultiZoneSubnetPolicy | String | Multi-AZ/subnet policy. |
| HealthCheckType | String | Scaling group instance health check type, whose valid values include: |
| LoadBalancerHealthCheckGracePeriod | Integer | Grace period of the CLB health check. the scaled-out instances IN IN_SERVICE will not be marked as CLB_UNHEALTHY within the specified time range.Default value: 0. value range: [0, 7200]. measurement unit: seconds. |
| InstanceAllocationPolicy | String | Instance assignment policy, whose valid values include LAUNCH_CONFIGURATION and SPOT_MIXED. |
| 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 | Capacity rebalancing feature, which is applicable only to spot instances within the scaling group. Valid values: |
| InstanceNameIndexSettings | InstanceNameIndexSettings | Instance name sequencing settings. |
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 | Notification event list. valid values are as follows:. |
| AutoScalingNotificationId | String | Event notification ID. |
| TargetType | String | Notification receiver type. valid values:. USER_GROUP: specifies the user group. TDMQ_CMQ_TOPIC: tdmq for cmq topic. TDMQ_CMQ_QUEUE: specifies the tdmq cmq queue. CMQ_QUEUE: cmq queue. cmq API offline. unable to select.CMQ_TOPIC: cmq topic. cmq API offline, unable to select. |
| QueueName | String | TDMQ CMQ queue name. |
| TopicName | String | TDMQ 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 types, see cloud block storage types. valid values:. The default value is consistent with the system disk type (SystemDisk.DiskType). |
| DiskSize | Integer | No | Data disk size, in GB. the value range varies according to the data disk type. for specific restrictions, see CVM instance configuration. default value: 0, which means no data disk is purchased. for more restrictions, see the product documentation. |
| SnapshotId | String | No | The data disk snapshot ID can be obtained through the DescribeSnapshots api. 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. specifies whether to enable burst performance. default value is false. this parameter only supports ultra-fast CLOUD disk (CLOUD_TSSD) and enhanced SSD CLOUD disk (CLOUD_HSSD) with capacity > 460GB. 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
Filterparameters, the relationship among them will be logicalAND.- If there are multiple
Valuesfor the sameFilter, the relationship among theValuesfor the sameFilterwill 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 | ID of the load balancer. this parameter is required as an input parameter. you can obtain it through the DescribeLoadBalancers api. |
| ListenerId | String | Yes | CLB listener ID. as an input parameter, this parameter is required. you can obtain it through the DescribeLoadBalancers api. |
| TargetAttributes | Array of TargetAttribute | Yes | Target rule attribute list. as an input parameter, this parameter is required. |
| LocationId | String | No | The forwarding rule ID. note: this parameter is required for layer-7 (http/https) listeners. it can be obtained through the DescribeLoadBalancers api. |
| 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. |
Specifies the serial number of the instance hostname related settings.
Used by actions: ModifyAutoScalingGroup.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable serial number creation for instance hostname. not enabled by default. valid values: TRUE: enable serial number creation for instance hostname. FALSE: disable serial number creation for instance hostname. . |
| BeginIndex | Integer | No | Initial serial number. value range depends on the IndexLength parameter: - when IndexLength is 0, value range is [0, 99999999]. - when IndexLength is [1, 8], value range is [0, 10^IndexLength-1], and the maximum value is the maximum digit of the specified length. default value of initial serial number is as follows: - first-time enabling incremental serial number: default value is 0 (display digits depend on IndexLength, for example if IndexLength is 4, display value is 0000). - non-first-time enabling incremental serial number: continuation of previous incremental serial number, for example if last usage incremented to serial number 069, new default value is 070. note: modification of initial serial number may lead to duplication within the scaling group. . |
| IndexLength | Integer | No | Incremental serial number length, defaults to 0, means no specified length. value range: 0-8, maximum is integer 8. - length set to 3, display form: 000, 001, 002 ... 010, 011 ... 100 ... 999, maximum is 999. - length set to 0, display form: 0, 1, 2 ... 10, 11 ... 100 ... 1000 ... 10000 ... 99999999, maximum is 99999999. note: continuous incremental serial number exceeding the limit can cause scale-out failure. do not set too small incremental serial number length. . |
CVM HostName settings
Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| HostName | String | Yes | Specifies the 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 | Specifies the hostname suffix for cvm. Note: This field may return null, indicating that no valid values can be obtained. |
| HostNameDelimiter | String | No | Specifies the delimiter for the CVM host name. The default delimiter is a dot (.). Valid values: - dot (.) - hyphen (-) - empty string. Delimiter used for concatenating host name, index, and suffix. Assuming host name is testGpu4090, index is 0007, and suffix is server. -The delimiter is a period (.), and the final concatenation is testGpu4090.007.server. -Specifies the delimiter as a hyphen (-), with the final concatenation as testGpu4090-007-server. -Delimiter is an empty string, finally concatenated as testGpu4090007server. |
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 are as follows:.TERMINATING: the instance is being terminated.TERMINATION_FAILED: the instance fails to be terminated.ATTACH_FAILED: the instance fails to be bound.DETACH_FAILED: the instance fails to be unbound.ATTACHING_LB: binding to lbMODIFYING_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. valid values are as follows:. |
| 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 join time is displayed in a format that conforms to the ISO8601 standard and uses UTC time. |
| InstanceType | String | Instance type |
| VersionNumber | Integer | Version number |
| AutoScalingGroupName | String | Auto scaling group name |
| WarmupStatus | String | Preheat status. valid values are as follows:.NO_NEED_WARMUP: warming up is not required. |
| DisasterRecoverGroupIds | Array of String | Placement group ID. Only one can be specified. |
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. The value can only be spot currently. |
Instance name index settings.
Used by actions: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable instance creation sequencing, disabled by default. valid values: TRUE: indicates that instance creation sequencing is enabled; FALSE: indicates that instance creation sequencing is disabled .Note: This field may return null, indicating that no valid values can be obtained. |
| BeginIndex | Integer | No | Initial serial number. the value range is related to the IndexLength parameter: - when IndexLength is 0, the value range is [0, 99999999]. - when IndexLength is [1, 8], the value range is [0, 10^IndexLength-1], and the maximum value is the maximum number with the specified digits. the default value of the initial serial number is as follows: - first-time enabling of incremental serial number: the default value is 0 (the display length is related to IndexLength, for example, if IndexLength is 4, the display value is 0000). - non-first-time enabling of incremental serial number: the previous incremental serial number is postponed, for example, if the last usage incremented to serial number 069, the new default initial serial number is 070. note: modifying the initial serial number may lead to duplication within the scaling group. .Note: This field may return null, indicating that no valid values can be obtained. |
| IndexLength | Integer | No | Incremental serial number length, defaults to 0, means no specified length. value range: 0-8, maximum is integer 8. - length set to 3, display form: 000, 001, 002 ... 010, 011 ... 100 ... 999, maximum is 999. - length set to 0, display form: 0, 1, 2 ... 10, 11 ... 100 ... 1000 ... 10000 ... 99999999, maximum is 99999999. note: continuous incremental serial number exceeding the limit can cause scale-out failure. do not set too small incremental serial number length. . |
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 suffix for a CVM instance name must be 1 to 105 characters in length. Additionally, the combined character count of the base instance name and the suffix must not exceed 107 characters. Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceNameDelimiter | String | No | Specifies the delimiter for the CVM instance name. The default delimiter is a dot (.). Valid values: - dot (.) - hyphen (-) - empty string. Delimiter used for concatenating instance name, index, and suffix. Assuming instance name is testGpu4090, index is 0007, and suffix is server. -The delimiter is a period (.), and the final concatenation is testGpu4090.007.server. -Specifies the delimiter as a hyphen (-), with the final concatenation as testGpu4090-007-server. -Delimiter is an empty string, finally concatenated as testGpu4090007server. |
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 type. Valid values: 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 address. Valid values: 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. |
| InternetServiceProvider | String | No | Line type. for details on various types of lines and supported regions, refer to EIP IP address type. default value: BGP. For a user who has enabled the static single-line IP allowlist, valid values include:. Note: The static single-line IP is only supported in some regions. |
| IPv4AddressType | String | No | Specifies the public IP type. If needed to assign an elastic IPv4 address to a resource, specify the elastic IPv4 address type. if only use WanIP, do not set this field. High quality IP the anti-ddos feature is only in beta test in some regions. if needed, submit a ticket for consultation (https://console.tencentcloud.com/workorder/category). |
| AntiDDoSPackageId | String | No | Anti-DDoS service package ID. This is required when you want to request an Anti-DDoS IP. |
| IsKeepEIP | Boolean | No | Whether to delete the bound EIP(HighQualityEIP and AntiDDoSEIP) when the instance is destroyed. Range of values: WanIP is unaffected by this field and will always be deleted with the instance. Changing this field configuration will take effect immediately for resources already bound to a scaling group. |
Result of the command execution
Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| InvocationId | String | Execution activity ID. |
| InvocationTaskId | String | Task ID. |
| CommandId | String | Command ID. |
| TaskStatus | String | Specifies the execution task status. |
| ErrorMessage | String | Specifies the exception information during execution. |
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 | Specifies the startup configuration creation time. uses UTC standard time. |
| 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. valid values:. |
| 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. this parameter specifies tags only used for binding the launch configuration and will not be passed to CVM instances scaled out based on it. |
| VersionNumber | Integer | Version |
| UpdatedTime | Timestamp ISO8601 | Last update time is in standard UTC time. |
| CamRoleName | String | Role name of the CAM role. can be obtained from roleName in the return value from the DescribeRoleList API (https://www.tencentcloud.com/document/product/598/36223?from_cn_redirect=1). |
| 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. |
| DedicatedClusterId | String | CDC ID. |
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. this item is required if you select to execute command. |
| Parameters | String | No | Custom parameter. field type is json encoded string, for example: {"varA": "222"}. key specifies the custom parameter name, and value specifies the default. both are string type. If the parameter value is not provided, the DefaultParameters of Command will be used to replace it. Custom parameters support a maximum of 20 entries. the custom parameter name must meet the following standard: number of characters has a cap of 64, value range [a-zA-Z0-9-_]. |
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 | Action to be taken by the scaling group in case of lifecycle hook timeout or LifecycleCommand execution failure. valid values:. -CONTINUE execution by default means capacity expansion or reduction. -For scale-out hooks, cvms with hook timeout or failed LifecycleCommand execution will be released directly or removed; for scale-in hooks, scale-in activities will continue. |
| HeartbeatTimeout | Integer | Specifies the timeout waiting time of the lifecycle hook in seconds. value range: 30 to 7200. |
| LifecycleTransition | String | Scenario for entering the lifecycle hook. valid values:. - INSTANCE_LAUNCHING: the lifecycle hook is being scaled out.-INSTANCE_TERMINATING: scale-in lifecycle hook. |
| NotificationMetadata | String | Additional information for the notification target |
| CreatedTime | Timestamp ISO8601 | Creation time. uses UTC for timing. |
| NotificationTarget | NotificationTarget | Notification target |
| LifecycleTransitionType | String | Specifies the scenario type for performing the lifecycle hook. valid values: NORMAL and EXTENSION. default value: NORMAL. Description: when set to EXTENSION, the lifecycle hook will be triggered during AttachInstances, DetachInstances, or RemoveInstances API calls. if set to NORMAL, the lifecycle hook will not be triggered by these apis. |
| LifecycleCommand | LifecycleCommand | Remote command execution object. |
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. The password complexity requirements vary according to the operating system type. The details are as follows: - For a Linux system, the password should contain 8 to 30 characters consisting of at least two of the four character types: lowercase letters, uppercase letters, digits, and special characters. - For a Windows system, the password should contain 12 to 30 characters consisting of at least three of the four character types: lowercase letters, uppercase letters, digits, and special characters. - If this parameter is not specified, the system will generate a random password and notify the user via the message centerSupported special characters: ( ) ` ~ ! @ # $ % ^ & * - + = |
| KeyIds | Array of String | No | List of key ids. after associating a key, you can access the instance through the corresponding private key. KeyId can be obtained by calling the api DescribeKeyPairs. key and password cannot be specified simultaneously. the Windows operating system does not support specifying a key. currently, only one key can be specified during purchase. |
| KeepImageLogin | Boolean | No | Retain the original settings of the image. This parameter cannot be specified simultaneously with Password or KeyIds.N. It can only be set to TRUE when you create an instance by using a custom image, shared image, or externally imported image. Valid values: |
Custom Metadata
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| Items | Array of MetadataItem | No | Custom metadata key-value pair list. |
A set of key-value pair information for custom Metadata
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | Custom metadata key. |
| Value | String | Yes | Custom metadata value. |
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 include CMQ_QUEUE, CMQ_TOPIC, TDMQ_CMQ_QUEUE, 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. exists only in rollback refresh activity. |
| RefreshBatchSet | Array of RefreshBatch | Refresh batch information list. |
| RefreshMode | String | Refresh mode. valid values as follows:. |
| 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, 2 indicates the second batch of instances is being refreshed by the current activity. |
| StartTime | Timestamp ISO8601 | The activity start time is refreshed in standard UTC time, in the format YYYY-MM-DDTHH:MM:ssZ.Note: This field may return null, indicating that no valid values can be obtained. |
| EndTime | Timestamp ISO8601 | Refresh activity end time, in standard UTC time, in the format YYYY-MM-DDTHH:MM:ssZ. Note: This field may return null, indicating that no valid values can be obtained. |
| CreatedTime | Timestamp ISO8601 | Refresh activity creation time, in standard UTC time, in the format YYYY-MM-DDTHH:MM:ssZ. |
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 the instance is removed or terminated during refresh, the 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. |
| InstanceStatusMessage | String | Describes the instance refresh status. |
Instance refresh settings.
Used by actions: DescribeRefreshActivities, RollbackInstanceRefresh, StartInstanceRefresh.
| Name | Type | Required | Description |
|---|---|---|---|
| RollingUpdateSettings | RollingUpdateSettings | Yes | Rolling update settings parameters. RefreshMode is rolling update. this parameter must be filled in. |
| CheckInstanceTargetHealth | Boolean | No | Whether to enable the backend service health check for the instance. Default value: FALSE. This parameter is valid only for the scaling group bound to an application-based CLB. After this feature is enabled, if the instance fails the check after refresh, the port weight of the CLB will be always 0, and it will be 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: |
| MaxSurge | Integer | No | The maximum additional quantity of instances. After this parameter is set, create a batch of additional pay-as-you-go instances according to the launch configuration before the rolling update starts. After the rolling update is completed, the additional instances will be terminated.This parameter is used to ensure a certain number of instances available during the rolling update. The maximum additional quantity of instances cannot exceed the number of refreshing instances in a single batch of the rolling update. The rollback process does not support this parameter currently. |
| FailProcess | String | No | Failure handling strategy. default value: AUTO_PAUSE. 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. |
Information related to Tencent Cloud Observability Platform (TCOP, formerly Cloud Monitor).
Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | Boolean | No | Whether to enable Tencent Cloud Observability Platform (formerly Cloud Monitor) (TCOP). Valid values: Default value: TRUE. |
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 Cloud Workload Protection Platform (CWPP). Valid values: Default value: TRUE. |
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 duration in seconds, applies only to simple policies. value range [0,3600]. default cooldown: 300 seconds. |
| 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 | Specifies the repeating mode of the scheduled task. the Recurrence parameter limits (https://www.tencentcloud.com/document/product/377/88119?from_cn_redirect=1) consist of 5 fields separated by space, with the structure: minute, hour, date, month, week. |
| 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 | The creation time of the scheduled task. value is in standard UTC time, formatted as YYYY-MM-DDThh:MM:ssZ according to the ISO8601 standard. |
| ScheduledType | String | Scheduled task execution type. Valid values: |
| DisableUpdateDesiredCapacity | Boolean | Disable update DesiredCapacity Indicates the DesiredCapacity is updated normally during scheduled task triggering. Specifies whether the scheduled task triggers proactive modification of the DesiredCapacity when the value is True. DesiredCapacity may be modified by the minSize and maxSize mechanism. The following cases assume that DisableUpdateDesiredCapacity is True: - When scheduled task triggered, the original DesiredCapacity is 5. The scheduled task changes the minSize to 10, the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 5 is less than minSize 10, so the final new DesiredCapacity is 10. - When scheduled task triggered, the original DesiredCapacity is 25. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect. However, the original DesiredCapacity 25 is greater than the maxSize 20, so the final new DesiredCapacity is 20. - When scheduled task triggered, the original DesiredCapacity is 13. The scheduled task changes the minSize to 10 and the maxSize to 20, and the DesiredCapacity to 15. Since the DesiredCapacity update is disabled, 15 does not take effect, and the DesiredCapacity is still 13. |
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 | Replacement mode of the unhealthy replacement service. valid values:. RECREATE: rebuild an instance to replace the unhealthy instance. RESET: performs a system reinstallation on unhealthy instances while keeping the data disk, private IP address, instance id, and other information unchanged. the instance login settings, hostname, enhanced services, and UserData remain consistent with the current launch configuration. Default value: RECREATE. |
| AutoUpdateInstanceTags | Boolean | No | Automatic instance Tag update. the default value is False. if this feature is enabled, tags of running instances in a scaling group will be updated as well if the scaling group tags are updated. (this feature takes effect for Tag creation and editing but not Tag deletion.) the update does not take effect immediately due to certain latency. |
| DesiredCapacitySyncWithMaxMinSize | Boolean | No | Expected number of instances sync minimum and maximum value. default value is False. this parameter only takes effect in scenarios where the expected number is not passed in to modify scaling group api. |
| PriorityScaleInUnhealthy | Boolean | No | Scaling in unhealthy instances first. If enabled, preferentially selects unhealthy instances during scale in. Default value: False. |
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 | Spot instance type. The value can only be one-time currently. Default value: one-time. |
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 restrictions on the system disk type, see cloud block storage types. valid values:. |
| DiskSize | Integer | No | System disk size, in GB. Default value: 50. |
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 | Specifies the resource type bound to the tag. type currently supported: "auto-scaling-group", "launch-configuration". valid values: scaling group resources and launch configuration resources respectively. |
Load balancer target attribute
Used by actions: AttachLoadBalancers, CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancerTargetAttributes, ModifyLoadBalancers.
| Name | Type | Required | Description |
|---|---|---|---|
| Port | Integer | Yes | Port. value range: [1,65535]. as an input parameter, this parameter is required. |
| Weight | Integer | Yes | Weight. value range: [0,100]. this parameter is required as an input parameter. |
피드백