API 文档

重置实例密码

最近更新时间:2020-09-02 08:00:52

1. 接口描述

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

重置处于运行中状态的实例的密码,需要显式指定强制关机参数ForceStop。如果没有显式指定强制关机参数,则只有处于关机状态的实例才允许执行重置密码操作。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstancesPassword。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
InstanceIdSet.N Array of String 待重置密码的实例ID列表。在单次请求的过程中,单个region下的请求实例数上限为100。
Password String 新密码,Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9]和[( ) ~ ~ ! @ # $ % ^ & - + = _ | { } [ ] : ; ' < > , . ? /]中的符号。密码不允许以/符号开头。
Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9]和[( ) ~ ~ ! @ # $ % ^ &
- + = _ | { } [ ] : ; ' < > , . ? /]中的符号。密码不允许以/符号开头。
如果实例即包含Linux实例又包含Windows实例,则密码复杂度限制按照Windows实例的限制。
ForceStop Boolean 是否强制关机,默认为false。
UserName String 待重置密码的实例的用户名,不得超过64个字符。若未指定用户名,则对于Linux而言,默认重置root用户的密码,对于Windows而言,默认重置administrator的密码。

3. 输出参数

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

4. 示例

示例1 重置实例密码

重置实例密码

输入示例

https://ecm.tencentcloudapi.com/?Action=ResetInstancesPassword
&InstanceIdSet.0=ein-356531dd
&InstanceIdSet.1=ein-583021kl
&ForceStop=false
&UserName=root
&Password=cptbtptpA@1095
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "2b719fb1-2f5f-4a2c-bd52-a80b7ca7984c"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InstanceNotAllStopped 实例没有全部关机。
FailedOperation.InstanceOwnerCheckFailed 实例不属于当前模块。
FailedOperation.InternalOperationFailure 内部操作错误。
FailedOperation.OperationNotAllow 不允许执行当前操作。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue.InvaildModifyParam 参数错误。
InvalidParameterValue.InvaildPassword 密码不合法。
InvalidParameterValue.InvalidInstanceID 实例ID不合法。
InvalidParameterValue.ParameterValueTooLarge 参数值超出限制。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
目录