Documentation|Tencent Cloud

Recent Pages

Documentation

ResetInstancesPassword

Last updated: 2020-07-17 16:32:58

1. API Description

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

This API is used to reset the password of the operating system instances to a user-specified password.

To modify the password of the administrator account: the name of the administrator account varies with the operating system. In Windows, it is Administrator; in Ubuntu, it is ubuntu; in Linux, it is root.
To reset the password of a running instance, you need to set the parameter ForceStop to True for a forced shutdown. If not, only passwords of stopped instances can be reset.
Batch operations are supported. You can reset the passwords of up to 100 instances to the same value once.
You can call the DescribeInstances API and find the result of the operation in the response parameter LatestOperationState. If the value is SUCCESS, the operation is successful.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ResetInstancesPassword.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceIds.N	Yes	Array of String	Instance ID(s). To obtain the instance IDs, you can call `DescribeInstances` and look for `InstanceId` in the response. The maximum number of instances in each request is 100.
Password	Yes	String	Login password of the instance. The rule of password complexity varies with operating systems: For a Linux instance, the password must be 8 to 30 characters in length; password with more than 12 characters is recommended. It cannot begin with "/", and must contain at least three types of the following: Lowercase letters: [a-z] Uppercase letters: [A-Z] Numbers: 0-9 Special characters: ()`!@#$%^&-+=_\|{}[]:;'<>,.?/ For a Windows CVM, the password must be 12 to 30 characters in length. It cannot begin with "/" or contain your username. It must contain at least three types of the following: Lowercase letters: [a-z] Uppercase letters: [A-Z] Numbers: 0-9 Special characters: ()`!@#$%^&-+=_\|{}[]:;' <>,.?/ If the specified instances include both `Linux` and `Windows` instances, you need to follow the password requirements for `Windows` instances.
UserName	No	String	Username of the instance operating system for which the password needs to be reset. This parameter is limited to 64 characters.
ForceStop	No	Boolean	Whether to force shut down a running instances. It is recommended to manually shut down a running instance before resetting the user password. Valid values: TRUE: force shut down an instance after a normal shutdown fails. FALSE: do not force shut down an instance after a normal shutdown fails. Default value: FALSE. A forced shutdown is similar to switching off the power of a physical computer. It may cause data loss or file system corruption. Be sure to only force shut down a CVM when it cannot be shut down normally.

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 the password of a Linux/Windows instance

This example shows you how to reset the password of a Linux/Windows instance, and then use the new password to log in to the instance.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=ResetInstancesPassword
&InstanceIds.0=ins-r8hr2upy
&InstanceIds.1=ins-5d8a23rs
&Password=abc123ABC!@#
&ForceStop=TRUE
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

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

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.

Error Code	Description
InternalServerError	Internal error.
InvalidInstance.NotSupported	This instance is not supported.
InvalidInstanceId.Malformed	Invalid instance `ID`. The specified instance `ID` has an invalid format. For example, `ins-1122` has an invalid `ID` length.
InvalidInstanceId.NotFound	No instance found.
InvalidParameterValue	Invalid parameter value: parameter value is in the wrong format or is not supported.
InvalidParameterValue.LimitExceeded	The number of parameter values exceeds the limit.
InvalidParameterValue.TooLong	Invalid parameter value: parameter value is too long.
InvalidPassword	Invalid password. The specified password does not meet the password requirements. For example, the password length does not meet the requirements.
MissingParameter	Missing parameter: a required parameter is missing.