All Products
Search
Document Center

Auto Scaling:DescribeScalingGroupDetail

更新時間:Nov 11, 2024

Queries a scaling group. You can call the DescribeScalingGroupDetail operation to query the basic information, instances, and scaling configurations of a scaling group. If you set OutputFormat to YAML for a scaling group of the Elastic Container Instance type, the output is a Kubernetes Deployment file in the YAML format.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ess:DescribeScalingGroupDetailget
  • ScalingGroup
    acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the scaling group. For more information, see Regions and zones.

cn-hangzhou
ScalingGroupIdstringYes

The ID of the scaling group.

asg-bp18p2yfxow2dloq****
OutputFormatstringNo

The output format. Set the value to yaml.

yaml

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ScalingGroupobject

The scaling group.

VpcIdstring

The virtual private cloud (VPC) ID of the scaling group.

vpc-wz9fcq97y1vqkd8bijcq6
CreationTimestring

The time when the scaling group was created.

2014-08-14T10:58Z
TotalInstanceCountinteger

The total number of Elastic Compute Service (ECS) instances in the scaling group.

1
ScalingGroupNamestring

The name of the scaling group. The name of each scaling group must be unique in a region.

The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (_), hyphens (-), and periods (.). It must start with a letter or digit.

dyrSuvBOtO1dEdIlIbp****
SpotInstancePoolsinteger

The number of instance types that are specified. Preemptible instances of multiple lowest-priced instance types are evenly distributed across the zones of the scaling group. Valid values: 0 to 10.

5
StoppedCapacityinteger

The number of instances that are stopped in Economical Mode in the scaling group.

1
OnDemandPercentageAboveBaseCapacityinteger

The percentage of pay-as-you-go instances among the excess instances when the minimum number of pay-as-you-go instances reaches the requirement. Valid values: 0 to 100.

20
ModificationTimestring

The time when the scaling group was modified.

2014-08-14T10:58Z
MinSizeinteger

The minimum number of ECS instances that must be contained in the scaling group.

1
ScalingGroupIdstring

The ID of the scaling group.

asg-bp14wlu85wrpchm0****
CompensateWithOnDemandboolean

Indicates whether pay-as-you-go ECS instances can be automatically created to reach the required number of ECS instances when preemptible ECS instances cannot be created due to high prices or insufficient inventory of resources. This parameter takes effect when you set MultiAZPolicy to COST_OPTIMIZED. Valid values:

  • true
  • false
true
ScalingPolicystring

The reclaim mode of the scaling group. Valid values:

  • recycle: economical mode
  • release: release mode
  • forcerelease: forced release mode
  • forcerecycle: forced recycle mode

For more information, see RemoveInstances .

recycle
RemovingWaitCapacityinteger

The number of ECS instances that are in the Pending Remove state in the scaling group.

1
ActiveCapacityinteger

The number of ECS instances that are in the In Service state in the scaling group.

1
OnDemandBaseCapacityinteger

The minimum number of pay-as-you-go instances that must be contained in the scaling group. Valid values: 0 to 1000. If the number of pay-as-you-go instances in the scaling group is less than the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances.

30
ProtectedCapacityinteger

The number of ECS instances that are in the Protected state in the scaling group.

1
HealthCheckTypestring

The health check mode of the scaling group. Valid values:

  • NONE: Auto Scaling does not perform health checks.
  • ECS: Auto Scaling checks the health status of instances in the scaling group. If you want to enable instance health check, you can set the value to ECS, regardless of whether the scaling group is of ECS type or Elastic Container Instance type.
  • LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group based on the health check results of load balancers. The health check results of Classic Load Balancer (CLB) instances are not supported as the health check basis for instances in the scaling group.
ECS
LifecycleStatestring

The status of the scaling group. Valid values:

  • Active: The scaling group is in the Enabled state. Enabled scaling groups can receive requests to execute scaling rules and trigger scaling activities.
  • Inactive: The scaling group is in the Disabled state. Disabled scaling groups cannot receive requests to execute scaling rules.
  • Deleting: The scaling group is being deleted. Scaling groups that are being deleted cannot receive requests to execute scaling rules, and the parameter settings of the scaling groups cannot be modified.
