全部产品
Search

搜索本产品

    弹性伸缩：DescribeScalingInstances

    文档中心

    弹性伸缩：DescribeScalingInstances

    更新时间：Jul 15, 2024

    调用DescribeScalingInstances，通过伸缩组ID查询该伸缩组内的ECS实例列表及实例信息，包括当前伸缩组中，运行状态的抢占式实例总数、ECS实例总数、ECS实例的预热状态、生命周期状态等。同时也支持指定实例健康状态、生命周期状态、创建方式等筛选符合要求的ECS实例。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    请求参数

    名称

    类型

    是否必选

    示例值

    描述
    Action String 是 DescribeScalingInstances

    系统规定参数。取值：DescribeScalingInstances。
    RegionId String 是 cn-hangzhou

    伸缩组所属地域的ID。
    ScalingGroupId String 否 asg-bp1igpak5ft1flyp****

    伸缩组的ID。
    ScalingConfigurationId String 否 asc-bp1i65jd06v04vdh****

    关联伸缩配置的ID。
    HealthStatus String 否 Healthy

    ECS实例或ECI实例在伸缩组中的健康状态。未处于运行中（Running）状态的ECS实例或ECI实例会被判定为不健康的实例，取值范围：

    • Healthy：健康的ECS实例或ECI实例。
    • Unhealthy：不健康的ECS实例或ECI实例。

    弹性伸缩会自动移出伸缩组中不健康的ECS实例或ECI实例，并释放自动创建的ECS实例或ECI实例。

    是否释放手动添加的ECS实例或ECI实例由其托管状态决定。如果实例生命周期未托管给伸缩组，只移出实例但不释放。如果实例生命周期托管给伸缩组，移出并释放实例。

    说明 请确保账号可用额度充足。如果账号欠费，所有后付费的ECS实例或ECI实例（包括按量付费实例和抢占式实例）都会停机，甚至被释放。欠费后伸缩组内ECS实例或ECI实例状态变化，请参见欠费说明。
    LifecycleState String 否 InService

    ECS实例、ECI实例或托管实例在伸缩组中的生命周期状态，取值范围：

    • InService：已成功加入伸缩组并正常提供服务。
    • Pending：加入中。ECS实例或ECI实例加入伸缩组时包括加入负载均衡实例的后端服务器、RDS实例的访问白名单等过程。
    • Pending:Wait：加入挂起中。如果伸缩组内创建了适用于弹性扩张活动的生命周期挂钩，ECS实例或ECI实例在加入伸缩组时被挂起并等待挂钩超时时间结束。
    • Protected：保护中。ECS实例或ECI实例正常提供服务，但弹性伸缩不管理ECS实例或ECI实例的生命周期，而是由您手动管理。
    • Standby：备用中。ECS实例或ECI实例不提供服务，负载均衡权重被置为零，且弹性伸缩不管理ECS实例的生命周期，而是由您手动管理。
    • Stopped：停用中。ECS实例、ECI实例或托管实例已停机，不提供服务。
    • Removing：移出中。ECS实例或ECI实例移出伸缩组时包括移出负载均衡实例的后端服务器、RDS实例的访问白名单等过程。

    • Removing:Wait：移出挂起中。如果伸缩组内创建了适用于弹性收缩活动的生命周期挂钩，ECS实例或ECI实例在移出伸缩组时被挂起并等待挂钩超时时间结束。

      说明 托管实例不支持配置生命周期挂钩、关联到负载均衡和健康检查功能。
    CreationType String 否 AutoCreated

    伸缩组中实例的创建方式，取值范围：

    • AutoCreated：弹性伸缩根据实例配置信息来源自动创建的ECS实例或ECI实例。
    • Attached：不是通过弹性伸缩服务创建，而是由您手动添加到伸缩组中的ECS实例或ECI实例。
    • Managed：不是通过弹性伸缩服务创建，而是由您手动添加到伸缩组中的托管实例。
    PageNumber Integer 否 1

    实例列表的页码，起始值：1。

    默认值：1。
    PageSize Integer 否 10

    分页查询时设置的每页行数，最大值：100。

    默认值：10。
    ScalingActivityId String 否 asa-bp1c9djwrgxjyk31****

    伸缩活动的ID。
    InstanceId.N String 否 i-bp109k5j3dum1ce6****

    伸缩组中实例的ID，N的取值范围：1～20。

    返回查询结果时忽略失效的InstanceId，并且不报错。
    CreationTypes.N String 否 AutoCreated

    伸缩组中实例的创建方式，此参数和CreationType参数不能同时设置。取值范围：

    • AutoCreated：弹性伸缩根据实例配置信息来源自动创建的ECS实例。
    • Attached：不是通过弹性伸缩服务创建，而是由您手动添加到伸缩组中的ECS实例。

    • Managed：不是通过弹性伸缩服务创建，而是由您手动添加到伸缩组中的托管实例。

      说明 设置该参数时，您可以选择多个创建方式（例如取值为AutoCreated、Attached、Managed）。
    LifecycleStates.N String 否 InService

    ECS实例、ECI实例或托管实例在伸缩组中的生命周期状态，取值范围：

    • InService：已成功加入伸缩组并正常提供服务。
    • Pending：加入中。ECS实例或ECI实例加入伸缩组时包括加入负载均衡实例的后端服务器、RDS实例的访问白名单等过程。
    • Pending:Wait：加入挂起中。如果伸缩组内创建了适用于弹性扩张活动的生命周期挂钩，ECS实例或ECI实例在加入伸缩组时被挂起并等待挂钩超时时间结束。
    • Protected：保护中。ECS实例或ECI实例正常提供服务，但弹性伸缩不管理ECS实例或ECI实例的生命周期，而是由您手动管理。
    • Standby：备用中。ECS实例或ECI实例不提供服务，负载均衡权重被置为零，且弹性伸缩不管理ECS实例的生命周期，而是由您手动管理。
    • Stopped：停用中。ECS实例、ECI实例或托管实例已停机，不提供服务。
    • Removing：移出中。ECS实例或ECI实例移出伸缩组时包括移出负载均衡实例的后端服务器、RDS实例的访问白名单等过程。

    • Removing:Wait：移出挂起中。移出挂起中。如果伸缩组内创建了适用于弹性收缩活动的生命周期挂钩，ECS实例或ECI实例在移出伸缩组时被挂起并等待挂钩超时时间结束。

      说明 托管实例不支持配置生命周期挂钩、关联到负载均衡和健康检查功能。

    返回数据

    名称

    类型

    示例值

    描述
    RequestId String B13527BF-1FBD-4334-A512-20F5E9D3****

    请求ID。
    PageSize Integer 10

    每页行数。
    PageNumber Integer 1

    当前页码。
    TotalSpotCount Integer 4

    当前伸缩组中，运行状态的抢占式实例总数。
    TotalCount Integer 1

    实例的总数。
    ScalingInstances Array of ScalingInstance

    实例信息组成的集合。
    ScalingInstance
    CreationTime String 2020-05-18T03:11Z

    实例加入伸缩组的时间，精确到分钟。
    LoadBalancerWeight Integer 50

    负载均衡实例权重。

    说明 该参数已废弃，不建议使用。
    LaunchTemplateId String lt-m5e3ofjr1zn1aw7****

    实例启动模板的ID。
    InstanceId String i-bp109k5j3dum1ce6****

    实例的ID。
    SpotStrategy String SpotWithPriceLimit

    抢占式实例的抢占策略。可能值：

    • SpotWithPriceLimit：设置上限价格的抢占式实例。
    • SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。
    LaunchTemplateVersion String 1

    实例启动模板的版本。
    HealthStatus String Healthy

    ECS实例或ECI实例在伸缩组中的健康状态。未处于运行中（Running）状态的ECS实例或ECI实例会被判定为不健康的实例，可能值：

    • Healthy：健康的ECS实例或ECI实例。
    • Unhealthy：不健康的ECS实例或ECI实例。

    弹性伸缩会自动移出伸缩组中不健康的ECS实例或ECI实例，并释放自动创建的ECS实例或ECI实例。

    是否释放手动添加的ECS实例或ECI实例由其托管状态决定。如果实例生命周期未托管给伸缩组，只移出实例但不释放。如果实例生命周期托管给伸缩组，移出并释放实例。

    说明 请确保账号可用额度充足。如果账号欠费，所有后付费的ECS实例或ECI实例（包括按量付费实例和抢占式实例）都会停机，甚至被释放。欠费后伸缩组内ECS实例或ECI实例状态变化，请参见欠费说明。
    ScalingGroupId String asg-bp1igpak5ft1flyp****

    所属伸缩组的ID。
    WarmupState String NoNeedWarmup

    实例的预热状态，可能值：

    • NoNeedWarmup：不需要预热。
    • WaitingForInstanceWarmup：等待预热结束。
    • InstanceWarmupFinish：预热结束。
    LifecycleState String InService

    ECS实例、ECI实例或托管实例在伸缩组中的生命周期状态，可能值：

    • InService：已成功加入伸缩组并正常提供服务。
    • Pending：加入中。ECS实例或ECI实例加入伸缩组时包括加入负载均衡实例的后端服务器、RDS实例的访问白名单等过程。
    • Pending:Wait：加入挂起中。如果伸缩组内创建了适用于弹性扩张活动的生命周期挂钩，ECS实例或ECI实例在加入伸缩组时被挂起并等待挂钩超时时间结束。
    • Protected：保护中。ECS实例或ECI实例正常提供服务，但弹性伸缩不管理ECS实例或ECI实例的生命周期，而是由您手动管理。
    • Standby：备用中。ECS实例或ECI实例不提供服务，负载均衡权重被置为零，且弹性伸缩不管理ECS实例的生命周期，而是由您手动管理。
    • Stopped：停用中。ECS实例、ECI实例或托管实例已停机，不提供服务。
    • Removing：移出中。ECS实例或ECI实例移出伸缩组时包括移出负载均衡实例的后端服务器、RDS实例的访问白名单等过程。

    • Removing:Wait：移出挂起中。如果伸缩组内创建了适用于弹性收缩活动的生命周期挂钩，ECS实例或ECI实例在移出伸缩组时被挂起并等待挂钩超时时间结束。

      说明 托管实例不支持配置生命周期挂钩、关联到负载均衡和健康检查功能。
    CreationType String AutoCreated

    伸缩组中实例的创建方式，可能值：

    • AutoCreated：弹性伸缩根据实例配置信息来源自动创建的ECS实例。
    • Attached：不是通过弹性伸缩服务创建，而是由您手动添加到伸缩组中的ECS实例。
    • Managed：不是通过弹性伸缩服务创建，而是由您手动添加到伸缩组中的托管实例。
    ZoneId String cn-hangzhou-g

    实例所属的可用区ID。
    ScalingConfigurationId String asc-bp1i65jd06v04vdh****

    关联伸缩配置的ID。
    Entrusted Boolean true

    手动添加实例到伸缩组时，是否将实例托管给伸缩组，托管状态的手动添加实例，在移除伸缩组（不包括手动移除）时，将执行释放操作。可能值：

    • true：将实例托管给伸缩组。
    • false：不将实例托管给伸缩组。
    WeightedCapacity Integer 4

    实例规格的权重，即实例规格的单台实例在伸缩组中表示的容量大小。权重越大，满足期望容量所需的本实例规格的实例数量越少。
    CreatedTime String 2020-05-18T03:11:39Z

    实例加入伸缩组的时间，精确到秒。
    ScalingActivityId String asa-bp1c9djwrgxjyk31****

    实例加入伸缩组时，伸缩活动的ID。
    InstanceType String ecs.n1.small

    实例的规格。
    ScalingInstanceId String asi-j6cj1gcte640ekhb****

    伸缩组内的实例标识，与ECS实例或ECI实例的ID一一对应。
    PrivateIpAddress String 1**.2*.1**.2**

    伸缩组中实例的内网IP地址。

    示例

    请求示例

    http(s)://ess.aliyuncs.com/?Action=DescribeScalingInstances
