International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2021-04-08 11:43:13

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

    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
    		•

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

    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.

    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 CVM Instance Configuration. Value range:
  • LOCAL_BASIC: Local disk
  • LOCAL_SSD: Local SSD disk
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: Premium cloud disk
  • CLOUD_SSD: SSD cloud disk

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