Updated on 2026-09-10 GMT+08:00

Obtaining the Password for Logging In to an ECS

Function

This API is used to obtain the random password generated for user Administrator or the user configured in Cloudbase-Init when you use a Cloudbase-Init-enabled image to create a Windows ECS. For more information, see Cloud-init/Cloudbase-init.

Constraints

For a Windows ECS, the login mode must be key pair.
After starting an ECS, wait for 5 to 10 minutes to ensure that password injection is complete before this API can be used to query the password.
Linux ECS passwords cannot be obtained using this API.

URI

GET /v1/{project_id}/cloudservers/{server_id}/os-server-password

Table 1 lists the URI parameters.

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
server_id	Yes	Definition Specifies the ECS ID. Constraints N/A Range N/A Default Value N/A

Request

None

Response

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Description
password	String	Definition Specifies the password in ciphertext. Range N/A

Example Request

Obtain a random password of the initial administrator account (administrator or the account configured in Cloudbase-Init) of a specified Windows ECS.

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-server-password

Example Response

{
    "password": "UHC9+YW1xDC1Yu8M*****************************"
}

Returned Values

See Returned Values for General Requests.

Parent topic: Password Management