重置实例密码

最近更新时间:2019-05-31 11:39:40

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

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

接口请求域名:cvm.api.qcloud.com

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。

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

    默认取值:FALSE。

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

    参数名称 类型 描述
    RequestId String 唯一请求ID。每次请求都会返回RequestId。当用户调用接口失败找后台研发人员处理时需提供该RequestId

    4. 错误码

    以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见公共错误码

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

    5. 示例

    输入

    https://cvm.api.qcloud.com/v2/index.php?Action=ResetInstancesPassword
    &Version=2017-03-12
    &InstanceIds.1=ins-r8hr2upy
    &InstanceIds.2=ins-5d8a23rs
    &Password=abc123ABC!@#
    &ForceStop=TRUE
    &<公共请求参数>
    

    输出

    {
        "Response": {
            "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
        }
    }