1. 接口描述
接口请求域名: as.tencentcloudapi.com 。
根据启动配置中参数,刷新伸缩组内运行中状态 CVM 实例,返回实例刷新活动的 RefreshActivityId。
- 对于重装实例的刷新方式(目前仅支持重装),重装时仅会从启动配置中获取 ImageId、UserData、EnhancedService、 HostName、LoginSettings 参数进行刷新,实例的其他参数不会刷新
- 实例刷新期间(包括暂停状态),伸缩组会被停用。不建议刷新期间修改关联启动配置,否则会影响刷新参数,造成实例配置不一致
- 滚动更新模式会分成多批次进行刷新实例,单批次中若存在刷新失败实例,活动会进入失败暂停状态
- 若待刷新实例被移出或销毁,会被标记为 NOT_FOUND 状态,不阻塞实例刷新活动
- 运行中状态实例与最新启动配置参数一致,实例也会再次刷新
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:StartInstanceRefresh。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AutoScalingGroupId | 是 | String | 伸缩组ID。 示例值:asg-12yqet78 |
RefreshSettings | 是 | RefreshSettings | 刷新设置。 |
RefreshMode | 否 | String | 刷新模式,目前仅支持滚动更新,默认值为 ROLLING_UPDATE_RESET。 示例值:ROLLING_UPDATE_RESET |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RefreshActivityId | String | 刷新活动 ID。 示例值:asr-6t7y8u5r |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 滚动更新方式进行实例刷新
将伸缩组 asg-9dn1a5y6 中的实例分成 3 个批次进行滚动更新,批次间会自动暂停。
输入示例
POST / HTTP/1.1
Host: as.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartInstanceRefresh
<公共请求参数>
{
"AutoScalingGroupId": "asg-9dn1a5y6",
"RefreshMode": "ROLLING_UPDATE",
"RefreshSettings": {
"RollingUpdateSettings": {
"BatchNumber": 3,
"BatchPause": "BATCH_INTERVAL_PAUSE"
}
}
}
输出示例
{
"Response": {
"RefreshActivityId": "asr-y67t5r4e",
"RequestId": "c4190090-bc60-4f48-b9d4-48095b9596db"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.BatchNumberTooLarge | 批次数不能大于待刷新实例总数。 |
InvalidParameterValue.MaxSurgeTooLarge | 最大额外数量取值过大。 |
ResourceNotFound.AutoScalingGroupIdNotFound | 伸缩组不存在。 |
ResourceUnavailable.AutoScalingGroupAbnormalStatus | 伸缩组状态异常。 |
ResourceUnavailable.AutoScalingGroupInActivity | 伸缩组正在活动中。 |
ResourceUnavailable.AutoScalingGroupInRefreshActivity | 伸缩组处于另一个实例刷新活动当中。 |
ResourceUnavailable.InquiryPriceResetInstanceFailed | 重装实例询价失败,新镜像与该实例其他参数存在冲突或新镜像不存在。 |
ResourceUnavailable.NoInstanceCanRefresh | 伸缩组内不存在运行中状态的实例,无法进行实例刷新。 |
ResourceUnavailable.RefreshActivityStatusConflictWithOperation | 实例刷新活动状态与当前操作冲突。 |
UnauthorizedOperation.AutoScalingRoleUnauthorized | 未授权弹性伸缩预设服务角色AS_QCSRole,请前往弹性伸缩控制台进行授权。 |