Tenant Cloud Compute Auto Scaling Data structure

Data structure

Last Updated At: 2026-08-02 00:05:30

RunSecurityServiceEnabled

The information about the Cloud Security service.

Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

name required NULL allowed type description
Enabled no yes Bool Whether to enable the Cloud Security service. Value range:
  • TRUE: Indicates that the Cloud Security service is enabled
  • FALSE: Indicates that the Cloud Security service is not enabled

    Default value: TRUE.
    Example: true
    		•

    Activity

    Information on eligible scaling activities.

    Referenced by the following interfaces: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities

    name required NULL allowed type description
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-aaaaqqqq
    ActivityId yes no String ID of the scaling activity.
    Example: asa-fznnvrja
    ActivityType yes no String Type of the scaling activity. Valid values:

  • SCALE_OUT: scale-out activity
  • SCALE_IN: scale-in activity
  • ATTACH_INSTANCES: adding instances
  • REMOVE_INSTANCES: terminating instances
  • DETACH_INSTANCES: removing instances
  • TERMINATE_INSTANCES_UNEXPECTEDLY: terminating instances in the CVM console
  • REPLACE_UNHEALTHY_INSTANCE: replace unhealthy instances
    Example: SCALE_OUT
    		•
    StatusCode yes no String Status of the scaling activity. Valid values:

  • INIT: the scaling activity is being initialized.
  • RUNNING: the scaling activity is running.
  • SUCCESSFUL: the scaling activity is successful.
  • PARTIALLY_SUCCESSFUL: the scaling activity is partially successful.
  • FAILED: the scaling activity has failed.
  • CANCELLED: the scaling activity is canceled.
    Example: SUCCESSFUL
    		•
    StatusMessage yes no String Description of the scaling activity status.
    Example: Success
    Cause yes no String Cause of the scaling activity.
    Example: Activity was launched in response to a difference between desired capacity and actual capacity.
    Description yes no String Description of the scaling activity.
    Example: alice use
    StartTime yes no Datetime_iso Start time of the scaling activity.
    Example: 2014-08-03T12:00:00+08:00
    EndTime yes yes Datetime_iso End time of the scaling activity.
    Example: 2014-08-03T12:00:00+08:00
    CreatedTime yes no Datetime_iso Time when the scaling activity was created.
    Example: 2014-08-03T12:00:00+08:00
    ActivityRelatedInstanceSet yes no Array of ActivtyRelatedInstance Instance information related to the scaling activity.
    Example:View
    StatusMessageSimplified yes no String Brief description of the scaling activity status.
    Example: Success
    LifecycleActionResultSet yes no Array of LifecycleActionResultInfo Execution result of the lifecycle hook in the scaling activity.
    Example:View

    LifecycleHook

    Lifecycle hook.

    Referenced by the following interfaces: DescribeLifecycleHooks

    name required NULL allowed type description
    LifecycleHookId yes no String Lifecycle hook ID.
    Example: ash-ck4bkcjt
    LifecycleHookName yes no String Name of the lifecycle hook.
    Example: demo
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-lk5nn4xi
    DefaultResult yes no String Default result of the lifecycle hook.
    Example: CONTINUE
    HeartbeatTimeout yes no Int64 Wait timeout period of the lifecycle hook.
    Example: 300
    LifecycleTransition yes no String Applicable scenario of the lifecycle hook.
    Example: INSTANCE_TERMINATING
    NotificationMetadata yes no String Additional information sent to the notification target.
    Example: ""
    CreatedTime yes no Datetime_iso Creation time.
    Example: 2021-05-31T12:38:35Z
    NotificationTarget yes no NotificationTarget Notification target
    Example:View
    LifecycleTransitionType yes no String Lifecycle Hook Scenario Type
    Example: NORMAL

    AutoScalingGroup

    Scaling group.

    Referenced by the following interfaces: DescribeAutoScalingGroups

    name required NULL allowed type description
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-30wif85u
    AutoScalingGroupName yes no String Scaling group name
    Example: alice use
    AutoScalingGroupStatus yes no String Current status of the scaling group. Valid values:
  • NORMAL: healthy.
  • CVM_ABNORMAL: the launch configuration is abnormal.
  • LB_ABNORMAL: the load balancers are abnormal.
  • VPC_ABNORMAL: an error occurs in the VPC.
  • INSUFFICIENT_BALANCE: the account balance is insufficient.

    Example: NORMAL
    		•
    CreatedTime yes no Datetime_iso Creation time in UTC format.
    Example: 2021-05-31T12:38:35Z
    DefaultCooldown yes no Int64 Default cooldown period. Unit: seconds.
    Example: 300
    DesiredCapacity yes no Int64 Desired Capacity
    Example: 0
    EnabledStatus yes no String Whether the scaling group is enabled. Valid values: ENABLED and DISABLED.
    Example: ENABLED
    ForwardLoadBalancerSet yes no Array of ForwardLoadBalancer List of application load balancers.
    Example:View
    InstanceCount yes no Int64 Number of instances.
    Example: 0
    InServiceInstanceCount yes no Int64 Number of instances that are in the IN_SERVICE state.
    Example: 0
    LaunchConfigurationId yes no String Launch Configuration ID
    Example: asc-966b7fk2
    LaunchConfigurationName yes no String Name of the launch configuration.
    Example: alice-lc
    LoadBalancerIdSet yes no Array of String IDs of classic load balancers.
    Example: []
    MaxSize yes no Int64 Max
    Example: 10
    MinSize yes no Int64 Min
    Example: 0
    ProjectId yes no Int64 Project ID.
    Example: 0
    SubnetIdSet yes no Array of String IDs of subnets.
    Example: ["subnet-rdm629r2"]
    TerminationPolicySet yes no Array of String Termination policy.
    Example: OLDEST_INSTANCE
    VpcId yes no String VPC ID.
    Example: vpc-h3cd5td5
    ZoneSet yes no Array of String List of AZ IDs.
    Example: []
    RetryPolicy yes no String Retry Policy
    Example: NO_RETRY
    InActivityStatus yes no String Whether the scaling group is performing a scaling activity. IN_ACTIVITY: yes; NOT_IN_ACTIVITY: no.
    Example: IN_ACTIVITY
    Tags yes no Array of Tag Tags attached to the scaling group.
    Example:View
    ServiceSettings yes no ServiceSettings Service settings
    Example:View
    Ipv6AddressCount yes no Int64 Number of IPv6 addresses assigned to the instance.
    Example: 0
    MultiZoneSubnetPolicy yes no String Policy applied when there are multiple availability zones/subnets.

  •  PRIORITY: when creating instances, the system chooses the availability zone/subnet based on the order in the list from top to bottom. If the first instance is successfully created in the availability zone/subnet of the highest priority, all instances will be created in this availability zone/subnet.

  •  EQUALITY: the system chooses the availability zone/subnet with the least instances for scale-out operations. This gives each availability zone/subnet an opportunity for scale-out and disperses the instances created during multiple scale-out operations across different availability zones/subnets.
    Example: PRIORITY
    		•

    Tag

    Resource type and tag key-value pair

    Referenced by the following interfaces: CreateAutoScalingGroup, DescribeAutoScalingGroups

    name required NULL allowed type description
    ResourceType no yes String Type of resource to which tags are bound. Valid value: auto-scaling-group.
    Example: instance
    Key yes no String Tag key.
    Example: key
    Value yes no String Tag value.
    Example: val
    TagKey no yes String Tag key.
    Example: key
    TagValue no yes String Tag value.
    Example: val

    LimitedLoginSettings

    This describes the configuration and information related to instance login. For security reasons, sensitive information is not described.

    Referenced by the following interfaces: DescribeLaunchConfigurations

    name required NULL allowed type description
    KeyIds yes no Array of String List of key IDs.
    Example: ["skey-k8eypc1"]

    SpotMarketOptions

    Bidding-related options.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    MaxPrice yes no String Bidding price, such as "1.05".
    Example: 0.99
    SpotInstanceType no yes String Bid request type. Currently, only the "one-time" type is supported. Default value: one-time.
    Example: one-time

    AutoScalingGroupAbstract

    Brief information of a scaling group.

    Referenced by the following interfaces: DescribeLaunchConfigurations

    name required NULL allowed type description
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-30wif85u
    AutoScalingGroupName yes no String Name of the scaling group.
    Example: alice-asg

    InstanceMarketOptionsRequest

    Options related to a CVM bidding request

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    MarketType no yes String Marketplace option type. Valid value: spot.
    Example: spot
    SpotOptions yes no SpotMarketOptions Bidding-related options.
    Example:View

    LifecycleActionResultInfo

    Result information of the lifecycle hook action

    Referenced by the following interfaces: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities

    name required NULL allowed type description
    LifecycleHookId yes no String ID of the lifecycle hook.
    Example: ash-61dyt49h
    InstanceId yes no String ID of the instance.
    Example: ins-61dyt49h
    NotificationResult yes no String Notification result, which indicates whether the notification is successfully sent to CMQ.
    Example: null
    LifecycleActionResult yes no String Execution result of the lifecycle hook action. Values: CONTINUE and ABANDON.
    Example: CONTINUE
    ResultReason yes no String Reason for the result.
    Example: HEARTBEAT_TIMEOUT

    EnhancedService

    This describes the conditions of enhancement services for the instance and their settings, such as the Agent of Cloud Security or Cloud Monitor.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    SecurityService no no RunSecurityServiceEnabled Enables the Cloud Security service. If you do not configure this parameter, the cloud security service is enabled by default.
    Example:View
    MonitorService no no RunMonitorServiceEnabled Enables the Cloud Monitor service. If this parameter is not specified, the system enables the Cloud Monitor service by default.
    Example:View
    AutomationService no no RunAutomationServiceEnabled Enables Automation Service. If the parameter is not specified, the default logic remains consistent with that of CVMs. Note: This field may return null, indicating that no valid values can be obtained.
    Example:View

    ForwardLoadBalancer

    Application load balancer

    Referenced by the following interfaces: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancers

    name required NULL allowed type description
    LoadBalancerId yes no String Load balancer ID.
    Example: lb-crhgatrf
    ListenerId yes no String Application load balancer listener ID.
    Example: lb-61dyt49h
    LocationId no no String ID of the forwarding rule. This parameter is required for Layer-7 listeners.
    Example: loc-61dyt49h
    TargetAttributes yes no Array of TargetAttribute List of target rule attributes.
    Example:View
    Region no no String Region of the CLB instance. The AS service region is used by default. The format is the same as that of the common parameter Region. For example: "ap-region".
    Example: ap-region

    InstanceNameSettings

    Settings of CVM instance names.

    Referenced by the following interfaces: DescribeLaunchConfigurations

    name required NULL allowed type description
    InstanceName yes no String Name of the CVM instance.

    The name cannot start or end with a period (.) or a hyphen (-), and cannot contain consecutive periods or hyphens.

    Other types of instances (such as Linux-based instances): the name must be 2 to 40 characters in length and can contain multiple period-separated segments. Each segment can contain letters, digits, and hyphens (-).
    This parameter may return null, indicating that no valid values can be obtained.
    Example: alice-1
    InstanceNameStyle no no String Style of the CVM instance name. Valid values: ORIGINAL and UNIQUE. Default value: ORIGINAL.

    ORIGINAL: Auto Scaling sends the specified input parameter InstanceName to CVM directly. CVM may append a serial number to the value of the InstanceName parameter. The names of the CVM instances within the scaling group may conflict.

    UNIQUE: the value of the input parameter InstanceName is used as the prefix of an instance name. Auto Scaling and CVM expand the specified prefix, which can ensure that the name of each CVM instance in the scaling group is unique.
    This parameter may return null, indicating that no valid values can be obtained.
    Example: ORIGINAL

    ScheduledAction

    This describes the information of a scheduled task.

    Referenced by the following interfaces: DescribeScheduledActions

    name required NULL allowed type description
    ScheduledActionId yes no String ID of the scheduled task.
    Example: asst-jf898dps
    ScheduledActionName yes no String Name of the scheduled task.
    Example: RunInstances
    AutoScalingGroupId yes no String ID of the scaling group to which the scheduled task belongs.
    Example: asg-keqt9eg1
    StartTime yes no Datetime_iso Scheduled task start time, which is region time (UTC+8). The value follows the ISO 8601 standard. Format: YYYY-MM-DDThh:MM:ss+08:00.
    Example: 2022-02-22T16:00:00+08:00
    Recurrence yes no String Repeating mode of the scheduled task,
    Example: 0 23 /1  *
    EndTime yes no Datetime_iso Scheduled task end time, which is region time (UTC+8). The value follows the ISO 8601 standard. Format: YYYY-MM-DDThh:MM:ss+08:00.
    Example: 2023-02-23T16:00:00+08:00
    MaxSize yes no Uint64 Maximum number of instances set in the scheduled task.
    Example: 20
    DesiredCapacity yes no Uint64 Desired number of instances set in the scheduled task.
    Example: 5
    MinSize yes no Uint64 Minimum number of instances set in the scheduled task.
    Example: 1
    CreatedTime yes no Datetime_iso Time when the scheduled task was created. Set the value to a UTC time in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard.
    Example: 2022-02-21T02:19:52Z

    HostNameSettings

    CVM HostName settings

    Referenced by the following interfaces: DescribeLaunchConfigurations

    name required NULL allowed type description
    HostName yes yes String Hostname of the CVM.

  •  The name cannot start or end with a period (.) or a hyphen (-), and cannot contain consecutive periods or hyphens.

  •  This parameter is unavailable for Windows-based CVM instances.

  •  Other types of instances (such as Linux-based instances): the name must be 2 to 40 characters in length and can contain multiple period-separated segments. Each segment can contain letters, digits, and hyphens (-).
    Example: aaa
    		•
    HostNameStyle no yes String Style of the CVM hostname. Valid values: ORIGINAL and UNIQUE. Default value: ORIGINAL.

  •  ORIGINAL: Auto Scaling directly transfers the value of the HostName parameter to CVM. CVM may add a serial number to the specified hostname. The hostnames of instances within the scaling group may conflict.

  •  UNIQUE. The value of the HostName parameter is used as the prefix of a hostname. Auto Scaling and CVM expand the hostname, which can ensure that the hostname of each instance in the scaling group is unique.
    Example: ORIGINAL
    		•

    AutoScalingNotification

    AS event notification

    Referenced by the following interfaces: DescribeNotificationConfigurations

    name required NULL allowed type description
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-19kw47wk
    NotificationUserGroupIds yes no Array of String IDs of user groups.
    Example: ["12529"]
    NotificationTypes yes no Array of String List of notification events.
    Example: ["SCALE_OUT_SUCCESSFUL"]
    AutoScalingNotificationId yes no String ID of the event notification.
    Example: asn-6r4waxc4

    DataDisk

    Configuration information of data disks in a 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.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    DiskType no yes String Data disk type. Value range: 
  • LOCAL_BASIC: local disk; 
  • LOCAL_SSD: local SSD disk; 
  • CLOUD_BASIC: general-purpose cloud disk
  • CLOUD_PREMIUM: high-performance cloud disk
  • CLOUD_SSD: SSD cloud disk

    Default value: LOCAL_BASIC.
    Example: CLOUD_PREMIUM
    		•
    DiskSize no yes Uint64 Data disk size, unit: GB. Minimum adjustment step is 10 GB, and different data disk types have different value ranges. Default value is 0, indicating no purchase of data disk. For more restrictions, see the product document.
    Example: 0
    SnapshotId no yes String Data disk snapshot ID, such as snap-l8psqwnt.
    Example: snap-l8psqwnt

    RunAutomationServiceEnabled

    Describes the relevant information about Automation Service.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    Enabled no yes Bool Whether to enable Automation Service. Valid values: 
  • TRUE: indicates enabling Automation Service. 
  • FALSE: indicates disabling Automation Service.
    Example: True
    		•

    SystemDisk

    System disk configuration in a launch configuration. If this parameter is not specified, the default value is assigned to it.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    DiskType yes yes String System disk type. Value range:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: general-purpose cloud disk
  • CLOUD_PREMIUM: high-performance cloud disk
  • CLOUD_SSD: SSD cloud disk

    Default value: LOCAL_BASIC.
    Example: CLOUD_PREMIUM
    		•
    DiskSize no yes Uint64 The system disk size. Unit: GB. The default value is 50.
    Example: 50

    Filter

    Key-value pair filter, which is used for conditional filtering. For example, ID, name, and status.
    *If there are multiple filters, the relationship between filters is logical AND.

    • If a filter involves multiple values, the relationship between values of this filter is logical OR.

    Take the filter of the [DescribeInstances](/tcloud/api/Compute/CVM/APIs/CVM/Version (2017-03-12)/instance APIs/RunInstances) API as an example. To query instances whose AZ (zone) is zone 1 and the billing mode (instance-charge-type) is monthly subscription or pay-as-you-go, the filters can be as follows:

    Filters.0.Name=zone
