Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> Batch Operations> Resetting the Passwords for Logging In to ECSs in a Batch
View PDF

Resetting the Passwords for Logging In to ECSs in a Batch

Function

This API is used to reset the passwords of the ECS management account, root or Administrator, in a batch.

Constraints

  • Before using this API, you must install password reset plug-ins. For instructions about how to download and install the password reset plug-ins, see Installing One-Click Password Reset Plug-ins in Elastic Cloud Server User Guide.
  • After the request for resetting the password is issued, this API does not report an error if executing the script failed.
  • A new password takes effect after the ECS is started or restarted.
  • This API allows you to reset passwords when the target ECSs are running or stopped.

URI

PUT /v1/{project_id}/cloudservers/os-reset-passwords

Table 1 lists the URI parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the ID, see Obtaining a Project ID.

Request

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Type

Mandatory

Description

new_password

String

Yes

Specifies the new password.

This field is mandatory only if dry_run is set to false.

A new password must comply with the following rules:
  • Consists of 8 to 26 characters.
  • Supports the following characters: !@%-_=+[]:./?
  • Cannot contain any of the following characters: Chinese characters and ~`#&^,{}*();"'<>|\$
  • Contains at least three of the following: uppercase letters, lowercase letters, digits, and allowed special characters.
  • Cannot contain username Administrator/root or the username spelled backwards.
  • Cannot contain three consecutive characters in username Administrator

dry_run

Boolean

No

Specifies whether to check the request and reset ECS passwords.

  • true: indicates that only the password reset request is sent and the passwords for logging in to the ECSs will not be reset. Check items include mandatory parameters, request format, and service restrictions. If the check fails, the system returns an error. If the check result is as expected, the system properly responds.
  • false: indicates that only the password reset request is sent and the passwords for logging in to the ECSs will be reset if the check result is as expected.

The default value is false.

servers

Array of objects

Yes

Specifies the IDs of the target ECSs. For details, see Table 3.
Table 3 servers field description

Parameter

Type

Mandatory

Description

id

String

Yes

Specifies the ECS ID.

Response

See Responses (Batch Operation).

Example Request

PUT https://{endpoint}/v1/{project_id}/cloudservers/os-reset-passwords
{
    "new_password": "Test@123",
    "dry_run": true,
    "servers": [
                {
                  "id":"1bd0eb17-4466-4c15-a9ce-87727ad311b5"  
                },
                {
                  "id":"fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2" 
                }
               ]
}

Example Response

See Responses (Batch Operation).

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Code Description.

Parent topic: Batch Operations