doc-exports/docs/ecs/api-ref/en-us_topic_0031176553.html
Huijuan, Wang 7d71165909 ecs api 20240912
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Huijuan, Wang <wanghuijuan738@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-10-24 12:45:08 +00:00

6.6 KiB

Obtaining the Password of an ECS

Function

This API is used to obtain the random password generated during initial Windows ECS installation for user Administrator or the configured Cloudbase-init user when you use an image that supports Cloudbase-Init to create a Windows ECS.

After starting an ECS, wait for 5 to 10 minutes and ensure that the password is injected. Then, you can use this API to query the password.

Linux ECSs do not use this API to obtain a password.

URI

GET /v2.1/{project_id}/servers/{server_id}/os-server-password

GET /v2/{project_id}/servers/{server_id}/os-server-password

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the 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

Specifies the password in ciphertext.

Example Request

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

GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-server-password

Example Response

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