查询伸缩组

最近更新时间: 2026-09-17 00:04:45

1. 接口描述

接口请求域名： as.api3.fincloud.tencent.cn。

本接口（DescribeAutoScalingGroups）用于查询伸缩组信息。

可以根据伸缩组ID、伸缩组名称或者启动配置ID等信息来查询伸缩组的详细信息。过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的伸缩组。

默认接口请求频率限制：20次/秒。

接口更新时间：2019-10-31 18:25:58。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAutoScalingGroups
Version	是	否	String	公共参数，本接口取值：2018-04-19
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
AutoScalingGroupIds	否	否	Array of String	按照一个或者多个伸缩组ID查询。伸缩组ID形如：`asg-nkdwoui0`。每次请求的上限为100。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。示例值： ["asg-nkdwoui0\n"]
Filters	否	否	Array of Filter	过滤条件。 auto-scaling-group-id - String - 是否必填：否 -（过滤条件）按照伸缩组ID过滤。 auto-scaling-group-name - String - 是否必填：否 -（过滤条件）按照伸缩组名称过滤。 launch-configuration-id - String - 是否必填：否 -（过滤条件）按照启动配置ID过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2 每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`AutoScalingGroupIds`和`Filters`。示例值：查看
Limit	否	否	Uint64	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值： 10
Offset	否	否	Uint64	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值： 0

3. 输出参数

参数名称	类型	描述
AutoScalingGroupSet	Array of AutoScalingGroup	伸缩组详细信息列表。示例值：查看
TotalCount	Uint64	符合条件的伸缩组数量。示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidPermission	账户不支持该操作。
InvalidParameter.Conflict	参数冲突，指定的多个参数冲突，不能同时存在。
InvalidParameterValue.Filter	无效的过滤器。
InvalidFilter	无效的过滤器。

5. 示例

示例1 查询伸缩组

指定伸缩组ID查询伸缩组

输入示例

https://as.api3.fincloud.tencent.cn/?Action=DescribeAutoScalingGroups
&AutoScalingGroupIds.0=asg-nkdwoui0
&<公共请求参数>

输出示例

{
    "Response": {
        "AutoScalingGroupSet": [
            {
                "LaunchConfigurationId": "asc-7vucy6ae",
                "ForwardLoadBalancerSet": [
                    {
                        "TargetAttributes": [
                            {
                                "Port": 8080,
                                "Weight": 10
                            }
                        ],
                        "LocationId": "loc-l3hmaev9",
                        "ListenerId": "lbl-ncw704sn",
                        "LoadBalancerId": "lb-23aejgcv"
                    }
                ],
                "LoadBalancerIdSet": [],
                "InstanceCount": 1,
                "DesiredCapacity": 1,
                "AutoScalingGroupStatus": "NORMAL",
                "AutoScalingGroupId": "asg-nkdwoui0",
                "ProjectId": 0,
                "TerminationPolicySet": [
                    "OLDEST_INSTANCE"
                ],
                "AutoScalingGroupName": "vpc-7layer-lb",
                "InActivityStatus": "NOT_IN_ACTIVITY",
                "InServiceInstanceCount": 1,
                "DefaultCooldown": 301,
                "MinSize": 0,
                "MaxSize": 10,
                "VpcId": "vpc-hy436tmc",
                "LaunchConfigurationName": "启动配置1",
                "CreatedTime": "2018-09-27T02:01:28Z",
                "SubnetIdSet": [
                    "subnet-3tmerl37",
                    "subnet-b0vxjhot"
                ],
                "EnabledStatus": "ENABLED",
                "ZoneSet": []
            }
        ],
        "TotalCount": 1,
        "RequestId": "b8d3660c-bed1-40ad-9e7d-77390c9610be"
    }
}

示例2 查询绑定了标签的伸缩组

查询绑定了标签键值对（city:region）的伸缩组。

输入示例

https://as.api3.fincloud.tencent.cn/?Action=DescribeAutoScalingGroups
&Filters.0.Name=tag:city
&Filters.0.Values.0=region
&Offset=0
&Limit=1
&<公共请求参数>

输出示例

{
    "Response": {
        "AutoScalingGroupSet": [
            {
                "LaunchConfigurationId": "asc-7vucy6ae",
                "ForwardLoadBalancerSet": [
                    {
                        "TargetAttributes": [
                            {
                                "Port": 8080,
                                "Weight": 10
                            }
                        ],
                        "LocationId": "loc-l3hmaev9",
                        "ListenerId": "lbl-ncw704sn",
                        "LoadBalancerId": "lb-23aejgcv"
                    }
                ],
                "LoadBalancerIdSet": [],
                "InstanceCount": 1,
                "DesiredCapacity": 1,
                "AutoScalingGroupStatus": "NORMAL",
                "AutoScalingGroupId": "asg-nkdwoui0",
                "ProjectId": 0,
                "TerminationPolicySet": [
                    "OLDEST_INSTANCE"
                ],
                "AutoScalingGroupName": "vpc-7layer-lb",
                "InActivityStatus": "NOT_IN_ACTIVITY",
                "InServiceInstanceCount": 1,
                "DefaultCooldown": 301,
                "MinSize": 0,
                "MaxSize": 10,
                "VpcId": "vpc-hy436tmc",
                "LaunchConfigurationName": "启动配置1",
                "CreatedTime": "2018-09-27T02:01:28Z",
                "SubnetIdSet": [
                    "subnet-3tmerl37",
                    "subnet-b0vxjhot"
                ],
                "EnabledStatus": "ENABLED",
                "ZoneSet": [],
                "Tags": [
                    {
                        "Key": "city",
                        "Value": "region"
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "b8d3660c-bed1-40ad-9e7d-77390c9610be"
    }
}