tencent cloud

Data Types
Download PDF
Last updated: 2025-11-25 16:04:07
Data Types
Last updated: 2025-11-25 16:04:07
Download PDF

Activity

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:
  • SCALE_OUT: Scale out instance(s).
  • SCALE_IN: Scale in instance(s).
  • ATTACH_INSTANCES: Add instance(s).
  • REMOVE_INSTANCES: Terminate instance(s).
  • DETACH_INSTANCES: Remove instance(s).
  • TERMINATE_INSTANCES_UNEXPECTEDLY: Instance(s) unexpectedly terminated in the CVM console.
  • REPLACE_UNHEALTHY_INSTANCE: Replace unhealthy instance(s).
  • START_INSTANCES: Start instance(s).
  • STOP_INSTANCES: Stop instance(s).
  • INVOKE_COMMAND: Execute a command in instance(s).
    		•
    StatusCode String Scaling activity status. Valid values:
  • INIT: initializing.
  • RUNNING: running.
  • SUCCESSFUL: successful.
  • PARTIALLY_SUCCESSFUL: partially successful.
  • FAILED: failed.
  • CANCELLED: canceled.
    		•
    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.

    Advice

    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:
  • WARNING: warning.
  • CRITICAL: critical.
    		•

    AutoScalingAdvice

    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:
  • NORMAL: normal.
  • WARNING: warning.
  • CRITICAL: critical.
    		•
    Advices Array of Advice A collection of suggestions for scaling group configurations.

    AutoScalingGroup

    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:
  • NORMAL: The scaling group is normal.
  • CVM_ABNORMAL: The launch configuration is abnormal.
  • LB_ABNORMAL: The CLB is abnormal.
  • LB_LISTENER_ABNORMAL: The CLB listener is abnormal.
  • LB_LOCATION_ABNORMAL: The forwarding configuration of the CLB listener is abnormal.
  • VPC_ABNORMAL: The VPC is abnormal.
  • SUBNET_ABNORMAL: The VPC subnet is abnormal.
  • INSUFFICIENT_BALANCE: The balance is insufficient.
  • LB_BACKEND_REGION_NOT_MATCH: The region of the CLB instance backend does not match that of the AS service.
  • LB_BACKEND_VPC_NOT_MATCH: The VPC of the CLB instance does not match that of the scaling group.
    		•
    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:.
  • OLDEST_INSTANCE: terminate the oldest instance in the scaling group first, default value.
    • .
  • NEWEST_INSTANCE: terminate the newest instance in the scaling group first.
    • .
    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:.
  • IMMEDIATE_RETRY: default value, means retry immediately, attempting retries in rapid succession over a short period. cease further retries after a certain number of consecutive failures (5).
    • .
  • INCREMENTAL_INTERVALS: specifies incremental interval retry. with the number of consecutive failures, the retry interval gradually increases. the first 10 retries are quick retry, and the follow-up retry interval gradually expands to 10 minutes, 30 minutes, 60 minutes, and one day.
    • .
  • NO_RETRY: there will be no retry until another user call or Alarm information is received.
    • .
    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.
  • PRIORITY: The instances are attempted to be created taking the order of the AZ/subnet list as the priority. If the highest-priority AZ/subnet can create instances successfully, instances can always be created in that AZ/subnet.
  • EQUALITY: Select the AZ/subnet with the least number of instances for scale-out. In this way, each AZ/subnet has an opportunity for scale-out. Instances produced from multiple scale-out operations will be distributed to multiple AZs/subnets.
    		•
    HealthCheckType String Scaling group instance health check type, whose valid values include:
  • CVM: Determine whether an instance is unhealthy based on its network status. An unhealthy network status is indicated by an event where instances become unreachable via PING. Detailed criteria of judgment can be found in Instance Health Check.
  • CLB: Determine whether an instance is unhealthy based on the health check status of CLB. For principles behind CLB health checks, see Health Check.
    		•
    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.
  • LAUNCH_CONFIGURATION: Represent the traditional mode of assigning instances according to the launch configuration.
  • SPOT_MIXED: Represent the spot mixed mode. Currently, this mode is supported only when the launch configuration is set to the pay-as-you-go billing mode. In the mixed mode, the scaling group will scale out pay-as-you-go models or spot models based on the predefined settings. When the mixed mode is used, the billing type of the associated launch configuration cannot be modified.
    		•
    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:
  • TRUE: Enable this feature. When spot instances in the scaling group are about to be automatically recycled by the spot instance service, AS proactively initiates the termination process of the spot instances. If there is a configured scale-in hook, it will be triggered before termination. After the termination process starts, AS asynchronously initiates the scale-out to reach the expected number of instances.
  • FALSE: Disable this feature. AS waits for the spot instance to be terminated before scaling out to reach the number of instances expected by the scaling group.
    		•
    InstanceNameIndexSettings InstanceNameIndexSettings Instance name sequencing settings.

    AutoScalingGroupAbstract

    Brief information of a scaling group.

    Used by actions: DescribeLaunchConfigurations.

    Name Type Description
    AutoScalingGroupId String Scaling group ID
    AutoScalingGroupName String Auto scaling group name.

    AutoScalingNotification

    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:.
  • SCALE_OUT_SUCCESSFUL: scale-out succeeded
    • .
  • SCALE_OUT_FAILED: scale-out failed
    • .
  • SCALE_IN_SUCCESSFUL: scale-in succeeded
    • .
  • SCALE_IN_FAILED: scale-in failed
    • .
  • REPLACE_UNHEALTHY_INSTANCE_SUCCESSFUL: unhealthy instance replacement succeeded
    • .
  • REPLACE_UNHEALTHY_INSTANCE_FAILED: unhealthy instance replacement failed
    • .
    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.

    DataDisk

    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:.
  • LOCAL_BASIC: local hard disk.
    • .
  • LOCAL_SSD: local ssd.
    • .
  • CLOUD_BASIC: general cloud disk.
    • .
  • CLOUD_PREMIUM: high-performance cloud block storage
    • .
  • CLOUD_SSD: cloud ssd
    • .
  • CLOUD_HSSD: enhanced ssd cloud disk
    • .
  • CLOUD_TSSD: ultra ssd.
    • .
  • CLOUD_BSSD: universal ssd cloud disk
    • .
    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:
  • TRUE: When the instance is terminated, the data disk is also terminated. This option is only supported for hourly postpaid cloud disks.
  • FALSE: When the instance is terminated, the data disk is retained.

    • 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:
  • TRUE: Encrypted.
  • FALSE: Not encrypted.

    • 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.

    DetailedStatusMessage

    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

    EnhancedService

    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.

    Filter

    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 logical AND.
    • If there are multiple Values for the same Filter, the relationship among the Values for the same Filter will be logical OR.

    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.

    ForwardLoadBalancer

    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.

    ForwardLoadBalancerIdentification

    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.

    HostNameSettings

    CVM HostName settings

    Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, ModifyLaunchConfigurationAttributes, UpgradeLaunchConfiguration.

    Name Type Required Description
    HostName String Yes CVM HostName.
  • Dots (.) and hyphens (-) cannot be used as the first or last character of HostName, and cannot be used consecutively.
  • Windows instances are not supported.
  • Instances of other types (e.g., Linux): The length of the character should be within the range of [2, 40]. Multiple dots (.) are allowed. Each segment between dot marks can consist of letters (case-insensitive), digits, and hyphens (-). Using only digits is not allowed.

    • 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.
  • ORIGINAL: AS passes HostName filled in the input parameters to CVM. CVM may append serial numbers to HostName, which can result in conflicts with HostName of instances in the scaling group.
  • UNIQUE: HostName filled in the input parameters acts as a prefix for the HostName. AS and CVM will expand this prefix to ensure that HostName of the instance in the scaling group is unique.

    • Note: This field may return null, indicating that no valid values can be obtained.
    HostNameSuffix String No HostName suffix for CVM.
  • Dots (.) and hyphens (-) cannot be used as the first or last character of HostNameSuffix, and cannot be used consecutively.
  • Windows instances are not supported.
  • Instances of other types (e.g., Linux): The length of the character should be within the range of [1, 37], and the combined length with HostName should not exceed 39. Multiple dots (.) are allowed. Each segment between dots can consist of letters (case-insensitive), digits, and hyphens (-).

    • 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.

    IPv6InternetAccessible

    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.

  • IPv6 supports TRAFFIC_POSTPAID_BY_HOUR under a bill-by-IP account.

  • IPv6 supports 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

    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:.
  • IN_SERVICE: running
    • .
  • CREATING: specifies the instance is being created.
    • .
  • CREATION_FAILED: creation failed.
    • .
  • TERMINATING: the instance is being terminated.
    • .
  • TERMINATION_FAILED: the instance fails to be terminated.
    • .
  • ATTACHING: binding
    • .
  • ATTACH_FAILED: the instance fails to be bound.
    • .
  • DETACHING: specifies the unbinding is in progress.
    • .
  • DETACH_FAILED: the instance fails to be unbound.
    • .
  • ATTACHING_LB: binding to lb
    • .
  • DETACHING_LB: the lb is being unbound.
    • .
  • 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. valid values are as follows:.
  • HEALTHY: the instance is in Healthy status.
    • .
  • UNHEALTHY: instance ping unreachable
    • .
  • CLB_UNHEALTHY: the instance port listened by clb is 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 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:.
  • WAITING_ENTER_WARMUP: specifies the instance is waiting to enter preheating.
    • .
  • NO_NEED_WARMUP: warming up is not required.
    • .
  • IN_WARMUP: preheating.
    • .
  • AFTER_WARMUP: indicates the preheating is completed.
    • .
    DisasterRecoverGroupIds Array of String Placement group ID. Only one can be specified.

    InstanceChargePrepaid

    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:
  • NOTIFY_AND_AUTO_RENEW: Notify upon expiration and automatically renew.
  • NOTIFY_AND_MANUAL_RENEW: Notify upon expiration but do not auto-renew.
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Do not notify and do not auto-renew
    • Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is set to NOTIFY_AND_AUTO_RENEW, and the account balance is sufficient, the instance will automatically renew monthly upon its expiration date.

    InstanceMarketOptionsRequest

    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.

    InstanceNameIndexSettings

    Instance name index settings.

    Used by actions: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup.

    Name Type Required Description
    Enabled Boolean No Whether to enable instance name index. Default value: false. Value range:.

    true: indicates that instance name index is enabled.
    false: indicates that instance name index is disabled.
    Note: This field may return null, indicating that no valid values can be obtained.
    BeginIndex Integer No Begin index number. Value range: [0, 99999999].

    Indicates that the scale out activity will be failed when the index out of range.
    If not specified, carries forward historical index number or 0.
    Lowering the index sequence number may lead to instance name duplication within the group.
    Note: This field may return null, indicating that no valid values can be obtained.
    IndexLength Integer No Instance name index number digits, defaults to 0, means no specified digit count. Value range: 0-8, maximum is integer 8. when using values 1-8, the system checks whether the index number exceeds the maximum digit for this digit count.

    If set to 3, index number is in the format: 000, 001, 002 ... 010, 011 ... 100 ... 999. The maximum is 999.
    Assuming set to 0, the index number is 0, 1, 2 ... 10, 11 ... 100 ... 1000 ...10000 ... 99999999. Max number is 99999999.

    InstanceNameSettings

    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.

    InstanceTag

    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

    InternetAccessible

    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:
  • BANDWIDTH_PREPAID: prepaid by bandwidth;
  • TRAFFIC_POSTPAID_BY_HOUR: postpaid by traffic per hour;
  • BANDWIDTH_POSTPAID_BY_HOUR: postpaid by bandwidth per hour;
  • BANDWIDTH_PACKAGE: bandwidth package users.
    • 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 address. Valid values:
  • TRUE: Allocate a public IP address.
  • FALSE: Do not allocate a public IP address.
    • When the public network bandwidth is greater than 0 Mbps, you can choose whether to enable this feature based on your needs. By default, this feature is enabled. When the public network bandwidth is 0, public IP address assignment is not allowed.
    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 Describes the line type. For details, refer to EIP Product Overview. default value: BGP.

  • BGP: general bgp line.

    • For a user who has enabled the static single-line IP allowlist, valid values include:
  • CMCC: China Mobile
  • CTCC: China Telecom
  • CUCC: China Unicom

    • Note: Only certain regions support static single-line IP addresses.
    IPv4AddressType String No Type of public IP address.

  • WanIP: Ordinary public IP address.
  • HighQualityEIP: High Quality EIP is supported only in Singapore and Hong Kong.
  • AntiDDoSEIP: Anti-DDoS IP is supported only in specific regions. For details, see EIP Product Overview.

    • Specify the type of public IPv4 address to assign a public IPv4 address to the resource. HighQualityEIP and AntiDDoSEIP features are gradually released in select regions. For usage, submit a ticket for consultation.
    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:

  • TRUE: retain the EIP
  • FALSE: not retain the EIP
    • Note that when the IPv4AddressType field specifies the EIP type, the default behavior is not to retain the EIP.
    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.

    InvocationResult

    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.

    LaunchConfiguration

    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:
  • NORMAL: Normal.
  • IMAGE_ABNORMAL: Image exception in the launch configuration.
  • CBS_SNAP_ABNORMAL: Exception with data disk snapshot in the launch configuration.
  • SECURITY_GROUP_ABNORMAL: Security group exception in the launch configuration.
    		•
    InstanceChargeType String Instance billing type. valid values:.
  • POSTPAID_BY_HOUR: pay-as-you-go hourly
    • .
  • SPOTPAID: spot payment
    • .
  • PREPAID: prepaid, i.e., monthly subscription
    • .
  • CDCPAID: dedicated cluster payment
    • .
    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:
  • ORIGINAL: Use the set cloud disk type.
  • AUTOMATIC: Automatically select available cloud disk types in the current availability zone.
    		•
    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.

    LifecycleActionResultInfo

    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.

  • SUCCESSFUL: It is successful to notify CMQ/TDMQ.
  • FAILED: It is failed to notify CMQ/TDMQ.
  • NONE
    		•
    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 result
  • ANOTHER_ACTION_ABANDON: It has been set to ABANDON by another operation.
  • COMMAND_CALL_FAILURE: Failed to call the command. The DefaultResult is applied.
  • COMMAND_EXEC_FINISH: Command completed
  • COMMAND_CALL_FAILURE: Failed to execute the command. The DefaultResult is applied.
  • COMMAND_EXEC_RESULT_CHECK_FAILURE: Failed to check the command result. The DefaultResult is applied.
    		•

    LifecycleCommand

    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-_].

    LifecycleHook

    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.

    LimitedLoginSettings

    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.

    LoginSettings

    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:
  • TRUE: Retain the login settings of the image.
  • FALSE: Do not retain the login settings of the image.
    • Default value: FALSE.

    Metadata

    Custom Metadata

    Used by actions: CreateLaunchConfiguration, ModifyLaunchConfigurationAttributes.

    Name Type Required Description
    Items Array of MetadataItem No Custom metadata key-value pair list.

    MetadataItem

    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.

    MetricAlarm

    Alarming metric of AS

    Used by actions: CreateScalingPolicy, DescribeScalingPolicies, ModifyScalingPolicy.

    Name Type Required Description
    ComparisonOperator String Yes Comparison operator. Value range:
  • GREATER_THAN: greater than
  • GREATER_THAN_OR_EQUAL_TO: greater than or equal to
  • LESS_THAN: less than
  • LESS_THAN_OR_EQUAL_TO: less than or equal to
  • EQUAL_TO: equal to
  • NOT_EQUAL_TO: not equal to
    • MetricName String Yes Metric names, with the following optional fields:
  • CPU_UTILIZATION: CPU utilization.
  • MEM_UTILIZATION: Memory utilization.
  • LAN_TRAFFIC_OUT: Private network outbound bandwidth.
  • LAN_TRAFFIC_IN: Private network inbound bandwidth.
  • WAN_TRAFFIC_OUT: Public network outbound bandwidth.
  • WAN_TRAFFIC_IN: Public network inbound bandwidth.
  • TCP_CURR_ESTAB: TCP connections.
    		•
    Threshold Integer Yes Alarm threshold values:
  • CPU_UTILIZATION: [1, 100], Unit: %.
  • MEM_UTILIZATION: [1, 100], Unit: %.
  • LAN_TRAFFIC_OUT: >0, Unit: Mbps.
  • LAN_TRAFFIC_IN: >0, Unit: Mbps.
  • WAN_TRAFFIC_OUT: >0, Unit: Mbps.
  • WAN_TRAFFIC_IN: >0, Unit: Mbps.
  • TCP_CURR_ESTAB: >0, Unit: Count.
    		•
    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:
  • AVERAGE: average
  • MAXIMUM: maximum
  • MINIMUM: minimum

    • 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:
  • CPU_UTILIZATION: (0, 100], Unit: %.
  • MEM_UTILIZATION: (0, 100], Unit: %.
  • LAN_TRAFFIC_OUT: >0, Unit: Mbps.
  • LAN_TRAFFIC_IN: >0, Unit: Mbps.
  • WAN_TRAFFIC_OUT: >0, Unit: Mbps.
  • WAN_TRAFFIC_IN: >0, Unit: Mbps.
  • TCP_CURR_ESTAB: >0, Unit: Count.
    		•

    NotificationTarget

    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.
  • CMQ_QUEUE, specifies tencent cloud message QUEUE - queueing model. the corresponding product is offline. it is recommended to switch to TDMQ_CMQ_QUEUE (https://www.tencentcloud.com/document/product/1496/83970?from_cn_redirect=1).
    • .
  • CMQ_TOPIC, specifies tencent cloud message queue - TOPIC model. the corresponding product is offline. it is recommended to switch to TDMQ_CMQ_TOPIC (https://www.tencentcloud.com/document/product/1496/83970?from_cn_redirect=1).
    • .
  • TDMQ_CMQ_QUEUE. specifies the tencent cloud TDMQ message QUEUE - queueing model.
    • .
  • TDMQ_CMQ_TOPIC. specifies tencent cloud tdmq message queue - topic model.
    • .
    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.

    RefreshActivity

    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:.
  • ROLLING_UPDATE_RESET: reinstall the system for rolling updates.
    • .
  • ROLLING_UPDATE_REPLACE: Create an instance and replace the old instance with it for rolling updates. This mode does not support the rollback API currently.
    		•
    RefreshSettings RefreshSettings Instance update setting parameters.
    ActivityType String Refresh activity type. Valid values:
  • NORMAL: normal refresh activity.
  • ROLLBACK: rollback refresh activity.
    		•
    Status String Refresh activity status. Valid values:
  • INIT: initializing.
  • RUNNING: running.
  • SUCCESSFUL: successful.
  • FAILED_PAUSE: paused due to the failure of a refresh batch.
  • AUTO_PAUSE: automatically paused due to the pause policy.
  • MANUAL_PAUSE: manually paused.
  • CANCELLED: canceled.
  • FAILED: failed.
    		•
    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.

    RefreshBatch

    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:
  • WAITING: pending refresh;
  • INIT: initializing;
  • RUNNING: refreshing;
  • FAILED: refresh failed;
  • PARTIALLY_SUCCESSFUL: partially successful in the batch;
  • CANCELLED: cancelled;
  • SUCCESSFUL: refresh successful.
    		•
    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.

    RefreshBatchRelatedInstance

    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:
  • WAITING: pending refresh;
  • INIT: initializing;
  • RUNNING: refreshing;
  • FAILED: refresh FAILED;
  • CANCELLED: CANCELLED;
  • SUCCESSFUL: refresh SUCCESSFUL;
  • NOT_FOUND: instance does NOT exist.
    • .
    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.

    RefreshSettings

    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:
  • TRUE: enable;
  • FALSE: disable.
    		•

    RelatedInstance

    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: Initializing
    RUNNING: Processing the instance
    SUCCESSFUL: Task succeeded on the instance
    FAILED: Task failed on the instance

    RollingUpdateSettings

    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:
  • FIRST_BATCH_PAUSE: Pause after the first batch of updates is completed.
  • BATCH_INTERVAL_PAUSE: Pause between batches.
  • AUTOMATIC: Do not pause.
    		•
    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:.
  • AUTO_PAUSE: suspended after refresh fails
    • .
  • AUTO_ROLLBACK: roll back after a refresh fails. each batch rolls back one instance during ROLLBACK, and the CheckInstanceTargetHealth parameter value matches the original refresh activity. no need to roll back if the shrinkage process introduced by the MaxSurge parameter fails. a cancel action will replace the ROLLBACK.
    • .
  • AUTO_CANCEL: cancel after refresh fails
    • .

    RunAutomationServiceEnabled

    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: Enable
  • FALSE: Not enable.
    Note: This field may return null, indicating that no valid values can be obtained.
    		•

    RunMonitorServiceEnabled

    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:
  • TRUE: enable TCOP.
  • FALSE: disable TCOP.

    • Default value: TRUE.

    RunSecurityServiceEnabled

    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:
  • TRUE: enable CWPP.
  • FALSE: disable CWPP.

    • Default value: TRUE.

    ScalingPolicy

    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:
  • ASG_AVG_CPU_UTILIZATION: Average CPU utilization
  • ASG_AVG_LAN_TRAFFIC_OUT: Average private bandwidth out
  • ASG_AVG_LAN_TRAFFIC_IN: Average private bandwidth in
  • ASG_AVG_WAN_TRAFFIC_OUT: Average public bandwidth out
  • ASG_AVG_WAN_TRAFFIC_IN: Average public bandwidth in

    • 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): >0
  • ASG_AVG_LAN_TRAFFIC_IN (in Mbps): >0
  • ASG_AVG_WAN_TRAFFIC_OUT (in Mbps): >0
  • ASG_AVG_WAN_TRAFFIC_IN (in Mbps): >0

    • Note: 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-in

    • Note: 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.

    ScheduledAction

    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:
  • CRONTAB: repeated execution.
  • ONCE: single execution.
    		•

    ServiceSettings

    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.
  • True: when modifying the maximum or minimum value, if a conflict exists with the current expected value, synchronously adjust the expected value. for example, if the input minimum value is 2 while the current expected value is 1, the expected value will be synchronously adjusted to 2.
    • .
  • False: if a conflict exists between the current expected value when modifying the maximum or minimum value, an error message indicates it is not allowed to be modified.
    • .
    PriorityScaleInUnhealthy Boolean No Scaling in unhealthy instances first. If enabled, preferentially selects unhealthy instances during scale in. Default value: False.

    SpotMarketOptions

    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.

    SpotMixedAllocationPolicy

    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.
    		•

    SystemDisk

    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:.
  • LOCAL_BASIC: local hard disk.
    • .
  • LOCAL_SSD: local ssd.
    • .
  • CLOUD_BASIC: general cloud disk.
    • .
  • CLOUD_PREMIUM: high-performance cloud block storage
    • .
  • CLOUD_SSD: cloud ssd
    • .
  • CLOUD_BSSD: universal ssd cloud disk
    • .
  • CLOUD_HSSD: enhanced ssd cloud disk
    • .
  • CLOUD_TSSD: ultra ssd.
    • .
  • Default value: CLOUD_PREMIUM.
    		•
    DiskSize Integer No System disk size, in GB. Default value: 50.

    Tag

    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.

    TargetAttribute

    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.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback