ResetInstancesPassword

Last Updated At: 2026-08-03 00:05:04

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (ResetInstancesPassword) is used to reset the password of an instance operating system to a user-specified password.

Only the password of the administrator account is modified. The administrator account varies with different instance operating systems (Windows: Administrator, Ubuntu: ubuntu, other systems: root).
To reset the password of an instance in the running state, you need to explicitly specify the forced stop parameter ForceStop. If you do not explicitly specify the forced stop parameter, only instances in the stop state are allowed to reset the password.
Batch operations are supported. Set the passwords of multiple instance operating systems as the same password. A maximum of 100 batch instances per request are allowed.

Default interface request rate limit: 10 times per second.

Interface update time: 2022-10-28 03:42:15.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name	Required	Allow NULL	Type	Description
Action	Yes	No	String	Public parameter, The value of this interface: ResetInstancesPassword
Version	Yes	No	String	Public parameter, The value of this interface: 2017-03-12
Region	No	No	String	Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
InstanceIds	Yes	No	Array of String	One or more instance IDs to be operated. You can obtain the instance ID through the `InstanceId` in the returned value from the API DescribeInstances. A maximum of 100 batch instances per request are allowed. Example: ["ins-r8hr2upy","ins-5d8a23rs"]
Password	Yes	No	String	Instance login password. The password complexity requirements vary by different operating system types, as follows: The password of a Linux instance should contain 8 to 16 characters, including at least two of `[a-z, A-Z], [0-9]`, and symbols `[( ) ~ ! @ # $ % ^ & * - + = _
UserName	No	No	String	Username of the instance operating system whose password is to be reset. It should not exceed 64 characters. Example: asdc21
ForceStop	No	No	Bool	Whether to perform forced shutdown on the running instance. It is recommended to perform manual shutdown on the running instance first, and then reset the user password. Value Range: TRUE: Indicates forced shutdown performed after normal shutdown fails. FALSE: Indicates no forced shutdown performed after normal shutdown fails. Default value: FALSE. The effect of forced stop is equivalent to turning off the switch of the physical computer. Forced stop may lead to data loss or damage of the file system. Use it only when the server cannot be normally stopped. Example: true

3. Output Parameters

Parameter name	Type	Description
TaskId	String	Task ID Example: 435323
flowId	Int64	Task Flow ID Example: 4
RequestId	String	Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code	Description
InvalidInstanceId.NotFound	No corresponding instance was found.
InvalidInstance.NotSupported	Unsupported instance.
InvalidParameterValue	Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.
InternalServerError	Internal operation error.
InvalidParameterValue.LimitExceeded	The parameter value is out of range
InvalidParameterValue.TooLong	Invalid input: Excessive length of the parameter.
InvalidInstanceId.Malformed	Invalid Instance ID. The format of the specified instance ID is incorrect, for example, an instance ID length error `ins-1122`.
MissingParameter	Parameters are missing. The request did not include mandatory parameters.
InvalidPassword	Invalid password. The specified password does not meet password complexity restrictions. For example, the password length does not meet restrictions.