Active
GroupDeletionProtectionboolean

Indicates whether Deletion Protection is enabled for the scaling group. Valid values:

  • true: Deletion Protection is enabled for the scaling group. This way, the scaling group cannot be deleted.
  • false: Deletion Protection is disabled for the scaling group.
true
ActiveScalingConfigurationIdstring

The ID of the active scaling configuration in the scaling group.

asc-bp1et2qekq3ojr33****
GroupTypestring

The type of the instances that are managed by the scaling group. Valid values:

  • ECS: ECS instances
  • ECI: elastic container instances
ECS
MultiAZPolicystring

The scaling policy of the ECS instances in the multi-zone scaling group. Valid values:

  • PRIORITY: ECS instances are created based on the value of VSwitchIds. If Auto Scaling cannot create ECS instances in the zone where the vSwitch of the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch of the next highest priority resides.

  • COST_OPTIMIZED: ECS instances are created based on the unit prices of their vCPUs. Auto Scaling preferentially creates ECS instances that use the lowest-priced vCPUs. If preemptible instance types are specified in the scaling configuration, Auto Scaling preferentially creates preemptible instances. You can also specify CompensateWithOnDemand to allow Auto Scaling to create pay-as-you-go instances in the case that preemptible instances cannot be created due to insufficient inventory of preemptible instance types.

    **

    Note The COST_OPTIMIZED setting takes effect only if you specified multiple instance types or preemptible instance types in your scaling configuration.

  • BALANCE: ECS instances are evenly distributed across the zones of the scaling group. If ECS instance are unevenly distributed across the specified zones due to insufficient inventory of instance types, you can call the RebalanceInstance operation to rebalance the distribution of the ECS instances.

PRIORITY
RemovingCapacityinteger

The number of ECS instances that are being removed from the scaling group.

0
PendingWaitCapacityinteger

The number of ECS instances that are in the Pending Add state in the scaling group.

0
StandbyCapacityinteger

The number of ECS instances that are in the Standby state in the scaling group.

1
CurrentHostNamestring
Note This parameter is not available for use.
hostname
PendingCapacityinteger

The number of ECS instances that are being added to the scaling group and configured.

0
LaunchTemplateIdstring

The ID of the launch template that is used by the scaling group.

lt-m5e3ofjr1zn1aw7****
TotalCapacityinteger

The total weighted capacity of all ECS instances in the scaling group if Weighted is specified. In other cases, the value of this parameter indicates the total number of ECS instances in the scaling group.

1
DesiredCapacityinteger

The expected number of ECS instances in the scaling group. Auto Scaling automatically maintains the expected number of ECS instances.

5
SpotInstanceRemedyboolean

Indicates whether preemptible instances can be supplemented. If this parameter is set to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives the system message which indicates that the preemptible instance is to be reclaimed.

true
LaunchTemplateVersionstring

The version number of the launch template.

Default
RegionIdstring

The region ID of the scaling group.

cn-shenzhen
VSwitchIdstring

The vSwitch ID of the scaling group.

vsw-bp1whw2u46cn8zubm****
MaxSizeinteger

The maximum number of ECS instances that can be contained in the scaling group.

2
DefaultCooldowninteger

The cooldown period of the scaling group. Unit: seconds.

60
VServerGroupsarray<object>

The backend vServer groups.

VServerGroupobject
LoadBalancerIdstring

The ID of the Classic Load Balancer (CLB, formerly known as Server Load Balancer or SLB) instance to which the backend vServer group belongs.

147b46d767c-cn-qingdao-cm5****
VServerGroupAttributesarray<object>

The attributes of the backend vServer group.

VServerGroupAttributeobject
VServerGroupIdstring

The ID of the backend vServer group.

rsp-bp12bjrny****
Weightinteger

The weight of the backend vServer group.

1
Portinteger

The port number of a backend vServer.

80
LaunchTemplateOverridesarray<object>

The information about the instance types that are extended in the launch template.

LaunchTemplateOverrideobject
WeightedCapacityinteger

The weight of the instance type. The value of this parameter indicates the capacity of an instance of the specified instance type in the scaling group. A higher weight indicates that a smaller number of instances of the specified instance type are required to meet the expected capacity requirement.

