重置实例密码

最近更新时间:2018-08-17 17:02:20

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (ResetInstancesPassword) 用于将实例操作系统的密码重置为用户指定的密码。

  • 只修改管理员帐号的密码。实例的操作系统不同,管理员帐号也会不一样(WindowsAdministratorUbuntuubuntu,其它系统为root)。
  • 重置处于运行中状态的实例,需要显式指定强制关机参数ForceStop。如果没有显式指定强制关机参数,则只有处于关机状态的实例才允许执行重置密码操作。
  • 支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为100。

接口请求频率限制:10次/每秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi )时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstancesPassword
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。
Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
  • Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9][( ) ~ ~ ! @ # $ % ^ & * - + = _ &#124; { } [ ] : ; ' < > , . ? /]中的符号。密码不允许以/符号开头。
  • Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9][( ) ~ ~ ! @ # $ % ^ & * - + = _ &#124; { } [ ] : ; ' < > , . ? /]中的符号。密码不允许以/符号开头。
  • 如果实例即包含Linux实例又包含Windows实例,则密码复杂度限制按照Windows实例的限制。
  • UserName String 待重置密码的实例操作系统用户名。不得超过64个字符。
    ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再重置用户密码。取值范围:
  • TRUE:表示在正常关机失败后进行强制关机
  • FALSE:表示在正常关机失败后不进行强制关机

    默认取值:FALSE。

    强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。
  • 3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.TooLong 无效参数值。参数值太长。
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    MissingParameter 参数缺失。请求没有带必选参数。

    5. 示例

    示例1 重置一个Linux/Windows实例的密码

    输入示例

    https://cvm.tencentcloudapi.com/?Action=ResetInstancesPassword
    &InstanceIds.0=ins-r8hr2upy
    &InstanceIds.1=ins-5d8a23rs
    &Password=abc123ABC!@#
    &ForceStop=TRUE
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    6. 其他资源

    云 API 3.0 提供了配套的开发工具,能更方便的调用 API 。