&Filters.0.Values.1=ap-region-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.1=PREPAID
&Filters.1.Values.2=POSTPAID_BY_HOUR

    Referenced by the following interfaces: DescribeAutoScalingActivities, DescribeAutoScalingGroups, DescribeAutoScalingInstances, DescribeLaunchConfigurations, DescribeLifecycleHooks, DescribeNotificationConfigurations, DescribeScalingPolicies, DescribeScheduledActions

    name required NULL allowed type description
    Name yes no String Field that you want to filter.
    Example: key
    Values yes no Array of String Field value that you want to filter.
    Example: value

    RunMonitorServiceEnabled

    This describes the information related to the Cloud Monitor service.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    Enabled no yes Bool Whether to enable the Cloud Monitor service. Value range:
  • TRUE: Indicates that the Cloud Monitor service is enabled
  • FALSE: Indicates that the Cloud Monitor service is not enabled

    Default value: TRUE.
    Example: true
    		•

    MetricAlarm

    Alarming metric of AS

    Referenced by the following interfaces: CreateScalingPolicy, DescribeScalingPolicies, ModifyScalingPolicy

    name required NULL allowed type description
    ComparisonOperator yes no String Comparison operator. Valid values:
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL_TO
  • LESS_THAN
  •  LESS_THAN_OR_EQUAL_TO
  •  EQUAL_TO
    •  
  • NOT_EQUAL_TO

    • Example: GREATER_THAN
    MetricName yes no String Metric name. Valid values:
  • CPU_UTILIZATION: CPU utilization
  • MEM_UTILIZATION: memory utilization
  • LAN_TRAFFIC_OUT: outbound bandwidth of the private network
  • LAN_TRAFFIC_IN: inbound bandwidth of the private network
  • WAN_TRAFFIC_OUT: outbound bandwidth of the public network
  • WAN_TRAFFIC_IN: inbound bandwidth of the public network

    • Example: CPU_UTILIZATION
    Statistic no no String Statistics type. Valid values:
  • AVERAGE: average value
  • MAXIMUM: maximum value
  • MINIMUM: minimum value

    •  Default value: AVERAGE.
    Example: AVERAGE
    Threshold yes no Uint64 Alarming threshold. Valid values vary based on the metric name.
  • CPU_UTILIZATION: [1, 100]. Unit: %.
  • MEM_UTILIZATION: [1, 100]. Unit: %.
  • LAN_TRAFFIC_OUT: > 0. Unit: Mbit/s. 
  • LAN_TRAFFIC_IN: > 0. Unit: Mbit/s.
  • WAN_TRAFFIC_OUT: > 0. Unit: Mbit/s.
  • WAN_TRAFFIC_IN: > 0. Unit: Mbit/s.

    • Example: 10
    Period yes no Uint64 Time period in seconds. Enumerated values: 60 and 300.
    Example: 60
    ContinuousTime yes no Uint64 Number of recurrences. Valid values: 1 to 10.
    Example: 3

    ServiceSettings

    Service settings

    Referenced by the following interfaces: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyAutoScalingGroup

    name required NULL allowed type description
    ReplaceMonitorUnhealthy no no Bool Whether to enable unhealthy instance replacement. If this feature is enabled, Auto Scaling will replace instances that are flagged as unhealthy by Cloud Monitor. Default value: false.
    Example: False
    ScalingMode no no String 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 started instances is still insufficient, the system creates instances to perform scale-out operations. For scale-in operations, instances are terminated in the same manner 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 instances.
    Default value: CLASSIC_SCALING.
    Example: CLASSIC_SCALING

    TargetAttribute

    Load balancer target attribute

    Referenced by the following interfaces: CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancers

    name required NULL allowed type description
    Port yes no Uint64 Port.
    Example: 8080
    Weight yes no Uint64 Weight
    Example: 5

    LoginSettings

    Describes login settings of an instance.

    Referenced by the following interfaces: CreateLaunchConfiguration, UpgradeLaunchConfiguration

    name required NULL allowed type description
    Password no yes String Password that is used to log in to the instance. The limit on password complexity varies based on the OS type. The following requirements are provided:
  • The password for a Linux instance must be 8 to 16 characters in length and contain at least two of the following types: uppercase letters, lowercase letters, digits, and special characters ()`~!@#$%^&*-+=
    		•
    KeyIds no no Array of String List of key IDs. After you associate keys, private keys can be used to access the corresponding instances. You can call the DescribeKeyPairs operation to obtain your key ID. Keys and passwords cannot be specified at a time. Keys cannot be specified for Windows OS. You can specify only one key when you purchase an instance.
    Example: ["skey-k8eypc1"]
    KeepImageLogin no yes Bool Specifies whether to maintain the original login configuration of the image. This parameter cannot be used together with Password or KeyIds.N. You can set this parameter to TRUE only if you use a custom image, a shared image, or an imported external image to create an instance. Valid values:
  • TRUE: maintains the original login configuration of the image.
  • FALSE: does not maintain the original login configuration of the image.

    Default value: FALSE.
    Example: true
    		•

    InstanceTag

    Tags attached to the instance. You can use this parameter to bind tags to newly added instances.

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    Key yes no String Tag key.
    Example: TYPE
    Value yes no String Tag value.
    Example: region

    ScalingPolicy

    Alarm trigger policy.

    Referenced by the following interfaces: DescribeScalingPolicies

    name required NULL allowed type description
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-1tgr5cf8
    AutoScalingPolicyId yes no String ID of the alarm trigger policy.
    Example: asg-1tgr5cf8
    ScalingPolicyName yes no String Name of the alarm trigger policy.
    Example: alice-asp
    AdjustmentType yes no String Method that you want to use to change the desired capacity after the alarm is triggered. 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.

    • Example: CHANGE_IN_CAPACITY
    AdjustmentValue yes no Int64 Adjusted desired capacity after the alarm is triggered.
    Example: 2
    Cooldown yes no Uint64 Cooldown period.
    Example: 60
    MetricAlarm yes no MetricAlarm Alarm metric.
    Example:View
    NotificationUserGroupIds yes no Array of String IDs of notification groups.
    Example: []

    LaunchConfiguration

    Information set of eligible launch configurations.

    Referenced by the following interfaces: DescribeLaunchConfigurations

    name required NULL allowed type description
    ProjectId yes no Int64 ID of the project to which the instance belongs.
    Example: 0
    LaunchConfigurationId yes no String ID of the launch configuration.
    Example: asc-61dyt49h
    LaunchConfigurationName yes no String Name of the launch configuration.
    Example: TestLauchConfig0_0
    InstanceType yes no String Instance type.
    Example: SA2.MEDIUM2
    SystemDisk yes no SystemDisk System disk configurations of the instance.
    Example:View
    DataDisks yes no Array of DataDisk Data disk configurations of the instance.
    Example:View
    LoginSettings yes no LimitedLoginSettings The instance login information.
    Example:View
    InternetAccessible yes no InternetAccessible Public network bandwidth settings.
    Example:View
    SecurityGroupIds yes no Array of String The security group to which the instance belongs.
    Example: ["sg-brwzhm6d"]
    AutoScalingGroupAbstractSet yes no Array of AutoScalingGroupAbstract Scaling group associated with the launch configuration.
    Example:View
    UserData yes yes String Custom data.
    Example: dGVzdA==
    CreatedTime yes no Datetime_iso Time when the launch configuration was created.
    Example: 2021-05-31T12:38:35Z
    EnhancedService yes no EnhancedService Status of the enhanced services on the instance and their settings.
    Example:View
    ImageId yes no String Image ID.
    Example: img-61dyt49h
    LaunchConfigurationStatus yes no String Current status of the launch configuration. Valid values:
  • NORMAL: healthy.
  • IMAGE_ABNORMAL: an exception has occurred to the image setting in the launch configuration.
  • CBS_SNAP_ABNORMAL: an exception has occurred to the data disk snapshot setting in the launch configuration.
  • SECURITY_GROUP_ABNORMAL: an exception has occurred to the security group setting in the launch configuration.

    Example: NORMAL
    		•
    InstanceChargeType yes no String Billing method of the instance. The default value for a CVM instance is POSTPAID_BY_HOUR.

  • POSTPAID_BY_HOUR: the pay-as-you-go billing method. You are charged on an hourly basis.

  • SPOTPAID: pay by bidding.
    Example: POSTPAID_BY_HOUR
    		•
    InstanceMarketOptions yes yes InstanceMarketOptionsRequest Marketplace-related options of the instance, such as spot instance related parameters. This parameter is required if the InstanceChargeType parameter is set to SPOTPAID.
    Example:View
    InstanceTypes yes no Array of String List of instance models.
    Example: ["SA2.MEDIUM2"]
    InstanceTags yes no Array of InstanceTag List of tags.
    Example:View
    VersionNumber yes no Int64 Version number.
    Example: 1
    UpdatedTime yes no Datetime_iso The point in time when the multicast group was last updated.
    Example: 2023-09-04T11:42:46Z
    CamRoleName yes no String Name of the CAM role. You can call the DescribeRoleList API and obtain the role name from the value of the roleName response parameter.
    Example: TestRole
    LastOperationInstanceTypesCheckPolicy yes no String Value of InstanceTypesCheckPolicy upon the last operation.
    Example: ANY
    HostNameSettings yes no HostNameSettings CVM hostname settings.
    Example:View
    InstanceNameSettings yes no InstanceNameSettings Settings of CVM instance names
    Example:View
    InstanceChargePrepaid yes no InstanceChargePrepaid Settings related to the prepaid billing method. You can use this parameter to configure attributes such as the subscription duration and whether to enable auto-renewal for subscription instances. This parameter is required for subscription instances.
    Example:View

    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

    Referenced by the following interfaces: CreateLaunchConfiguration, DescribeLaunchConfigurations, UpgradeLaunchConfiguration

    name required NULL allowed type description
    InternetChargeType no yes String The billing method of network resources. Valid values:
  • BANDWIDTH_PREPAID: prepaid based on the bandwidth.
  • TRAFFIC_POSTPAID_BY_HOUR: postpaid based on the traffic per hour.
  • BANDWIDTH_POSTPAID_BY_HOUR: postpaid based on the bandwidth per hour.
  • BANDWIDTH_PACKAGE: bandwidth resource plan.
    Default value: TRAFFIC_POSTPAID_BY_HOUR.
    Example: BANDWIDTH_POSTPAID_BY_HOUR
    		•
    InternetMaxBandwidthOut no yes Uint64 Public network egress bandwidth limit, unit: Mbps. Default value: 0 Mbps. The bandwidth cap varies by model.
    Example: 1
    PublicIpAssigned no yes Bool Specifies whether to assign the public IP address. Valid values:
  • TRUE: assigns the public IP address.
  • FALSE: does not assign the public IP address.

    If the value of InternetMaxBandwidthOut is greater than 0, you can choose whether to assign the public IP address based on your business requirements. The system assigns the public IP address by default. If the value of InternetMaxBandwidthOut is 0, you cannot assign the public network bandwidth.
    Example: true
    		•

    ActivtyRelatedInstance

    Information of the instances related to the current scaling activity.

    Referenced by the following interfaces: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities

    name required NULL allowed type description
    InstanceId yes no String Instance ID.
    Example: ins-61dyt49h
    InstanceStatus yes no String Status of the instance in the scaling activity. Valid values:
  • INIT: the scaling activity is being initialized.
  • RUNNING: the instance is running.
  • SUCCESSFUL: the scaling activity is successful.
  • FAILED: the scaling activity has failed.
    Example: SUCCESSFUL
    		•

    Instance

    Instance information.

    Referenced by the following interfaces: DescribeAutoScalingInstances

    name required NULL allowed type description
    InstanceId yes no String Instance ID.
    Example: ins-089dlszs
    AutoScalingGroupId yes no String ID of the scaling group.
    Example: asg-02ofd40a
    LaunchConfigurationId yes no String Launch Configuration ID
    Example: asc-23yf98ie
    LaunchConfigurationName yes no String Name of the launch configuration.
    Example: Test asc-01_2.3
    LifeCycleState yes no String Lifecycle status. Valid values: IN_SERVICE, CREATING, TERMINATING, ATTACHING, DETACHING, ATTACHING_LB, and DETACHING_LB.
    Example: IN_SERVICE
    HealthStatus yes no String Health status. Valid values: HEALTHY and UNHEALTHY.
    Example: HEALTHY
    ProtectedFromScaleIn yes no Bool Whether to enable scale-in protection.
    Example: false
    Zone yes no String AZ.
    Example: ap-region-1
    CreationType yes no String Creation type. Valid values: AUTO_CREATION and MANUAL_ATTACHING.
    Example: AUTO_CREATION
    AddTime yes no Datetime_iso Time when the instance was added to the scaling group.
    Example: 2023-01-13T03:06:25Z
    InstanceType yes no String The instance type.
    Example: S3.MEDIUM2
    VersionNumber yes no Int64 The version number.
    Example: 1
    AutoScalingGroupName yes no String Scaling group name
    Example: Test asg-01_2.3

    NotificationTarget

    Notification target

    Referenced by the following interfaces: CreateLifecycleHook, DescribeLifecycleHooks, UpgradeLifecycleHook

    name required NULL allowed type description
    TargetType yes no String Target type. Valid values: CMQ_QUEUE and CMQ_TOPIC.

  • CMQ_QUEUE: TDMQ for CMQ - queue model.
    •  

  • CMQ_TOPIC: TDMQ for CMQ - topic model.

    • Example: TDMQ_CMQ_QUEUE
    QueueName no no String Queue name. This parameter is required if the TargetType parameter is set to CMQ_QUEUE.
    Example: alice-queue
    TopicName no no String Topic name. This parameter is required when the TargetType parameter is set to CMQ_TOPIC.
    Example: alice-topic
    EnvironmentId no yes String Environment ID.
    Example: 84763
    ClusterId no yes String Cluster ID
    Example: 29183

    InstanceChargePrepaid

    Describes the billing method of an instance.

    Referenced by the following interfaces: DescribeLaunchConfigurations

    name required NULL allowed type description
    Period yes no Int64 The validity period of the instance. Unit: month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.
    Example: 1
    RenewFlag no no String Auto-renewal flag. Valid values:
  • NOTIFY_AND_AUTO_RENEW: expiration notifications and auto-renewal enabled;
  • NOTIFY_AND_MANUAL_RENEW: expiration notifications enabled but auto-renewal disabled;
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: expiration notifications and auto-renewal disabled.

    Default value: NOTIFY_AND_MANUAL_RENEW. If the value of this parameter is set to NOTIFY_AND_AUTO_RENEW, the system will perform auto-renewal for the instance if the account balance is sufficient.
    Example: NOTIFY_AND_MANUAL_RENEW
    		•