DescribeInstanceRefreshes_弹性伸缩(ESS)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstanceRefreshes	系统规定参数。取值：DescribeInstanceRefreshes。
RegionId	String	是	cn-hangzhou	伸缩组所属的地域ID。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	查询凭证（Token）。取值为上一次调用该接口返回的NextToken参数值，初次调用接口时无需设置该参数。
MaxResults	Integer	否	10	分页查询时每页的最大条目数，取值范围：1~50。默认值：10。
ScalingGroupId	String	是	asg-bp1ffogfdauy0jw0****	伸缩组的ID。
InstanceRefreshTaskId.N	String	否	ir-adfa12312*****	待查询实例刷新任务的 ID。N的取值范围：1～20

返回数据

名称	类型	示例值	描述
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	请求ID。
NextToken	String	caeba0bbb2be03f84eb48b699f****	下一个查询开始的Token，NextToken为空表示没有下一个。
MaxResults	Integer	50	单页查询的最大条目数。
TotalCount	Integer	100	实例刷新任务总数。
InstanceRefreshTasks	Array of InstanceRefreshTask		实例刷新任务列表。
InstanceRefreshTask
InstanceRefreshTaskId	String	ir-1adfa123****	实例刷新任务ID。
ScalingGroupId	String	asg-bp16pbfcr8j9*****	伸缩组ID。
RegionId	String	cn-hangzhou	伸缩组所属地域的ID。
EndTime	String	2024-08-22T02:09:00Z	实例刷新任务的结束时间。
StartTime	String	2024-08-22T01:09:00Z	实例刷新任务的开始时间。
Status	String	InProgress	实例刷新任务当前的状态，可能值： Pending：实例刷新任务创建成功，等待调度； InProgress：实例刷新任务正在处理中； Paused: 实例刷新任务处于暂停中； Failed：实例刷新任务执行失败； Successful：实例刷新任务执行成功； Cancelling：实例刷新任务取消中； Cancelled: 实例刷新任务取消完成； RollbackInProgress：实例刷新任务回滚中； RollbackSuccessful：实例刷新任务回滚成功； RollbackFailed: 实例刷新任务回滚失败。
Detail	String	The task exceeded its maximum run time of one week. So the task failed.	实例刷新任务执行失败时，具体的失败原因。
MinHealthyPercentage	Integer	80	实例刷新期间，伸缩组中保持正常提供服务实例数量占伸缩组容量的比例。
MaxHealthyPercentage	Integer	120	实例刷新期间，伸缩组中实例数量可以超出伸缩组容量的比例。
DesiredConfiguration	Object		实例刷新的期望配置。
ImageId	String	m-uf6g5noisr****	镜像文件ID，自动创建实例时使用的镜像资源。
ScalingConfigurationId	String	asc-wz91ibkhfor****	伸缩配置ID。
FinishedUpdateCapacity	Integer	10	已经完成刷新的容量。
TotalNeedUpdateCapacity	Integer	20	一共需要完成刷新的容量。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeInstanceRefreshes
&RegionId=cn-hangzhou
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&MaxResults=10
&ScalingGroupId=asg-bp1ffogfdauy0jw0****
&InstanceRefreshTaskId=["ir-adfa12312*****"]
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstanceRefreshesResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <NextToken>caeba0bbb2be03f84eb48b699f****</NextToken>
    <MaxResults>50</MaxResults>
    <TotalCount>100</TotalCount>
    <InstanceRefreshTasks>
        <InstanceRefreshTaskId>ir-1adfa123****</InstanceRefreshTaskId>
        <ScalingGroupId>asg-bp16pbfcr8j9*****</ScalingGroupId>
        <RegionId>cn-hangzhou</RegionId>
        <EndTime>2024-08-22T02:09:00Z</EndTime>
        <StartTime>2024-08-22T01:09:00Z</StartTime>
        <Status>InProgress</Status>
        <Detail>The task exceeded its maximum run time of one week. So the task failed.</Detail>
        <MinHealthyPercentage>80</MinHealthyPercentage>
        <MaxHealthyPercentage>120</MaxHealthyPercentage>
        <DesiredConfiguration>
            <ImageId>m-uf6g5noisr****</ImageId>
            <ScalingConfigurationId>asc-wz91ibkhfor****</ScalingConfigurationId>
        </DesiredConfiguration>
        <FinishedUpdateCapacity>10</FinishedUpdateCapacity>
        <TotalNeedUpdateCapacity>20</TotalNeedUpdateCapacity>
    </InstanceRefreshTasks>
</DescribeInstanceRefreshesResponse>

JSON格式

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

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "NextToken" : "caeba0bbb2be03f84eb48b699f****",
  "MaxResults" : 50,
  "TotalCount" : 100,
  "InstanceRefreshTasks" : [ {
    "InstanceRefreshTaskId" : "ir-1adfa123****",
    "ScalingGroupId" : "asg-bp16pbfcr8j9*****",
    "RegionId" : "cn-hangzhou",
    "EndTime" : "2024-08-22T02:09:00Z",
    "StartTime" : "2024-08-22T01:09:00Z",
    "Status" : "InProgress",
    "Detail" : "The task exceeded its maximum run time of one week. So the task failed.",
    "MinHealthyPercentage" : 80,
    "MaxHealthyPercentage" : 120,
    "DesiredConfiguration" : {
      "ImageId" : "m-uf6g5noisr****",
      "ScalingConfigurationId" : "asc-wz91ibkhfor****"
    },
    "FinishedUpdateCapacity" : 10,
    "TotalNeedUpdateCapacity" : 20
  } ]
}

错误码

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