ResetInstance

1. 接口描述

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

准备工作

• 查询镜像：调用DescribeImages可以查询到需要重装的操作系统镜像信息。

注意事项

• 如果指定了imageId参数，则使用指定的镜像重装；否则按照实例当前使用的镜像进行重装。

• 实例的系统盘大小必须大于或等于被重装镜像的大小。否则操作将被拒绝。

• 系统盘将会被格式化，并重置；请确保系统盘中无重要文件。

• 密码与keyPair必须且只能指定其中一种。

• 重装系统必须在实例为关机状态才能进行。

• 重装实例后进入DEPLOYING(部署中)的状态。如果实例的最新状态变为RUNNING(开机)，则代表操作成功，如果变为REINSTALL_FAILED(重装失败)，则代表操作失败，请与管理员联系；实例的状态可以通过调用 DescribeInstancesStatus 接口查询。

2. 请求参数

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

参数名称	必选	类型	描述
instanceId	是	String	待操作的ZEC实例ID。 可通过DescribeInstances接口返回值中的instanceId获取。
imageId	否	String	指定有效的镜像ID。 可通过以下方式获取可用的镜像ID：通过调用接口 DescribeImages ，取返回信息中的imageId字段；也可以不指定镜像，根据原有镜像进行重装。
password	否	String	实例登录密码，与参数keyId互斥。 必须是8-16位，必须包含以下3种格式的字符： 大小写字母: [a-zA-Z] 数字: 0-9 特殊字符: ~!@$^*-_=+
keyId	否	String	密钥对ID，与参数password互斥。
timezone	否	String	如果不指定，则按机器原有的timezone进行重装
enableAgent	否	String	机器是否开启agent

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

示例

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

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

Request：
{
    "instanceId": "instanceId",
    "imageId": "image-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_PASSWORD_MALFORMED	无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
400	UNSUPPORTED_OPERATION_INSTANCE_STATUS	当前机器的状态不支持该操作。
400	INVALID_IMAGE_SIZE_EXCEED	所选系统盘容量小于镜像需要的大小。
400	INVALID_IMAGE_TYPE_NOT_SAME	所选的镜像类型与原镜像不同。
400	INVALID_IMAGE_AGENT_NOT_SUPPORT	所选镜像不支持安装agent
404	INVALID_PASSWORD_KEY_PAIR_NOT_FOUND	未指定密码或者keyId
403	INVALID_REGION_KEY_PAIR_NOT_SUPPORT	所选区域不支持keyPair