WebsiteDoc CenterSign Up

ResetInstancePassword

1. API Description

This API is used to reset the instance login password.

Note

  • For Windows systems, the default reset applies to the Administrator password; for Linux systems, it applies to the root password.

  • The instance must have QGA installed and be in a powered-on state.

  • The operation may fail; refer to the API response for details.

  • Batch operations are supported. The maximum number of instances in each request is 100.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

instanceId

Yes

String

Instance ID(s).

To obtain the instance ID, you can call DescribeInstances and look for instanceId in the response.

password

Yes

String

Instance password.

The parameter must be 8-16 characters, including:

  • lowercase letters: [a-z]

  • uppercase letters: [A-Z]

  • digits: 0-9

  • special 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. Code Example

Reset the instance login password.

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

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

HTTP Status Code
Error Code
Description

404

INVALID_INSTANCE_NOT_FOUND

Image does not exist.

403

OPERATION_DENIED_INSTANCE_NOT_RUNNING

The instance must be in a powered-on state.

Last updated