Call DescribeScalingGroupV2 to query details about a scaling group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeScalingGroupV2

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Valid values: DescribeScalingGroupV2.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

ResourceGroupId String No rg-acfmv6jutt6****

The ID of the resource group. You can call ListResourceGroups View the resource group ID.

ScalingGroupBizId String No SGB-232432123245****

The ID of the scaling group. You can call ListScalingGroupV2 View the scaling group ID.

Note Enter at least one of the ScalingGroupBizId and hostgroupbis ID.
HostGroupBizId String No G-AB342535346545****

The ID of the host group. You can call ListClusterHostGroup View Machine Group ID.

Note Enter at least one of the ScalingGroupBizId and hostgroupbis. In this example, enter hostgroupbis.

Response parameters

Parameter Type Example Description
ActiveStatus String ACTIVE

The activity status of the scaling group. Valid values:

  • ACTIVE: The scaling group is started.
  • INACTIVE: the scaling group is not started.
ConfigState String APPLIED

The active status of the scaling configuration. Valid values:

  • APPLIED: the application has taken effect.
  • MODIFIED: it has been MODIFIED and has not taken effect.
Description String This is an example

The description of the scaling group.
HostGroupBizId String G-5011FB3E4928****

The machine group associated with the scaling group.
Name String Sample scaling Group

The name of the scaling group.
RequestId String C390A685-2707-4F42-BCFA-E4BC40E4B7A3

The ID of the request.
ScalingGroupId String SGB-16ABA17988F3****

The ID of the scaling group.
ScalingInMode String DEFAULT

The scaling type. Valid values:

  • DEFAULT: regular scaling
  • GRACEFUL: GRACEFUL offline
ScalingMaxSize Integer 10

The maximum number of nodes in a scaling group.
ScalingMinSize Integer 1

The minimum number of nodes in a scaling group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeScalingGroupV2
&RegionId=cn-hangzhou
&ScalingGroupBizId=SGB-AA1234567****
&<common request parameters>

Sample success responses

XML format 

<Description>this is a sample</Description>
<HostGroupBizId>G-5011FB3E4928****</HostGroupBizId>
<RequestId>C390A685-2707-4F42-BCFA-E4BC40E4B7A3</RequestId>
<ConfigState>APPLIED</ConfigState>
<ScalingInMode>DEFAULT</ScalingInMode>
<ScalingGroupId>SGB-16ABA17988F39****</ScalingGroupId>
<ScalingMaxSize>10</ScalingMaxSize>
<ScalingMinSize>1</ScalingMinSize>
<Name>Sample scaling group</Name>
<ActiveStatus>ACTIVE</ActiveStatus>

JSON Syntax 

{
    "Description":"this is a sample",
    "HostGroupBizId":"G-5011FB3E4928****",
    "RequestId":"C390A685-2707-4F42-BCFA-E4BC40E4B7A3",
    "ConfigState":"APPLIED",
    "ScalingInMode":"DEFAULT",
    "ScalingGroupId":"SGB-16ABA17988F39****",
    "ScalingMaxSize":"10",
    "ScalingMinSize":"1",
    "Name":"Sample scaling group",
    "ActiveStatus":"ACTIVE"
    }