操作指南

API 文档

重置实例密码

最近更新时间:2022-06-14 06:13:38

我的收藏

1. 接口描述

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

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

  • 只修改管理员帐号的密码。实例的操作系统不同,管理员帐号也会不一样(Windows 为 Administrator,Ubuntu 为 ubuntu ,其它系统为 root)。
  • 支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为 100。
  • 建议对运行中的实例先手动关机,然后再进行密码重置。如实例处于运行中状态,本接口操作过程中会对实例进行关机操作,尝试正常关机失败后进行强制关机。
  • 本接口为异步接口,请求发送成功后会返回一个 RequestId,此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
    注意:强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstancesPassword。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例 ID 列表。每次请求批量实例的上限为 100。
Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
LINUX_UNIX 实例密码必须 8-30 位,推荐使用 12 位以上密码,不能以“/”开头,至少包含以下字符中的三种不同字符,字符种类:
  • 小写字母:[a-z]
  • 大写字母:[A-Z]
  • 数字:0-9
  • 特殊字符: ()`!@#$%^&*-+=_|{}[]:;'<>,.?/

  • WINDOWS 实例密码必须 12-30 位,不能以“/”开头且不包括用户名,至少包含以下字符中的三种不同字符
  • 小写字母:[a-z]
  • 大写字母:[A-Z]
  • 数字: 0-9
  • 特殊字符:()`!@#$%^&*-+=_|{}[]:;' <>,.?/
  • 如果实例即包含 LINUX_UNIX 实例又包含 WINDOWS 实例,则密码复杂度限制按照 WINDOWS 实例的限制。
  • UserName String 待重置密码的实例操作系统用户名。不得超过 64 个字符。

    3. 输出参数

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

    4. 示例

    示例1 重置一个实例的密码

    重置一个实例的密码,之后可利用此密码登录实例。示例中的 Password 需要根据实际情况进行设置。

    输入示例

    https://lighthouse.tencentcloudapi.com/?Action=ResetInstancesPassword
    &InstanceIds.0=lhins-ruy9d2tw
    &Password=xxxxxxxxxxx
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "0e194541-9937-471e-beaa-957a84dcf9d0"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.InstanceOperationFailed 对实例的操作失败。
    InternalError.DescribeInstanceStatus 查询实例状态失败,请稍后重试。
    InternalError.InvalidCommandNotFound 命令 DescribeInstanceLoginKeyPair 无法找到。
    InvalidParameterValue.Duplicated 参数值非法,不允许包含重复的值。
    InvalidParameterValue.InstanceIdMalformed 参数值非法,实例 ID 格式非法。
    InvalidParameterValue.InvalidPassword 参数中的密码不合法。
    InvalidParameterValue.LimitExceeded 参数值非法,参数值的数量超过最大限制。
    InvalidParameterValue.NotAllowToChangePlatformType 不允许改变平台类型。
    InvalidParameterValue.OutOfRange 参数值非法,不在合法范围内。
    OperationDenied.InstanceCreating 禁止对实例进行操作,实例在创建中,不允许进行该操作。
    OperationDenied.InstanceOperationInProgress 禁止对实例进行操作,实例最近一次的操作尚在进行中。
    ResourceNotFound.InstanceIdNotFound 实例 ID 不存在。
    ResourceNotFound.InstanceNotFound 实例不存在。
    UnauthorizedOperation.NoPermission 无权限。
    UnsupportedOperation.InvalidInstanceState 不支持的操作,实例状态不合法。
    UnsupportedOperation.LatestOperationUnfinished 不支持的操作,实例最近一次的操作尚未完成。
    目录