4
InstanceTypestring

The instance type. The instance type that is specified by using this parameter overwrites the instance type of the launch template.

ecs.c5.xlarge
SpotPriceLimitfloat

The maximum bid price of the instance type that is specified by LaunchTemplateOverride.InstanceType.

Note This parameter takes effect only if you specify LaunchTemplateId.
0.025
AlbServerGroupsarray<object>

The information about the Application Load Balancer (ALB) server groups.

AlbServerGroupobject
AlbServerGroupIdstring

The ID of the Application Load Balancer (ALB) server group.

sgp-ddwb0y0g6y9bjm****
Weightinteger

The weight of an ECS instance as a backend server in the ALB server group.

100
Portinteger

The port number used by an ECS instance as a backend server in the ALB server group.

80
ServerGroupsarray<object>

The information about the server groups.

Note You can use this parameter to obtain information about ALB server groups and Network Load Balancer (NLB) server groups attached to your scaling group.
ServerGroupobject
ServerGroupIdstring

The ID of the server group.

sgp-i9ouakeaerr*****
Typestring

The type of the server group. Valid values:

  • ALB
  • NLB
ALB
Weightinteger

The weight of an ECS instance as a backend server in the server group.

100
Portinteger

The port number used by an ECS instance as a backend server in the server group.

80
RemovalPoliciesarray

The instance removal policies.

RemovalPolicystring

The instance removal policy. Valid values:

  • OldestInstance: Auto Scaling removes ECS instances that are added at the earliest point in time to the scaling group.
  • NewestInstance: Auto Scaling removes ECS instances that are most recently added to the scaling group.
  • OldestScalingConfiguration: Auto Scaling removes ECS instances that are created based on the earliest scaling configuration.
OldestScalingConfiguration
DBInstanceIdsarray

The IDs of the ApsaraDB RDS instances that are associated with the scaling group.

DBInstanceIdstring

The ID of the ApsaraDB RDS instance that is associated with the scaling group.

rm-bp15556qzebg1****
LoadBalancerIdsarray

The IDs of the SLB instances that are associated with the scaling group.

LoadBalancerIdstring

The ID of the SLB instance that is associated with the scaling group.

lb-bp19byhscefk3x0li****
VSwitchIdsarray

The IDs of the vSwitches that are associated with the scaling group. If you specify VSwitchIds, VSwitchId is ignored.

VSwitchIdstring

The ID of the vSwitch that is associated with the scaling group. If you specify VSwitchIds, VSwitchId is ignored.

vsw-bp1whw2u46cn8zubm****
SuspendedProcessesarray

The processes that are suspended. If no process is suspended, null is returned. Valid values:

  • ScaleIn: scale-in
  • ScaleOut: scale-out
  • HealthCheck: health check
  • AlarmNotification: event-triggered task
  • ScheduledAction: scheduled task
SuspendedProcessstring

The process that is suspended. If no process is suspended, null is returned. Valid values:

  • ScaleIn: scale-in
  • ScaleOut: scale-out
  • HealthCheck: health check
  • AlarmNotification: event-triggered task
  • ScheduledAction: scheduled task
ScaleIn
SystemSuspendedboolean

Indicates whether Auto Scaling stops executing scaling activities in the scaling group. Valid values:

  • true: Auto Scaling stops executing scaling activities in the scaling group if the scaling activities failed for more than seven consecutive days in the scaling group. You must modify the scaling group or scaling configuration to resume the execution of the scaling activities.
  • false: Auto Scaling does not stop executing scaling activities in the scaling group.
true
IsElasticStrengthInAlarmboolean
Note This parameter is not available for use.
false
MonitorGroupIdstring

The ID of the CloudMonitor application group that is associated with the scaling group.

1497****
AzBalanceboolean

Indicates whether instances in the scaling group are evenly distributed across zones. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

  • true
  • false
false
AllocationStrategystring

The allocation policy of instances. Auto Scaling selects instance types based on the allocation policy to create the required number of instances. You can apply the policy to pay-as-you-go instances and preemptible instances. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

  • priority: Auto Scaling selects instance types based on the specified order to create the required number of instances.
  • lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of instances.
