You need to enable JavaScript to run this app.
导航

DescribeScalingInstances

最近更新时间2024.01.24 11:02:21

首次发布时间2022.05.13 10:42:45

调用 DescribeScalingInstances 查询伸缩组中的实例信息。

请求参数

名字类型是否必填示例值
描述
ActionStringDescribeScalingInstances要执行的操作,取值:DescribeScalingInstances。
VersionString2020-01-01API的版本,取值为:2020-01-01。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。
PageNumberInteger1列表的页码,默认值为1。
PageSizeInteger10分页查询时每页的行数,取值范围1~100。默认值:10。

InstanceIds.N

String

InstanceIds.1=i-ybmike5l70l8j1ha****&
InstanceIds.2=i-ybmike5l70l8j1hi****

实例ID。您可以调用DescribeInstances接口查询实例ID。

  • 参数 - N:表示伸缩组的序号,取值1 ~ 20。
  • 多个实例ID之间用&分隔。
ScalingConfigurationIdStringscc-ybmt16auaugh9zfy****伸缩配置ID。您可以调用DescribeScalingConfigurations接口查询伸缩配置ID。

Status

String

Init

实例状态,取值:

  • Init 初始化。
  • Pending 加入中。
  • Pending:Wait 加入挂起中。
  • InService 服务中。
  • Error 错误。
  • Removing 移出中。
  • Removing:Wait 移出挂起中。
  • Stopped 停用中。
  • Protected 保护中。

CreationType

String

AutoCreated

实例的创建方式,取值:

  • AutoCreated:由伸缩组根据实例配置自动创建的实例。
  • Attached:由您手动添加到伸缩组中的实例。

返回数据

名称类型示例值
描述
PageNumerInteger1当前页数。
PageSizeInteger10当前分页的行数。
TotalCountInteger20符合条件的实例总数。
ScalingInstancesArray-符合条件的实例信息。具体请参见下表“ScalingInstance结构”。

ScalingInstance结构

名称类型示例值
描述
InstanceIdStringi-ybmike5l70l8j1ha****实例ID。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****实例所属伸缩组ID。
LaunchTemplateIdStringlt-yc5kwj1di33uw1qj****实例启动模板ID。

LaunchTemplateVersion

String

Default

实例启动模板的版本。取值:

  • Default:始终使用模板默认版本。

  • Latest:始终使用模板最新版本。

  • 其他取值:模板的某个版本号。

说明

本参数仅当LaunchTemplateId参数存在取值时生有效。

Status

String

Init

实例状态。取值:

  • Init 初始化。
  • Pending 加入中。
  • Pending:Wait 加入挂起中。
  • InService 服务中。
  • Error 错误。
  • Removing 移出中。
  • Removing:Wait 移出挂起中。
  • Stopped 停用中。
  • Protected 保护中。
ScalingPolicyIdStringsp-ybmvamf8uql8j1fl****伸缩规则ID。仅通过伸缩规则自动创建的实例有返回值。
ScalingConfigurationIdStringscc-ybmt16auaugh9zfy****伸缩配置ID。

Entrusted

Boolean

true

添加实例到伸缩组时,是否将实例托管给伸缩组,取值:

  • true:将实例托管给伸缩组。
  • false:未将实例托管给伸缩组。
CreatedTimeString2022-04-02T16:00:00Z实例加入伸缩组的时间,精确到秒。

CreationType

String

AutoCreated

实例的创建方式。取值:

  • AutoCreated:根据伸缩配置自动创建的实例。
  • Attached:由您手动添加到伸缩组中的实例。
ZoneIdStringcn-beijing-a实例所属的可用区ID。

请求示例

GET /?Action=DescribeScalingInstances&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204201701310101742350380623****",
        "Action": "DescribeScalingInstances",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "ScalingInstances": [
            {
                "InstanceId": "i-ybmike5l70l8j1ha****",
                "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",
                "LaunchTemplateId": "",
                "LaunchTemplateVersion": "",
                "Status": "InService",
                "ScalingPolicyId": "",
                "ScalingConfigurationId": "scc-ybmt16auaugh9zfy****",
                "Entrusted": true,
                "CreatedTime": "2022-04-19T06:29:28Z",
                "CreationType": "AutoCreated",
                "ZoneId": "cn-beijing-a"
            }
        ]
    }
}