查询伸缩组

最近更新时间:2020-11-18 08:07:26

1. 接口描述

接口请求域名: as.tencentcloudapi.com 。

本接口(DescribeAutoScalingGroups)用于查询伸缩组信息。

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:as.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAutoScalingGroups。
Version String 公共参数,本接口取值:2018-04-19。
Region String 公共参数,详见产品支持的 地域列表
AutoScalingGroupIds.N Array of String 按照一个或者多个伸缩组ID查询。伸缩组ID形如:asg-nkdwoui0。每次请求的上限为100。参数不支持同时指定AutoScalingGroupIdsFilters
Filters.N Array of Filter 过滤条件。
  • auto-scaling-group-id - String - 是否必填:否 -(过滤条件)按照伸缩组ID过滤。
  • auto-scaling-group-name - String - 是否必填:否 -(过滤条件)按照伸缩组名称过滤。
  • vague-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。参数不支持同时指定AutoScalingGroupIdsFilters
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。

    3. 输出参数

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

    4. 示例

    示例1 查询伸缩组

    指定伸缩组ID查询伸缩组

    输入示例

    https://as.tencentcloudapi.com/?Action=DescribeAutoScalingGroups
    &AutoScalingGroupIds.0=asg-nkdwoui0
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "AutoScalingGroupSet": [
          {
            "LaunchConfigurationId": "asc-7vucy6ae",
            "ForwardLoadBalancerSet": [
              {
                "TargetAttributes": [
                  {
                    "Port": 8080,
                    "Weight": 10
                  }
                ],
                "LocationId": "loc-l3hmaev9",
                "ListenerId": "lbl-ncw704sn",
                "Region": "ap-guangzhou",
                "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:shenzhen)的伸缩组。

    输入示例

    https://as.tencentcloudapi.com/?Action=DescribeAutoScalingGroups
    &Filters.0.Name=tag:city
    &Filters.0.Values.0=shenzhen
    &Offset=0
    &Limit=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "AutoScalingGroupSet": [
          {
            "LaunchConfigurationId": "asc-7vucy6ae",
            "ForwardLoadBalancerSet": [
              {
                "TargetAttributes": [
                  {
                    "Port": 8080,
                    "Weight": 10
                  }
                ],
                "LocationId": "loc-l3hmaev9",
                "ListenerId": "lbl-ncw704sn",
                "Region": "ap-guangzhou",
                "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": "shenzhen"
              }
            ]
          }
        ],
        "TotalCount": 1,
        "RequestId": "b8d3660c-bed1-40ad-9e7d-77390c9610be"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidFilter 无效的过滤器。
    InvalidParameterConflict 指定的两个参数冲突,不能同时存在。
    InvalidParameterValue.Filter 无效的过滤器。
    InvalidParameterValue.TooLong 取值过多。
    InvalidPermission 账户不支持该操作。
    目录