priority
SpotAllocationStrategystring

The allocation policy of preemptible instances. Auto Scaling selects instance types based on the allocation policy to create the required number of preemptible instances. You can apply the policy to pay-as-you-go instances and preemptible instances. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

  • priority: Auto Scaling selects instance types based on the specified order to create the required number of preemptible instances.
  • lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of preemptible instances.
lowestPrice
MaxInstanceLifetimeinteger

The maximum life span of an instance in the scaling group. Unit: seconds.

Valid values: 0 or from 86400 to Integer.maxValue. A value of 0 for MaxInstanceLifetime indicates that any previously set limit has been removed, which effectively disables the maximum instance lifetime constraint.

Default value: null.

Note This parameter is not supported by scaling groups of the Elastic Container Instance type and scaling groups whose ScalingPolicy is set to Recycle.
null
CustomPolicyARNstring

The Alibaba Cloud Resource Name (ARN) of the function that is specified in the custom scale-in policy. This parameter takes effect only if you set the first value of RemovalPolicies to CustomPolicy.

null
InitCapacityinteger

The number of instances that are in the Initialized state and not added to the scaling group.

0
ResourceGroupIdstring

The ID of the resource group to which the scaling group belongs.

Note If you specify this parameter, new scaling groups are added to the specified resource group. If you do not specify this parameter, new scaling groups are added to the default resource group.
rg-aek2epf32c4uyji
LoadBalancerConfigsarray<object>

The CLB configurations.

LoadBalancerConfigobject
LoadBalancerIdstring

The ID of the CLB instance.

lb-2zein3ytoeq49cmkbyxr0
Weightinteger

The weight of a backend server.

100
EnableDesiredCapacityboolean

Indicates whether the Expected Number of Instances feature is enabled. Valid values:

  • true
  • false
true
Tagsarray<object>

The tags of the scaling group.

Tagobject
TagKeystring

The tag key of the scaling group.

Department
TagValuestring

The tag value of the scaling group.

Finance
Propagateboolean

Indicates whether the tags of the scaling group can be propagated to instances. Valid values:

  • true: The tags of the scaling group can be propagated to only instances that are newly created.
  • false: The tags of the scaling group cannot be propagated to any instances.

Default value: false.

false
HealthCheckTypesarray

The health check mode of the scaling group. Valid values:

  • NONE: Auto Scaling does not perform health checks.
  • ECS: Auto Scaling checks the health status of instances in the scaling group. If you want to enable instance health check, you can set the value to ECS, regardless of whether the scaling group is of ECS type or Elastic Container Instance type.
  • LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group based on the health check results of load balancers. The health check results of CLB instances are not supported as the health check basis for instances in the scaling group.
HealthCheckTypestring

The health check modes of the scaling group. Valid values:

  • NONE: Auto Scaling does not perform health checks.
  • ECS: Auto Scaling checks the health status of instances in the scaling group. If you want to enable instance health check, you can set the value to ECS, regardless of whether the scaling group is of ECS type or Elastic Container Instance type.
  • LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group based on the health check results of load balancers. The health check results of CLB instances are not supported as the health check basis for instances in the scaling group.
ECS
Outputstring

The output details of the scaling group of the Elastic Container Instance type. Currently, the output is displayed in a Kubernetes Deployment YAML file.

