当前位置:主页 > 查看内容

云服务器 重置实例密码 - API 文档

发布时间:2021-05-06 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: cvm.tencentcloudapi.com 。 本接口 (ResetInstancesPassword) 用于将实例操作系统的密码重置为用户指定的密码。 *如果是修改系统管理云密码:实例的操作系统不同,管理员帐号也会不一样( Windows 为 Administrator , Ubuntu 为……

1. 接口描述

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

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

*如果是修改系统管理云密码:实例的操作系统不同,管理员帐号也会不一样(WindowsAdministratorUbuntuubuntu,其它系统为root)。

  • 重置处于运行中状态的实例密码,需要设置关机参数ForceStopTRUE。如果没有显式指定强制关机参数,则只有处于关机状态的实例才允许执行重置密码操作。
  • 支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为100。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResetInstancesPassword。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表。
InstanceIds.N Array of String 一个或多个待操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。每次请求允许操作的实例数量上限是100。
Password String 实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下:
Linux实例密码必须8-30位,推荐使用12位以上密码,不能以“/”开头,至少包含以下字符中的三种不同字符,字符种类:
  • 小写字母:[a-z]
  • 大写字母:[A-Z]
  • 数字:0-9
  • 特殊字符: ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
    Windows实例密码必须12~30位,不能以“/”开头且不包括用户名,至少包含以下字符中的三种不同字符
  • 小写字母:[a-z]
  • 大写字母:[A-Z]
  • 数字: 0-9
  • 特殊字符:()`~!@#$%^&*-+=_|{}[]:;' <>,.?/
  • 如果实例即包含Linux实例又包含Windows实例,则密码复杂度限制按照Windows实例的限制。
  • UserName String 待重置密码的实例操作系统的用户名。不得超过64个字符。
    ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再重置用户密码。取值范围:
  • TRUE:表示在正常关机失败后进行强制关机
  • FALSE:表示在正常关机失败后不进行强制关机

    默认取值:FALSE。

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

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

    4. 示例

    示例1 重置一个Linux/Windows实例的密码

    重置一个Linux/Windows实例的密码,之后您可利用此密码登录实例

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ResetInstancesPassword
    &InstanceIds.0=ins-r8hr2upy
    &InstanceIds.1=ins-5d8a23rs
    &Password=abc123ABC!@#
    &ForceStop=TRUE
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    • Tencent Cloud SDK 3.0 for Python
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.TooLong 无效参数值。参数值太长。
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    MissingParameter 缺少参数错误。
    MutexOperation.TaskRunning 同样的任务正在运行。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    UnauthorizedOperation.MFAExpired 您无法进行当前操作,请确认多因子认证(MFA)是否失效。
    UnauthorizedOperation.MFANotFound 没有权限进行此操作,请确认是否存在多因子认证(MFA)。
    UnsupportedOperation.InstanceStateExitRescueMode 请求不支持正在退出救援模式的实例
    UnsupportedOperation.InstanceStateIsolating 请求不支持正在隔离状态的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
    UnsupportedOperation.InstanceStateRunning 请求不支持开机状态的实例
    UnsupportedOperation.InstanceStateServiceLiveMigrate 不支持正在服务迁移的实例,请稍后再试
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