&RegionId=cn-hangzhou
&ScalingGroupId=asg-bp1igpak5ft1flyp****
&ScalingConfigurationId=asc-bp1i65jd06v04vdh****
&HealthStatus=Healthy
&LifecycleState=InService
&CreationType=AutoCreated
&PageNumber=1
&PageSize=10
&ScalingActivityId=asa-bp1c9djwrgxjyk31****
&InstanceId=["i-bp109k5j3dum1ce6****"]
&CreationTypes=["AutoCreated"]
&LifecycleStates=["InService"]
&公共请求参数

    正常返回示例

    XML格式

    HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeScalingInstancesResponse>
    <RequestId>B13527BF-1FBD-4334-A512-20F5E9D3****</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TotalSpotCount>4</TotalSpotCount>
    <TotalCount>1</TotalCount>
    <ScalingInstances>
        <CreationTime>2020-05-18T03:11Z</CreationTime>
        <LoadBalancerWeight>50</LoadBalancerWeight>
        <LaunchTemplateId>lt-m5e3ofjr1zn1aw7****</LaunchTemplateId>
        <InstanceId>i-bp109k5j3dum1ce6****</InstanceId>
        <SpotStrategy>SpotWithPriceLimit</SpotStrategy>
        <LaunchTemplateVersion>1</LaunchTemplateVersion>
        <HealthStatus>Healthy</HealthStatus>
        <ScalingGroupId>asg-bp1igpak5ft1flyp****</ScalingGroupId>
        <WarmupState>NoNeedWarmup</WarmupState>
        <LifecycleState>InService</LifecycleState>
        <CreationType>AutoCreated</CreationType>
        <ZoneId>cn-hangzhou-g</ZoneId>
        <ScalingConfigurationId>asc-bp1i65jd06v04vdh****</ScalingConfigurationId>
        <Entrusted>true</Entrusted>
        <WeightedCapacity>4</WeightedCapacity>
        <CreatedTime>2020-05-18T03:11:39Z</CreatedTime>
        <ScalingActivityId>asa-bp1c9djwrgxjyk31****</ScalingActivityId>
        <InstanceType>ecs.n1.small</InstanceType>
        <ScalingInstanceId>asi-j6cj1gcte640ekhb****</ScalingInstanceId>
        <PrivateIpAddress>1**.2*.1**.2**</PrivateIpAddress>
    </ScalingInstances>
