ResetInstancesPassword

1. API Description

This API is used to reset instance login password.

Note

• For Windows operating system, call this API to reset Administrator password; for Linux operating system, call this API to reset root password.

• Shut down the instance before resetting the password. After the password is reset, the instance will be automatically restarted.

• 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
instanceIds	Yes	Array of String	Instance ID(s). The maximum number of instances in each request is 100.
password	Yes	String	Instance login 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

Example

Reset login password of instances.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ResetInstancesPassword
<Common Request Params>

Request:
{
  "instanceIds": ["instanceId1", "instanceId2"],
  "password": "Example`123"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
}

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.
400	OPERATION_DENIED_INSTANCE_NOT_STOPPED	Operations on unstopped instances not supported.