说明:当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0。
1. 接口描述
本接口 (ResetInstancePassword) 用于将实例操作系统的密码重置为用户指定的值。
接口请求域名:cvm.api.qcloud.com
- 只修改管理员账号的密码;实例的操作系统不同,管理员账号也会不一样(Windows为Administrator;Ubuntu为ubuntu;其它系统为root)。
- 支持批量操作,以将多个CVM实例修改为相同的密码。
- 只有处于关机状态的实例才允许执行重置密码操作。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,其它参数见公共请求参数页面。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
instanceIds.n | 是 | String | 待操作的实例ID。可通过 DescribeInstances API返回值中的 unInstanceId 获取(此接口支持同时传入多个ID。此参数的具体格式可参考API简介的 id.n 一节)。 |
password | 是 | String | 实例密码。 Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ' , . ? / ]中的特殊符号。<br><br>Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ~ ! @ # $ % ^ & * - + = { } [ ] : ; ' , . ? /]中的特殊符号。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码。0表示成功,其他值表示失败。 |
message | String | 模块错误信息描述,与接口相关。 |
4. 错误码
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见CVM错误码页面。
错误码 | 描述 |
---|---|
OperationConstraints.InvaildInstanceStatus | 实例状态不正确或获取实例状态失败 |
5. 示例
输入
https://cvm.api.qcloud.com/v2/index.php?Action=ResetInstancePassword &instanceIds.0=ins-xxxxxxxx &password=abce1234 &公共请求参数
输出
参见:批量异步任务接口返回格式