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

ResetInstancesPassword

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

1. 接口描述

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

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

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

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

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

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：ResetInstancesPassword
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds 是 否 Array of String 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。
示例值： ["ins-r8hr2upy","ins-5d8a23rs"]
Password 是 否 String 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：
  • Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9]和`[( )   ! @ # $ % ^ & * - + = _ 
    		•
    UserName 否 否 String 待重置密码的实例操作系统用户名。不得超过64个字符。
    示例值： asdc21
    ForceStop 否 否 Bool 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围：
  • TRUE：表示在正常关机失败后进行强制关机
  • FALSE：表示在正常关机失败后不进行强制关机

    默认取值：FALSE。

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

    3. 输出参数

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

    4. 错误码

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

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