功能介绍
切换弹性云服务器操作系统。
该接口支持未安装Cloud-init或Cloudbase-init的镜像使用。
接口约束
- 关机状态或者重装/切换操作系统失败的弹性云服务器才能执行切换操作。
- 不包含系统盘的弹性云服务器不能切换操作系统。
- 执行切换操作系统任务时,请勿并行执行其他任务,否则可能会引起切换操作系统失败。
- 该接口支持未安装Cloud-init或Cloudbase-init的镜像使用。
URI
POST /v1/{project_id}/cloudservers/{server_id}/changeos
参数说明请参见 表1。
参数 | 是否必选 | 描述 |
project_id | 是 | 项目ID。 获取方法请参见获取项目ID。 |
server_id | 是 | 弹性云服务器ID。 |
请求消息
请求参数
请求参数如 表2所示。
参数 | 是否必选 | 参数类型 | 描述 |
表3 os-change字段数据结构说明 | |||
参数 | 是否必选 | 参数类型 | 描述 |
os-change | 是 | Dict | 切换弹性云服务器操作系统。 |
adminpass | 否 | String | 云服务器管理员帐户的初始登录密码。 其中,Windows管理员帐户的用户名为Administrator。 建议密码复杂度如下:
说明:
|
keyname | 否 | String | 密钥名称。 |
userid | 是 | String | 用户ID。 |
imageid | 是 | String | 切换系统所使用的新镜像的ID,格式为UUID。 |
metadata | 否 | 字典数据结构 | 切换云服务器的元数据。 更多信息,请参见表4。 |
表4 metadata字段数据结构说明 | |||
参数 | 是否必选 | 参数类型 | 描述 |
user_data | 否 | String | 云服务器管理员帐户初始登录密码。 Linux管理员帐户为root,密码需要加盐加密后传入。 |
响应消息
请参考响应(任务类)。
示例
- 请求样例
- {
- "os-change": {
- "keyname": "KeyPair-350b",
- "userid": "7e25b1da389f4697a79df3a0e5bd494e",
- "imageid": "e215580f-73ad-429d-b6f2-5433947433b0",
- "metadata": {
- "BYOL": "false"
- }
- }
}
返回值
请参考通用请求返回值。
错误码
请参考错误码说明。