重装弹性云服务器操作系统(未安装Cloud-init) - ReinstallServerWithoutCloudInit
功能介绍
重装弹性云服务器的操作系统。
本接口为异步接口,当前重装弹性云服务器操作系统请求下发成功后会返回job_id,此时重装弹性云服务器操作系统并没有立即完成,需要通过调用查询任务的执行状态 - ShowJob查询job状态,当Job状态为 SUCCESS 时代表云服务器操作系统重装成功。
调用该接口后,系统将卸载系统盘,然后使用原镜像重新创建系统盘,并挂载至弹性云服务器,实现重装操作系统功能。
该接口支持未安装Cloud-init或Cloudbase-init的镜像,如果镜像安装了Cloud-init或者Cloudbase-init,请使用 重装弹性云服务器操作系统(安装Cloud-init) - ReinstallServerWithCloudInit接口。
接口约束
- 不包含系统盘的弹性云服务器不能执行重装操作。
- 执行重装操作系统任务时,请勿并行执行其他任务,否则可能会引起重装操作系统失败。
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
|
授权项 |
访问级别 |
资源类型(*为必须) |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
ecs:cloudServers:rebuild |
write |
instance * |
|
- |
- |
URI
POST /v1/{project_id}/cloudservers/{server_id}/reinstallos
请求消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
adminpass |
否 |
String |
云服务器管理员账户的初始登录密码。 其中,Windows管理员账户的用户名为Administrator,Linux管理员账户的用户名为root。 建议密码复杂度如下:
说明:
|
|
keyname |
否 |
String |
密钥名称。 密钥可以通过密钥创建接口进行创建(请参见创建和导入SSH密钥对),或使用SSH密钥查询接口查询已有的密钥(请参见查询SSH密钥对列表 )。 |
|
userid |
否 |
String |
用户ID。 |
|
metadata |
否 |
Object |
重装云服务器的元数据。 更多信息,请参见表4。 |
|
mode |
否 |
String |
取值为withStopServer ,支持开机状态下重装弹性云服务器。 mode取值为withStopServer时,对开机状态的 弹性云服务器执行重装操作,系统自动对云服务器先执行关机,再重装操作系统。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
BYOL |
否 |
String |
如果您已拥有操作系统或软件的许可证(一般是指按物理插槽数、物理内核数等进行认证的许可证),您可以通过自带许可(BYOL)的方式将业务完整迁移到云平台,继续使用您的许可证。 |
|
__system__encrypted |
否 |
String |
metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,系统盘默认为不加密。 |
|
__system__cmkid |
否 |
String |
用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。
说明:
请参考查询密钥列表,通过HTTPS请求获取密钥ID。 |
响应消息
响应参数如表5所示。
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
参数解释: 提交任务成功后返回的任务ID,用户可以使用该ID对任务执行情况进行查询。如何根据job_id来查询Job的执行状态,请参考查询Job状态。 取值范围: 不涉及 |
异常响应请参考响应(任务类),异常响应要素说明。
请求示例
重装云服务器操作系统,重装后采用密钥方式登录鉴权。
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/reinstallos
{
"os-reinstall": {
"keyname": "KeyPair-350b",
"userid": "7e25b1da389f4697a79df3a0e5bd494e",
"metadata": {
"__system__encrypted": "1",
"__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846"
}
}
}
返回值
请参考通用请求返回值。
错误码
请参考错误码。