Help Center/ Elastic Cloud Server/ API Reference/ APIs/ Password Management/ Obtaining the Password for Logging In to an ECS
Updated on 2025-12-10 GMT+08:00
View PDF
Share

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.

Linux ECSs do not support this API.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permissions listed below are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ecs:cloudServers:showServerPassword

read

instance *

-

ecs:cloudServers:get

-

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

Specifies the project ID.

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

server_id

Yes

Specifies the ECS ID.

Request

None

Response

Table 2 describes the response parameters.
Table 2 Response parameters

Parameter

Type

Description

password

String

Definition

Specifies the password in ciphertext.

Constraints

N/A

Range

N/A

Default Value

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