在您需要将新的伸缩配置应用到伸缩组实例中时,或需要更新伸缩组中实例的镜像时,您可以调用本接口完成伸缩组中实例的刷新。
接口说明
- 伸缩组同时刻只能有一个正在运行中的实例刷新任务。
- 目前该功能仅支持扩容策略为优先级策略的 ECS 伸缩组。使用 vCPU 个数计算伸缩组容量的伸缩组和实例回收模式为停机回收模式、强制停机回收模式的伸缩组不支持该功能。
- 实例刷新期间,可以进行正常扩缩容,但扩容时会以实例刷新的期望配置进行扩容。
- 伸缩组手动添加的实例、处于备用状态、保护状态的实例会被实例刷新任务忽略,不参与实例刷新。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ess:StartInstanceRefresh | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ScalingGroupId | string | 是 | 伸缩组 ID。 | asg-bp18p2yfxow2dloq**** |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
RegionId | string | 是 | 伸缩组所属的地域 ID。 | cn-hangzhou |
MinHealthyPercentage | integer | 否 | 实例刷新期间,保持伸缩组中正常提供服务占伸缩组容量的比例。取值范围 0~100。 默认值:80。 | 80 |
MaxHealthyPercentage | integer | 否 | 实例刷新期间,伸缩组中实例可以超出伸缩组容量的比例。取值范围 100~200。 默认值:120。 说明
当 MinHealthyPercentage = MaxHealthyPercentage = 100 时,每次会刷新 1 个实例。
| 100 |
DesiredConfiguration | object | 否 | 实例刷新的期望配置。 说明
| |
ImageId | string | 否 | 镜像 ID。 说明
| m-2ze8cqacj7opnf*** |
ScalingConfigurationId | string | 否 | 伸缩配置的 ID。 说明
-实例刷新任务执行成功后,伸缩组生效的伸缩配置会更新为该配置。
| asc-2zed7lqn4ts4**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"InstanceRefreshTaskId": "ir-a12ds234fasd*****"
}
错误码
访问错误中心查看更多错误码。