tencent cloud

1. API Description

Domain name for API request: lighthouse.tencentcloudapi.com.

This API is used to reset the password of the instance OS to a user-specified password.

• You can only use this API to modify the password of the admin account. The name of the admin account varies by OS (on Windows, it is Administrator; on Ubuntu, it is ubuntu; on other systems, it is root).
• Batch operations are supported. You can reset the passwords of multiple instances to the same one. The maximum number of instances in each request is 100.
• It’s recommended to shut down the instance first and then reset the password. If the instance is running, this API will try to shut it down normally. If the attempt fails, it will force to instance to shut down.
• This API is async. After the request is sent successfully, a RequestId will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the DescribeInstances API. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.
  Note: Just like powering off a physical PC, a forced shutdown may cause data loss or the corruption of file system.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Resetting instance password

This example shows you how to reset the password of an instance, and then you can use this password to log in to the instance. You need to set the password in the example as needed.

Input Example

https://lighthouse.tencentcloudapi.com/?Action=ResetInstancesPassword
&InstanceIds.0=lhins-ruy9d2tw
&Password=xxxxxxxxxxx
&<Common request parameters>

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• 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 Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.