apiVersion: apps/v1 kind: Deployment metadata: name: nginx-deployment labels: app: nginx spec: replicas: 3 selector: matchLabels: app: nginx template: metadata: labels: app: nginx annotations: k8s.aliyun.com/eip-bandwidth: 10 k8s.aliyun.com/eci-with-eip: true spec: containers: - name: nginx image: nginx:1.14.2 ports: - containerPort: 80

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ScalingGroup": {
    "VpcId": "vpc-wz9fcq97y1vqkd8bijcq6",
    "CreationTime": "2014-08-14T10:58Z\n",
    "TotalInstanceCount": 1,
    "ScalingGroupName": "dyrSuvBOtO1dEdIlIbp****\n",
    "SpotInstancePools": 5,
    "StoppedCapacity": 1,
    "OnDemandPercentageAboveBaseCapacity": 20,
    "ModificationTime": "2014-08-14T10:58Z\n",
    "MinSize": 1,
    "ScalingGroupId": "asg-bp14wlu85wrpchm0****\n",
    "CompensateWithOnDemand": true,
    "ScalingPolicy": "recycle",
    "RemovingWaitCapacity": 1,
    "ActiveCapacity": 1,
    "OnDemandBaseCapacity": 30,
    "ProtectedCapacity": 1,
    "HealthCheckType": "ECS",
    "LifecycleState": "Active",
    "GroupDeletionProtection": true,
    "ActiveScalingConfigurationId": "asc-bp1et2qekq3ojr33****\n",
    "GroupType": "ECS",
    "MultiAZPolicy": "PRIORITY",
    "RemovingCapacity": 0,
    "PendingWaitCapacity": 0,
    "StandbyCapacity": 1,
    "CurrentHostName": "hostname",
    "PendingCapacity": 0,
    "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****\n",
    "TotalCapacity": 1,
    "DesiredCapacity": 5,
    "SpotInstanceRemedy": true,
    "LaunchTemplateVersion": "Default",
    "RegionId": "cn-shenzhen",
    "VSwitchId": "vsw-bp1whw2u46cn8zubm****\n",
    "MaxSize": 2,
    "DefaultCooldown": 60,
    "VServerGroups": [
      {
        "LoadBalancerId": "147b46d767c-cn-qingdao-cm5****\n",
        "VServerGroupAttributes": [
          {
            "VServerGroupId": "rsp-bp12bjrny****\n",
            "Weight": 1,
            "Port": 80
          }
        ]
      }
    ],
    "LaunchTemplateOverrides": [
      {
        "WeightedCapacity": 4,
        "InstanceType": "ecs.c5.xlarge\n",
        "SpotPriceLimit": 0.025
      }
    ],
    "AlbServerGroups": [
      {
        "AlbServerGroupId": "sgp-ddwb0y0g6y9bjm****\n",
        "Weight": 100,
        "Port": 80
      }
    ],
    "ServerGroups": [
      {
        "ServerGroupId": "sgp-i9ouakeaerr*****\n",
        "Type": "ALB",
        "Weight": 100,
        "Port": 80
      }
    ],
    "RemovalPolicies": [
      "OldestScalingConfiguration"
    ],
    "DBInstanceIds": [
      "rm-bp15556qzebg1****\n"
    ],
    "LoadBalancerIds": [
      "lb-bp19byhscefk3x0li****\n"
    ],
    "VSwitchIds": [
      "vsw-bp1whw2u46cn8zubm****\n"
    ],
    "SuspendedProcesses": [
      "ScaleIn"
    ],
    "SystemSuspended": true,
    "IsElasticStrengthInAlarm": false,
    "MonitorGroupId": "1497****\n",
    "AzBalance": false,
    "AllocationStrategy": "priority",
    "SpotAllocationStrategy": "lowestPrice",
    "MaxInstanceLifetime": 0,
    "CustomPolicyARN": "null",
    "InitCapacity": 0,
    "ResourceGroupId": "rg-aek2epf32c4uyji",
    "LoadBalancerConfigs": [
      {
        "LoadBalancerId": "lb-2zein3ytoeq49cmkbyxr0",
        "Weight": 100
      }
    ],
    "EnableDesiredCapacity": true,
    "Tags": [
      {
        "TagKey": "Department",
        "TagValue": "Finance",
        "Propagate": false
      }
    ],
    "HealthCheckTypes": [
      "ECS"
    ]
  },
  "Output": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: nginx-deployment\n  labels:\n    app: nginx\n  spec:\n    replicas: 3\n    selector:\n       matchLabels:\n        app: nginx\n    template:\n      metadata:\n        labels:\n          app: nginx\n        annotations:\n          k8s.aliyun.com/eip-bandwidth: 10\n          k8s.aliyun.com/eci-with-eip: true\n        spec:\n          containers:\n          - name: nginx\n            image: nginx:1.14.2\n            ports:\n            - containerPort: 80"
}

Error codes

For a list of error codes, visit the Service error codes.