</DescribeScalingInstancesResponse>

    JSON格式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "B13527BF-1FBD-4334-A512-20F5E9D3****",
  "PageSize" : 10,
  "PageNumber" : 1,
  "TotalSpotCount" : 4,
  "TotalCount" : 1,
  "ScalingInstances" : [ {
    "CreationTime" : "2020-05-18T03:11Z",
    "LoadBalancerWeight" : 50,
    "LaunchTemplateId" : "lt-m5e3ofjr1zn1aw7****",
    "InstanceId" : "i-bp109k5j3dum1ce6****",
    "SpotStrategy" : "SpotWithPriceLimit",
    "LaunchTemplateVersion" : "1",
    "HealthStatus" : "Healthy",
    "ScalingGroupId" : "asg-bp1igpak5ft1flyp****",
    "WarmupState" : "NoNeedWarmup",
    "LifecycleState" : "InService",
    "CreationType" : "AutoCreated",
    "ZoneId" : "cn-hangzhou-g",
    "ScalingConfigurationId" : "asc-bp1i65jd06v04vdh****",
    "Entrusted" : true,
    "WeightedCapacity" : 4,
    "CreatedTime" : "2020-05-18T03:11:39Z",
    "ScalingActivityId" : "asa-bp1c9djwrgxjyk31****",
    "InstanceType" : "ecs.n1.small",
    "ScalingInstanceId" : "asi-j6cj1gcte640ekhb****",
    "PrivateIpAddress" : "1**.2*.1**.2**"
  } ]
}

    错误码

    访问错误中心查看更多错误码。