如果您需要查看实例刷新任务的基本信息、 实例刷新任务的进度等信息，您可以调用DescribeInstanceRefreshes查询该伸缩组的实例刷新任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ess:DescribeInstanceRefreshes | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 伸缩组所属的地域 ID。 | cn-hangzhou |
| NextToken | string | 否 | 查询凭证（Token）。取值为上一次调用该接口返回的 NextToken 参数值，初次调用接口时无需设置该参数。 | caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults | integer | 否 | 分页查询时每页的最大条目数，取值范围：1~50。 默认值：10。 | 10 |
| ScalingGroupId | string | 否 | 伸缩组的 ID。 说明
调用该 API 时，ScalingGroupId 和 InstanceRefreshTaskIds 参数必须二选一进行配置，如果两个参数同时都不配置，则会报错。
| asg-bp1ffogfdauy0jw0**** |
| InstanceRefreshTaskIds | array | 否 | 待查询实例刷新任务的 ID。 | |
| string | 否 | 待查询实例刷新任务的 ID。 | ir-adfa12312***** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"NextToken": "caeba0bbb2be03f84eb48b699f****",
"MaxResults": 50,
"TotalCount": 100,
"InstanceRefreshTasks": [
{
"ScalingGroupId": "asg-bp16pbfcr8j9*****",
"InstanceRefreshTaskId": "ir-1adfa123****",
"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
}
]
}错误码
访问错误中心查看更多错误码。