tencent cloud

Feedback

ResetInstancesPassword

Last updated: 2022-09-26 17:00:19

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ResetInstancesPassword.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String Instance ID list. Each request can contain up to 100 instances at a time.
Password Yes String Login password of the instance(s). The password requirements vary among different operating systems:
The password of a LINUX_UNIX instance must contain 8–30 characters (above 12 characters preferably) in at least three of the following types and cannot begin with "/":
  • Lowercase letters: [a–z]
  • Uppercase letters: [A–Z]
  • Digits: 0–9
  • Special symbols: ()`!@#$%^&*-+=_|{}[]:;'<>,.?/

  • The password of a WINDOWS instance must contain 12–30 characters in at least three of the following types and cannot begin with "/" or include the username:
  • Lowercase letters: [a–z]
  • Uppercase letters: [A–Z]
  • Digits: 0–9
  • Special symbols: ()`!@#$%^&*-+=_|{}[]:;' <>,.?/
  • If both LINUX_UNIX and WINDOWS instances exist, the requirements for password complexity of WINDOWS instances shall prevail.
  • UserName No String OS username of the instance for which you want to reset the password, which can contain up to 64 characters.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    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.

    Command Line Interface

    6. Error Code

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

    Error Code Description
    FailedOperation.InstanceOperationFailed Failed to manipulate the instance.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InternalError.InvalidCommandNotFound The command DescribeInstanceLoginKeyPair could not be found.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.InvalidPassword The password in the parameter is invalid.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.NotAllowToChangePlatformType It is not allowed to change the OS type.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
    OperationDenied.InstanceOperationInProgress It is not allowed to manipulate this instance, as the last operation is still in progress.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support