租户端 计算 云服务器（CVM） 实例相关接口 ResetInstance

ResetInstance

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： cvm.api3.gsesgpucloud.com。

本接口 (ResetInstance) 用于重装指定实例上的操作系统。

  • 如果指定了ImageId参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。
  • 系统盘将会被格式化，并重置；请确保系统盘中无重要文件。
  • Linux和Windows系统互相切换时，该实例系统盘ID将发生变化，系统盘关联快照将无法回滚、恢复数据。
  • 密码不指定将会通过站内信下发随机密码。
  • 目前只支持系统盘类型是CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD类型的实例使用该接口实现Linux和Windows操作系统切换。
  • 目前不支持海外地域的实例使用该接口实现Linux和Windows操作系统切换。

默认接口请求频率限制：10次/秒。

接口更新时间：2022-10-27 11:44:11。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：ResetInstance
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 实例ID。可通过 DescribeInstances API返回值中的InstanceId获取。
示例值： ins-r8hr2upy
ImageId 否 否 String 指定有效的镜像ID，格式形如img-xxx。镜像类型分为四种：
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

    • 可通过以下方式获取可用的镜像ID：
  • 公共镜像、自定义镜像、共享镜像的镜像ID可通过登录控制台查询。
  • 通过调用接口 DescribeImages ，取返回信息中的ImageId字段。

    • 示例值： img-pmqg1cw7
    SystemDisk 否 否 SystemDisk 实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作，若不指定则默认系统盘大小保持不变。系统盘大小只支持扩容不支持缩容；重装只支持修改系统盘的大小，不能修改系统盘的类型。
    示例值：查看
    LoginSettings 否 否 LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码，并以站内信方式知会到用户。
    示例值：查看
    EnhancedService 否 否 EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数，则默认开启云监控、云安全服务。
    示例值：查看
    DryRun 否 否 Bool 是否跳过实际执行逻辑
    示例值： false

    3. 输出参数

    参数名称 类型 描述
    TaskId String 任务Id
    示例值： 435323
    FlowId Int64 任务流转Id
    示例值： 4
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

    错误码 描述
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InternalServerError 操作内部错误。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122。
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidImageId.NotFound 未找到该镜像。