ResetInstance

1. 接口描述

本接口用于重装一台虚拟机实例上的操作系统。

准备工作

查询镜像：调用DescribeImages可以查询到需要重装的操作系统镜像信息。
查询密钥对：调用 DescribeKeyPairs可以查询到密钥对ID信息。

注意事项

如果指定了imageId参数，则使用指定的镜像重装；否则按照实例当前使用的镜像进行重装。
实例的系统盘大小必须大于或等于被重装镜像的大小。否则操作将被拒绝。
系统盘将会被格式化，并重置；请确保系统盘中无重要文件。
如果密码不指定将会通过邮箱下发随机密码。
重装系统必须在实例为关机状态才能进行。
重装实例后进入**REBUILDING**(重置中)的状态。如果实例的最新状态变为RUNNING(运行中)，则代表操作成功；实例的状态可以通过调用 DescribeInstancesStatus 接口查询。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

instanceId

是

String

待操作的虚拟机实例ID。

可通过DescribeInstances接口返回值中的instanceId获取。

imageId

否

String

指定有效的镜像ID。可通过以下方式获取可用的镜像ID：通过调用接口 DescribeImages ，取返回信息中的imageId字段；也可以不指定镜像，如果不指定镜像，如果不指定镜像，将根据原有镜像进行重装。

password

否

String

实例登录密码。必须是8-16位，必须包含以下4种格式的字符：

小写字母: [a-z]
大写字母: [A-Z]
数字: 0-9
特殊字符: !@#$%^+*()

keyId

否

String

密钥ID。

关联密钥后，就可以通过对应的私钥来访问实例；密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。示例值：key-YWD2QFOl

wanName

否

String

公网网卡名称。只能是小写字母和数字，且必须以字母开头，长度限制为4-15。默认的公网网卡名称为eth0。

lanName

否

String

内网网卡名称。只能是小写字母和数字，且必须以字母开头，长度限制为4-15。默认的内网网卡名称为eth1。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

1.指定镜像和密码重装指定ID的实例

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: resetInstance
<Common Request Params>

Request：
{
    "instanceId": "instanceId",
    "imageId": "img-xxxxxxxxx",
    "password": "Example+123"
}

Response:
{
  "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453",
  "response": {
    "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_INSTANCE_NOT_FOUND

指定的实例不存在。

404

INVALID_IMAGE_NOT_FOUND

未找到指定的镜像。

400

INVALID_PARAMETER_VALUE_PASSWORD_MALFORMED

无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。

400

INVALID_IMAGE_SIZE_EXCEED

镜像的大小超过了当前系统盘的大小。

最后更新于2天前