调用DescribeInstanceRefreshes查询实例刷新任务信息-弹性伸缩-阿里云-弹性伸缩(ESS)-阿里云帮助中心

如果您需要查看实例刷新任务的基本信息、实例刷新任务的进度等信息，您可以调用DescribeInstanceRefreshes查询该伸缩组的实例刷新任务。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ess:DescribeInstanceRefreshes

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

无

请求参数

名称	类型	必填	描述	示例值
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*****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f****
MaxResults	integer	单页查询的最大条目数。	50
TotalCount	integer	实例刷新任务总数。	100
InstanceRefreshTasks	array<object>	实例刷新任务列表。
	array<object>	实例刷新任务。
ScalingGroupId	string	伸缩组 ID。	asg-bp16pbfcr8j9*****
InstanceRefreshTaskId	string	实例刷新任务 ID。	ir-1adfa123****
RegionId	string	伸缩组所属地域的 ID。	cn-hangzhou
EndTime	string	实例刷新任务的结束时间。	2024-08-22T02:09:00Z
StartTime	string	实例刷新任务的开始时间。	2024-08-22T01:09:00Z
Status	string	实例刷新任务当前的状态，可能值： Pending：实例刷新任务创建成功，等待调度； InProgress：实例刷新任务正在处理中； Paused: 实例刷新任务处于暂停中； CheckpointPause：因任务进度到达刷新任务检查点（`Checkpoint.Percentage`）而处于暂停状态； Failed：实例刷新任务执行失败； Successful：实例刷新任务执行成功； Cancelling：实例刷新任务取消中； Cancelled: 实例刷新任务取消完成； RollbackInProgress：实例刷新任务回滚中； RollbackSuccessful：实例刷新任务回滚成功； RollbackFailed: 实例刷新任务回滚失败；	InProgress
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	镜像文件 ID，自动创建实例时使用的镜像资源。	m-uf6g5noisr****
ScalingConfigurationId	string	伸缩配置 ID。	asc-wz91ibkhfor****
LaunchTemplateId	string	实例启动模板的 ID，用于指定伸缩组从实例启动模板获取启动配置信息。	lt-2ze5x4mp*****
LaunchTemplateVersion	string	实例启动模板的版本。可能值：固定的模板版本号。 Default：始终使用模板默认版本。 Latest：始终使用模板最新版本。	Latest
LaunchTemplateOverrides	array<object>	扩展启动模板的实例规格信息。
	object	扩展启动模板的实例规格信息。
InstanceType	string	指定的实例规格，会覆盖启动模板中的实例规格。	ecs.sn1ne.large
Containers	array<object>	实例包含的容器列表。
	array<object>	实例包含的容器列表。
Name	string	自定义的容器名称。	name
Image	string	容器镜像。	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
Commands	array	容器启动命令。
	string	容器启动命令。	sleep
Args	array	容器启动命令对应的参数。
	string	容器启动命令对应的参数。	100
EnvironmentVars	array<object>	环境变量的信息。
	object	环境变量的信息。
Key	string	环境变量名。	PATH
Value	string	环境变量值。	/usr/local/bin
FieldRefFieldPath	string	说明该参数未开放使用。	fieldPath
FinishedUpdateCapacity	integer	已经完成刷新的容量。	10
TotalNeedUpdateCapacity	integer	一共需要完成刷新的容量。	20
SkipMatching	boolean	是否跳过和期望配置匹配的实例。说明系统会根据期望伸缩配置的 ID 界定是否匹配，不会对比具体的配置项。可能值： true：跳过。当启动实例刷新任务时，系统会检查每个实例的配置。对于已经使用期望配置创建的实例，不执行刷新操作。 false：不跳过。在启动实例刷新任务后，刷新任务启动时所有伸缩组中的实例。	true
CheckpointPauseTime	integer	当进入刷新任务检查点时，暂停的时长。单位：分钟。	30
Checkpoints	array<object>	刷新任务检查点：指定在实例刷新过程中，当新实例占比达到设定值时自动暂停任务 CheckpointPauseTime 分钟。
	object	刷新任务检查点：指定在实例刷新过程中，当新实例占比达到设定值时自动暂停任务 CheckpointPauseTime 分钟。
Percentage	integer	伸缩组中新实例占总实例的占比，到达该占比时任务自动暂停。	60
Strategy	string

示例

正常返回示例

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****",
        "LaunchTemplateId": "lt-2ze5x4mp*****",
        "LaunchTemplateVersion": "Latest",
        "LaunchTemplateOverrides": [
          {
            "InstanceType": "ecs.sn1ne.large"
          }
        ],
        "Containers": [
          {
            "Name": "name",
            "Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest",
            "Commands": [
              "sleep"
            ],
            "Args": [
              "100"
            ],
            "EnvironmentVars": [
              {
                "Key": "PATH",
                "Value": "/usr/local/bin",
                "FieldRefFieldPath": "fieldPath"
              }
            ]
          }
        ]
      },
      "FinishedUpdateCapacity": 10,
      "TotalNeedUpdateCapacity": 20,
      "SkipMatching": true,
      "CheckpointPauseTime": 30,
      "Checkpoints": [
        {
          "Percentage": 60
        }
      ],
      "Strategy": ""
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。