重置实例密码
最近更新时间: 2024-10-18 10:38:39
1. 接口描述
接口请求域名： cvm.api3.fincloud.tencent.cn。
本接口 (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 | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceIds | 是 | 否 | Array of String | 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。 |
| Password | 是 | 否 | String | 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：<br><li>Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9]和[( ) ~ ~ ! @ # $ % ^ & * - + = _ | { } [ ] : ; ' < > , . ? /]中的符号。密码不允许以/符号开头。<br><li>Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9]和[( ) ~ ~ ! @ # $ % ^ & * - + = _ | { } [ ] : ; ' < > , . ? /]中的符号。密码不允许以/符号开头。<br><li>如果实例即包含Linux实例又包含Windows实例，则密码复杂度限制按照Windows实例的限制。 |
| UserName | 否 | 否 | String | 待重置密码的实例操作系统用户名。不得超过64个字符。 |
| ForceStop | 否 | 否 | Bool | 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再重置用户密码。取值范围：<br><li>TRUE：表示在正常关机失败后进行强制关机<br><li>FALSE：表示在正常关机失败后不进行强制关机<br><br>默认取值：FALSE。<br><br>强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 此参数对外不可见。 任务Id |
| FlowId | Int64 | 此参数对外不可见。 任务流转Id |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidInstanceId.NotFound | |
| InvalidInstance.NotSupported | |
| InvalidParameterValue | |
| InternalServerError | |
| InvalidParameterValue.LimitExceeded | |
| InvalidParameterValue.TooLong | |
| InvalidInstanceId.Malformed | |
| MissingParameter | |
| InvalidPassword |