You can call ListScalingGroupV2 operation to view the scaling group list.

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 ListScalingGroupV2

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: ListScalingGroupV2.

RegionId String Yes cn-hangzhou

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

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which the snapshot belongs. You can call ListResourceGroups View the resource group ID.

Limit Integer No 0

Abandoned Field.

PageNumber Integer No 1

The page number of the returned page.

PageSize Integer No 100

The number of entries to return per page.

Maximum value: 100

Default value: 100

CurrentSize Integer No 0

Abandoned Field.

PageCount Integer No 0

Abandoned Field.

OrderField String No id

Abandoned Field.

OrderMode String No desc

Abandoned Field.

ClusterBizId String No C-ABC12323****

The ID of the cluster. You can call ListClusters Interface to view the cluster ID.

Response parameters

Parameter Type Example Description
Items Array of Item

Scaling group list

Item
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.
Description String This is a sample scaling Group

The description of the scaling group.

HostGroupBizId String G-3242ABC24****

The ID of the host group.

Name String test

The name of the scaling group.

ScalingGroupId String SGB-242342ABC****

The ID of the scaling group.

ScalingInMode String GRACEFUL

The scaling mode. Valid values:

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

The maximum number of nodes in a scaling group. Default value: 500.

ScalingMinSize Integer 0

The minimum number of nodes in the scaling group. The minimum value is 0.

NextToken String None

Abandoned Field.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 100

The number of records on each page.

RequestId String 123DF0CD-C5F5-4A8D-984A-C5A4331EB84F

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListScalingGroupV2 
&RegionId=cn-hangzhou 
&<common request parameters>  

Sample success responses

XML format

<TotalCount>100</TotalCount> 
<RequestId>123DF0CD-C5F5-4A8D-984A-C5A4331EB84F</RequestId> 
<PageSize>100</PageSize> 
<PageNumber>1</PageNumber> 
<Items> 
    <Item> 
         <Description>this is an example of scaling group</Description> 
         <HostGroupBizId>G-3242ABC24****</HostGroupBizId> 
         <ScalingInMode>graceful</ScalingInMode> 
         <ScalingGroupId>SGB-242342ABC****</ScalingGroupId> 
         <ScalingMaxSize>10</ScalingMaxSize> 
         <ScalingMinSize>0</ScalingMinSize> 
         <Name>test</Name> 
         <ActiveStatus>ACTIVE</ActiveStatus> 
   </Item> 
</Items>   

JSON Syntax

{
    "TotalCount":"100",
    "RequestId":"123DF0CD-C5F5-4A8D-984A-C5A4331EB84F",
    "PageSize":"100",
    "PageNumber":"1",
    "Items":
    {
        "Item":
        [
            {
                "Description":"this is an example of scaling group",
                "HostGroupBizId":"G-3242ABC24****",
                "ScalingInMode":"GRACEFUL",
                "ScalingGroupId":"SGB-242342ABC****",
                "ScalingMaxSize":"10",
                "ScalingMinSize":"0",
                "Name":"test",
                "ActiveStatus":"ACTIVE"
                }
         ]
       }
}