DescribeScalingGroups - 查询伸缩组列表--弹性伸缩-火山引擎

文档中心

立即注册

导航

DescribeScalingGroups - 查询伸缩组列表

最近更新时间：2024.05.21 17:43:39首次发布时间：2022.05.13 10:42:44

获取伸缩组信息。如果不存在匹配的伸缩组，则自动忽略，继续查询其他伸缩组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeScalingGroups	要执行的操作，取值：DescribeScalingGroups。
Version	String	是	2020-01-01	API的版本，取值：2020-01-01。
ProjectName	String	否	default	伸缩组所属项目。
ScalingGroupIds.N	Array of String	否	scg-ybmssdnnhn5pkgyd****	伸缩组ID列表。参数 - N：表示伸缩组的序号，取值：1～10。多个伸缩组ID之间用&分隔。
TagFilters.N.Key	Array of String	否	k1	用户标签的标签键。参数 - N：表示标签键的序号，取值范围：1～20。多个标签键之间用&分隔。不允许重复。
TagFilters.N.Value	Array of String	否	v1	用户标签的标签值。参数 - N：表示标签值的序号。取值范围：1～20。多个标签值之间用&分隔。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数，取值范围：1～50。默认值：10。
ScalingGroupNames.N	Array of String	否	scaling-group-1	伸缩组名称。参数 - N：表示伸缩组的序号，取值：1～10。多个伸缩组名称之间用&分隔。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	当前分页的行数。
ScalingGroups	Array of ScalingGroup	--	符合条件的伸缩组信息。
TotalCount	Integer	20	符合条件的伸缩组总数。

请求示例

GET /?Action=DescribeScalingGroups&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T093615Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240507173729242176052105F626CE",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 10,
    "ScalingGroups": [
      {
        "ActiveScalingConfigurationId": "scc-3u1mfze31u3dllw****",
        "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****\t",
        "InstanceTerminatePolicy": "NewestInstance",
        "DefaultCooldown": 10,
        "ScalingGroupName": "scaling-group-test\t",
        "MultiAZPolicy": "PRIORITY",
        "LifecycleState": "Active",
        "ServerGroupAttributes": [
          {
            "LoadBalancerId": "clb-12augb3oetgxs17q7y24a****\t",
            "ServerGroupId": "rsp-12b2z5fnxvhts17q7y2fj****\t",
            "Port": 80,
            "Weight": 20,
            "Type": "CLB"
          },
        ],
        "DBInstanceIds": [
          "rds-mysql-42b38c76****"
        ],
        "SubnetIds": [
          "subnet-24sdlkdplsjkdjd****"
        ],
        "VpcId": "vpc-2fevwte3frk0059gp67d6****",
        "UpdatedAt": "2022-04-14T18:29:38+08:00",
        "TotalInstanceCount": 1,
        "MinInstanceNumber": 0,
        "MaxInstanceNumber": 100,
        "CreatedAt": "2022-04-10T18:29:38+08:00",
        "DesireInstanceNumber": 1,
        "LaunchTemplateOverrides": [
          {
            "InstanceType": "ecs.g2a.large",
            "WeightedCapacity": 1,
            "PriceLimit": 0.001
          },
        ],
        "LaunchTemplateId": "lt-yc5kwj1di33uw1qj****",
        "LaunchTemplateVersion": "Default",
        "StoppedInstanceCount": 10,
        "HealthCheckType": "ECS",
        "Tags": [
          {
            "Key": "k1",
            "Value": "v1"
          },
        ],
        "ScalingMode": "release",
        "ProjectName": "default",
        "InstancesDistribution": {
          "OnDemandBaseCapacity": 0,
          "OnDemandPercentageAboveBaseCapacity": 0,
          "CompensateWithOnDemand": true,
          "SpotInstanceRemedy": true
        },
        "LoadBalancerHealthCheckGracePeriod": 60,
        "SuspendedProcesses": [
          "ScaleIn"
        ]
      },

错误码

您可访问公共错误码，获取更多错误码信息。