PrevNext
search by keyword

Recent Pages

Documentation
Auto Scaling
    Documentation
    Download PDF

    Data Types

    Last updated: 2022-01-18 11:13:39
    Download PDF

    Activity

    Information on eligible scaling activities.

    Used by actions: DescribeAutoScalingActivities, DescribeAutoScalingGroupLastActivities.

    Name Type Description
    AutoScalingGroupId String Auto scaling group ID.
    ActivityId String Scaling activity ID.
    ActivityType String Type of the scaling activity. Valid values:

  • SCALE_OUT: scales out.
  • SCALE_IN: scales in.
  • ATTACH_INSTANCES: adds an instance.
  • REMOVE_INSTANCES: terminates an instance.
  • DETACH_INSTANCES: removes an instance.
  • TERMINATE_INSTANCES_UNEXPECTEDLY: terminates an instance in the CVM console.
  • REPLACE_UNHEALTHY_INSTANCE: replaces an unhealthy instance.
  • START_INSTANCES: starts an instance.
  • STOP_INSTANCES: stops an instance.
    		•
    StatusCode String Scaling activity status. Value range:

  • INIT: initializing
  • RUNNING: running
  • SUCCESSFUL: succeeded
  • PARTIALLY_SUCCESSFUL: partially succeeded
  • 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 scaling activity.
    EndTime Timestamp ISO8601 End time of the scaling activity.
    CreatedTime Timestamp ISO8601 Creation time of the scaling activity.
    ActivityRelatedInstanceSet Array of ActivtyRelatedInstance Information set of the instances related to the scaling activity.
    StatusMessageSimplified String Brief description of the scaling activity status.
    LifecycleActionResultSet Array of LifecycleActionResultInfo Result of the lifecycle hook action in the scaling activity
    DetailedStatusMessageSet Array of DetailedStatusMessage Detailed description of scaling activity status

    ActivtyRelatedInstance

    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. Value range:
  • INIT: initializing
  • RUNNING: running
  • SUCCESSFUL: succeeded
  • FAILED: failed
    		•

    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

    AutoScalingAdvice

    Suggestions for scaling group configurations.

    Used by actions: DescribeAutoScalingAdvices.

    Name Type Description
    AutoScalingGroupId String Scaling group ID
    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 auto scaling group. Value range:
  • NORMAL: normal
  • CVM_ABNORMAL: Exception with the launch configuration
  • LB_ABNORMAL: exception with the load balancer
  • VPC_ABNORMAL: exception with the VPC
  • INSUFFICIENT_BALANCE: insufficient balance
  • LB_BACKEND_REGION_NOT_MATCH: the backend region of the CLB instance is not the same as the one of AS service.
    		•
    CreatedTime Timestamp ISO8601 Creation time in UTC format
    DefaultCooldown Integer Default cooldown period in seconds
    DesiredCapacity Integer Desired number of instances
    EnabledStatus String Enabled status. Value range: ENABLED, DISABLED
    ForwardLoadBalancerSet Array of ForwardLoadBalancer List of application load balancers
    InstanceCount Integer Number of instances
    InServiceInstanceCount Integer Number of instances in IN_SERVICE status
    LaunchConfigurationId String Launch configuration ID
    LaunchConfigurationName String Launch configuration name
    LoadBalancerIdSet Array of String List of Classic load balancer IDs
    MaxSize Integer Maximum number of instances
    MinSize Integer Minimum number of instances
    ProjectId Integer Project ID
    SubnetIdSet Array of String List of subnet IDs
    TerminationPolicySet Array of String Termination policy
    VpcId String VPC ID
    ZoneSet Array of String List of availability zones
    RetryPolicy String Retry policy
    InActivityStatus String Whether the auto scaling group is performing a scaling activity. IN_ACTIVITY indicates yes, and NOT_IN_ACTIVITY indicates no.
    Tags Array of Tag List of auto scaling group tags
    ServiceSettings ServiceSettings Service settings
    Ipv6AddressCount Integer The number of IPv6 addresses that an instance has.
    MultiZoneSubnetPolicy String The policy applied when there are multiple availability zones/subnets

  • PRIORITY: when creating instances, choose 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: chooses the availability zone/subnet with the least instances for scale-out. 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.
    		•
    HealthCheckType String Health check type of instances in a scaling group.
  • CVM: confirm whether an instance is healthy based on the network status. If the pinged instance is unreachable, the instance will be considered unhealthy. For more information, see Instance Health Check
  • CLB: confirm whether an instance is healthy based on the CLB health check status. For more information, see Health Check Overview.
    		•
    LoadBalancerHealthCheckGracePeriod Integer Grace period of the CLB health check
    InstanceAllocationPolicy String Specifies how to assign instances. Valid values: LAUNCH_CONFIGURATION and SPOT_MIXED.

  • LAUNCH_CONFIGURATION: the launch configuration mode.

  • SPOT_MIXED: a mixed instance mode. Currently, this mode is supported only when the launch configuration takes the pay-as-you-go billing mode. With this mode, the scaling group can provision a combination of pay-as-you-go instances and spot instances to meet the configured capacity. Note that the billing mode of the associated launch configuration cannot be modified when this mode is used.
    		•
    SpotMixedAllocationPolicy SpotMixedAllocationPolicy Specifies how to assign pay-as-you-go instances and spot instances.
    A valid value will be returned only when InstanceAllocationPolicy is set to SPOT_MIXED.
    CapacityRebalance Boolean Indicates whether the capacity rebalancing feature is enabled. This parameter is only valid for spot instances in the scaling group. Valid values:

  • TRUE: yes. Before the spot instances in the scaling group are about to be automatically repossessed, AS will terminate them. The scale-in hook (if configured) will take effect before the termination. After the termination process starts, AS will asynchronously initiate a scaling activity to meet the desired capacity.

  • FALSE: no. AS will add instances to meet the desired capacity only after the spot instances are terminated.
    		•

    AutoScalingGroupAbstract

    Brief information of an auto scaling group.

    Used by actions: DescribeLaunchConfigurations.

    Name Type Description
    AutoScalingGroupId String Auto 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 List of notification events.
    AutoScalingNotificationId String Event notification ID.
    TargetType String Notification receiver type.
    QueueName String CMQ queue name.
    TopicName String 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 more information on limits of data disk types, see Cloud Disk Types. Valid values:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: premium cloud storage
  • CLOUD_SSD: SSD cloud disk

    The default value should be the same as the DiskType field under SystemDisk.
    Note: this field may return null, indicating that no valid value can be obtained.
    		•
    DiskSize Integer No Data disk size (in GB). The minimum adjustment increment is 10 GB. The value range varies by data disk type. For more information on limits, see CVM Instance Configuration. The default value is 0, indicating that no data disk is purchased. For more information, see the product documentation.
    Note: This field may return null, indicating that no valid values can be obtained.
    SnapshotId String No Data disk snapshot ID, such as snap-l8psqwnt.
    Note: This field may return null, indicating that no valid values can be obtained.

    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 of enhancement services for the instance and their settings, such as the Agent of Cloud Security or Cloud Monitor.

    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.

    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, 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 Load balancer ID
    ListenerId String Yes Application load balancer listener ID
    TargetAttributes Array of TargetAttribute Yes List of target rule attributes
    LocationId String No ID of a forwarding rule. This parameter is required for layer-7 listeners.
    Region String No The region of CLB instance. It defaults to the region of AS service and is in the format of the common parameter Region, such as ap-guangzhou.

    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 Hostname of a CVM

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

  • This field is unavailable to CVM instances.

  • Other types of instances (such as Linux): the name contains 2 to 40 characters, and supports multiple periods (.). The string between two periods can consist of letters (case insensitive), numbers, and hyphens (-), and cannot be all numbers.
    Note: this field may return null, indicating that no valid value is obtained.
    		•
    HostNameStyle String No Type of CVM host name. Valid values: "ORIGINAL" and "UNIQUE". Default value: "ORIGINAL"

  • ORIGINAL. Auto Scaling transfers the HostName set in input parameters to the CVM directly. CVM may adds serial numbers for the HostName. The HostName of instances within the auto scaling group may conflict.

  • UNIQUE. The HostName set in input parameters is the prefix of a host name. Auto Scaling and CVM expand it. The HostName of an instance in the auto scaling group is unique.
    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:

  • IN_SERVICE: the instance is running.
  • CREATING: the instance is being created.
  • CREATION_FAILED: the instance fails to be created.
  • TERMINATING: the instance is being terminated.
  • TERMINATION_FAILED: the instance fails to be terminated.
  • ATTACHING: the instance is being bound.
  • DETACHING: the instance is being unbound.
  • ATTACHING_LB: the instance is being bound to an LB.
  • DETACHING_LB: the instance is being unbound from an LB.
  • STARTING: the instance is being started.
  • START_FAILED: the instance fails to be started.
  • STOPPING: the instance is being stopped.
  • STOP_FAILED: the instance fails to be stopped.
  • STOPPED: the instance is stopped.
    		•
    HealthStatus String Health status. Value range: HEALTHY, UNHEALTHY
    ProtectedFromScaleIn Boolean Whether to add scale-in protection
    Zone String Availability zone
    CreationType String Creation type. Value range: AUTO_CREATION, MANUAL_ATTACHING.
    AddTime Timestamp ISO8601 Instance addition time
    InstanceType String Instance type
    VersionNumber Integer Version number
    AutoScalingGroupName String Auto scaling group name

    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. Value range:
  • NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically
  • NOTIFY_AND_MANUAL_RENEW: Notify expiry but not renew automatically
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically

    Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient.
    		•

    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. Currently, this only supports the value "spot"
    Note: This field may return null, indicating that no valid values can be obtained.

    InstanceNameSettings

    Settings of CVM instance names.

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

    Name Type Required Description
    InstanceName String Yes CVM instance name

    The InstanceName cannot start or end with a dot (.) or hyphen (-), and cannot contain consecutive dots and hyphens.
    The name contains 2 to 40 characters, and supports multiple dots (.). The string between two dots can consist of letters (case-insensitive), numbers, and hyphens (-), and cannot be all numbers.
    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.

    InstanceTag

    Instance tag. This parameter is used to bind tags to newly added instances.

    Used by actions: CreateLaunchConfiguration, DescribeLaunchConfigurations, 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 method. Value range:
  • BANDWIDTH_PREPAID: Prepaid by bandwidth
  • TRAFFIC_POSTPAID_BY_HOUR: Postpaid by traffic on a per hour basis
  • BANDWIDTH_POSTPAID_BY_HOUR: Postpaid by bandwidth on a per hour basis
  • BANDWIDTH_PACKAGE: BWP user
    Default value: TRAFFIC_POSTPAID_BY_HOUR.
    Note: This field may return null, indicating that no valid values can be obtained.
    		•
    InternetMaxBandwidthOut Integer No The maximum outbound bandwidth in Mbps of the public network. The default value is 0 Mbps. The upper limit of bandwidth varies by model. For more information, see Purchase Network Bandwidth.
    Note: This field may return null, indicating that no valid values can be obtained.
    PublicIpAssigned Boolean No Whether to assign a public IP. Value range:
  • TRUE: Assign a public IP
  • FALSE: Do not assign a public IP

    If the public network bandwidth is greater than 0 Mbps, you are free to choose whether to enable the public IP (which is enabled by default). If the public network bandwidth is 0 Mbps, no public IP will be allowed to be assigned.
    Note: This field may return null, indicating that no valid values can be obtained.
    		•
    BandwidthPackageId String No Bandwidth package ID. You can obtain the ID from the BandwidthPackageId field in the response of the DescribeBandwidthPackages API.
    Note: this field may return null, indicating that no valid value was found.

    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 Creation time of the launch configuration.
    EnhancedService EnhancedService Conditions of enhancement services for the instance and their settings.
    ImageId String Image ID.
    LaunchConfigurationStatus String Current status of the launch configuration. Value range:
  • NORMAL: normal
  • IMAGE_ABNORMAL: Exception with the image of the launch configuration
  • CBS_SNAP_ABNORMAL: Exception with the data disk snapshot of the launch configuration
  • SECURITY_GROUP_ABNORMAL: Exception with the security group of the launch configuration
    		•
    InstanceChargeType String Instance billing type. CVM instances are POSTPAID_BY_HOUR by default.

  • POSTPAID_BY_HOUR: Pay-as-you-go on an hourly basis

  • SPOTPAID: Bidding
    		•
    InstanceMarketOptions InstanceMarketOptionsRequest Market-related options of the instance, such as the parameters related to stop instances. If the billing method of instance is specified as bidding, this parameter must be passed in.
    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 tags.
    VersionNumber Integer Version number.
    UpdatedTime Timestamp ISO8601 Update time.
    CamRoleName String CAM role name, which can be obtained from the roleName field in the return value of the DescribeRoleList API.
    LastOperationInstanceTypesCheckPolicy String Value of InstanceTypesCheckPolicy upon the last operation.
    HostNameSettings HostNameSettings CVM HostName settings.
    InstanceNameSettings InstanceNameSettings Settings of CVM instance names.
    InstanceChargePrepaid InstanceChargePrepaid Sets prepaid billing mode, also known as monthly subscription. This parameter can specify the purchase period and other attributes such as auto-renewal. This parameter is mandatory for prepaid instances.
    DiskTypePolicy String Specifies how to select the cloud disk type.

  • ORIGINAL: uses the configured cloud disk type

  • AUTOMATIC: automatically chooses an available cloud disk type in the current availability zone
    		•

    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
    NotificationResult String Whether the notification is sent to CMQ successfully
    LifecycleActionResult String Result of the lifecyle hook action. Values: CONTINUE, ABANDON
    ResultReason String Cause of the result

    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 Default result of the lifecycle hook
    HeartbeatTimeout Integer Wait timeout period of the lifecycle hook
    LifecycleTransition String Applicable scenario of the lifecycle hook
    NotificationMetadata String Additional information for the notification target
    CreatedTime Timestamp ISO8601 Creation time
    NotificationTarget NotificationTarget Notification target
    LifecycleTransitionType String Applicable scenario of the lifecycle hook

    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

    This describes the configuration and information related to instance login.

    Used by actions: CreateLaunchConfiguration, UpgradeLaunchConfiguration.

    Name Type Required Description
    Password String No Login password of the instance. The rule of password complexity varies by operating system:
  • For Linux instances, the password must be a combination of 8-16 characters comprised of at least two of the following types: [a-z, A-Z], [0-9] and [( ) ~ ! @ # $ % ^ & * - + = &#124; { } [ ] : ; ' , . ? / ]. <br><li>For Windows instances, the password must be a combination of 12-16 characters comprised of at least three of the following types: [a-z], [A-Z], [0-9] and [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /].

    If this parameter is not specified, a password will be randomly generated and sent to you via internal message.
    Note: This field may return null, indicating that no valid values can be obtained.
    		•
    KeyIds Array of String No List of key IDs. An instance associated with the key can be accessed using the corresponding private key. KeyId can be obtained via the API DescribeKeyPairs. A key and a password cannot be specified at the same time, and specifying the key is not supported in Windows. You can specify only one key when purchasing an instance.
    KeepImageLogin Boolean No Keep the original settings for an image. You cannot specify this parameter if Password or KeyIds.N is specified. You can specify this parameter to TRUE only when you create an instance using a custom image, shared image, or image imported from external resources. Value range:
  • TRUE: Keep the login settings for the image
  • FALSE: Do not keep the login settings for the image

    Default value: FALSE.
    Note: This field may return null, indicating that no valid values can be obtained.
    		•

    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 name. Value range:
  • 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
    • Threshold Integer Yes Alarming threshold:
  • CPU_UTILIZATION: [1, 100] in %
  • MEM_UTILIZATION: [1, 100] in %
  • LAN_TRAFFIC_OUT: >0 in Mbps
  • LAN_TRAFFIC_IN: >0 in Mbps
  • WAN_TRAFFIC_OUT: >0 in Mbps
  • WAN_TRAFFIC_IN: >0 in Mbps
    • 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

    NotificationTarget

    Notification target

    Used by actions: CreateLifecycleHook, DescribeLifecycleHooks, UpgradeLifecycleHook.

    Name Type Required Description
    TargetType String Yes Target type. Valid values: CMQ_QUEUE, CMQ_TOPIC, TDMQ_CMQ_QUEUE and TDMQ_CMQ_TOPIC.
  • CMQ_QUEUE: Tencent Cloud message queue - queue model.
  • CMQ_TOPIC: Tencent Cloud message queue - topic model.
  • TDMQ_CMQ_QUEUE: Tencent Cloud TDMQ message queue - queue model.
  • TDMQ_CMQ_TOPIC: 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.

    RunMonitorServiceEnabled

    This describes the information related to the Cloud Monitor service.

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

    Name Type Required Description
    Enabled Boolean No Whether to enable the Cloud Monitor service. Value range:
  • TRUE: Cloud Monitor is enabled
  • FALSE: Cloud Monitor is disabled

    Default value: TRUE. |
    Note: This field may return null, indicating that no valid values can be obtained.
    		•

    RunSecurityServiceEnabled

    This describes the information on the Cloud Security service

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

    Name Type Required Description
    Enabled Boolean No Whether to enable the Cloud Security service. Value range:
  • TRUE: Cloud Security is enabled
  • FALSE: Cloud Security is disabled

    Default value: TRUE.
    Note: This field may return null, indicating that no valid values can be obtained.
    		•

    ScalingPolicy

    Alarm trigger policy.

    Used by actions: DescribeScalingPolicies.

    Name Type Description
    AutoScalingGroupId String Auto scaling group ID.
    AutoScalingPolicyId String Alarm trigger policy ID.
    ScalingPolicyName String Alarm trigger policy name.
    AdjustmentType String The method to adjust the desired number of instances after the alarm is triggered. Value range:
  • CHANGE_IN_CAPACITY: Increase or decrease the desired number of instances
  • EXACT_CAPACITY: Adjust to the specified desired number of instances
  • PERCENT_CHANGE_IN_CAPACITY: Adjust the desired number of instances by percentage
    • AdjustmentValue Integer The adjusted value of desired number of instances after the alarm is triggered.
    Cooldown Integer Cooldown period.
    MetricAlarm MetricAlarm Alarm monitoring metric.
    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 Repeating mode of the scheduled task.
    EndTime Timestamp ISO8601 End time of the scheduled task. The value is in Beijing time (UTC+8) in the format of YYYY-MM-DDThh:mm:ss+08:00 according to the ISO8601 standard.
    MaxSize Integer Maximum number of instances set by the scheduled task.
    DesiredCapacity Integer Desired number of instances set by the scheduled task.
    MinSize Integer Minimum number of instances set by the scheduled task.
    CreatedTime Timestamp ISO8601 Creation time of the scheduled task. The value is in UTC time in the format of YYYY-MM-DDThh:mm:ssZ according to the ISO8601 standard.

    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.

    SpotMarketOptions

    Bidding-related options

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

    Name Type Required Description
    MaxPrice String Yes Bidding price such as "1.05"
    SpotInstanceType String No Bid request type. Currently, only "one-time" type is supported. Default value: one-time
    Note: This field may return null, indicating that no valid values can be obtained.

    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 more information on limits of system disk types, see Cloud Disk Types. Valid values:
  • LOCAL_BASIC: local disk
  • LOCAL_SSD: local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: premium cloud storage
  • CLOUD_SSD: SSD cloud disk

    Default value: CLOUD_PREMIUM.
    Note: this field may return null, indicating that no valid value can be obtained.
    		•
    DiskSize Integer No System disk size in GB. Default value: 50
    Note: This field may return null, indicating that no valid values can be obtained.

    Tag

    Resource type and tag key-value pair

    Used by actions: CreateAutoScalingGroup, DescribeAutoScalingGroups.

    Name Type Required Description
    Key String Yes Tag key
    Value String Yes Tag value
    ResourceType String No Type of the resource binded to the tag. Currently supported types include "auto-scaling-group"
    Note: This field may return null, indicating that no valid values can be obtained.

    TargetAttribute

    Load balancer target attribute

    Used by actions: AttachLoadBalancers, CreateAutoScalingGroup, DescribeAutoScalingGroups, ModifyLoadBalancerTargetAttributes, ModifyLoadBalancers.

    Name Type Required Description
    Port Integer Yes Port
    Weight Integer Yes Weight
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy