tencent cloud



Last updated: 2023-08-18 14:28:07

1. API Description

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

This API is used to reset the password for a running status. You need to explicitly specify the ForceStop parameter; otherwise, you can reset the password only for instances that have been shut down.

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: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
InstanceIdSet.N Yes Array of String List of IDs of the instances for which to set the password. You can request up to 100 instances in a region at a time.
Password Yes String New password. The password of a Linux instance must contain 8–16 characters in at least two of the following character types: letters, digits, and special symbols [( ) ~ ~ ! @ # $ % ^ & * - + = _ | { } [ ] : ; ' < > , . ? /] and cannot start with /.
The password of a Windows instance must contain 12–16 characters in at least three of the following character types: letters, digits, and special symbols [( ) ~ ~ ! @ # $ % ^ & * - + = _ | { } [ ] : ; ' < > , . ? /] and cannot start with /.
If the instances include both Linux instances and Windows instances, the password complexity limit for Windows instances will apply.
ForceStop No Boolean Whether to force shut down. Default value: false.
UserName No String Username of the instance for which to reset the password, which can contain up to 64 characters. If this parameter is not specified, the password of the root user will be reset by default for Linux, and the password of the admin will be reset by default for Windows.

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.

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "RequestId": "2b719fb1-2f5f-4a2c-bd52-a80b7ca7984c"

5. Developer Resources


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.InstanceNotAllStopped Not all instances are shut down.
FailedOperation.InstanceOwnerCheckFailed The instance does not belong to the current module.
FailedOperation.InternalOperationFailure Internal error.
FailedOperation.OperationNotAllow The current operation is not allowed.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvaildModifyParam The parameter is incorrect.
InvalidParameterValue.InvaildPassword The password is invalid.
InvalidParameterValue.InvalidInstanceID The instance ID is invalid.
InvalidParameterValue.ParameterValueTooLarge The parameter value exceeds the limit.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
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