Help Center/ Elastic Cloud Server/ API Reference (Kuala Lumpur Region)/ APIs (Recommended)/ Status Management/ Reinstalling an ECS OS (Using an Image Without Cloud-Init Installed)
Updated on 2024-04-18 GMT+08:00
View PDF
Share

Reinstalling an ECS OS (Using an Image Without Cloud-Init Installed)

Function

This API is used to reinstall an ECS OS.

This API is an asynchronous API. After the OS reinstallation request is successfully delivered, a job ID is returned. This does not mean the reinstallation is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the reinstallation is successful.

After this API is called, the system uninstalls the system disk, uses the original image to create a system disk, and attaches it to the ECS. In this way, the OS is reinstalled.

This API supports the images without Cloud-Init or Cloudbase-Init installed. Otherwise, use the API described in Reinstalling an ECS OS (Using an Image with Cloud-Init Installed).

Constraints

  • You can reinstall OS only on an ECS that is stopped or for which OS reinstallation has failed.
  • You cannot reinstall OS on an ECS that does not have the system disk.
  • You are not allowed to perform other operations when reinstalling the OS. Otherwise, reinstalling the OS will fail.

URI

POST /v1/{project_id}/cloudservers/{server_id}/reinstallos

Table 1 describes the parameters in the URI.
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

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

os-reinstall

Yes

Object

Reinstall the ECS. For details, see Table 3.
Table 3 os-reinstall field description

Parameter

Mandatory

Type

Description

adminpass

No

String

Specifies the initial password of the ECS administrator.

The Windows administrator username is Administrator, and the Linux administrator username is root.

Password complexity requirements:

  • 8 to 26 characters
  • The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*).
NOTE:
  • You can only log in to a Windows ECS using a username and password, and the password cannot contain the username, the username in reverse, or more than two characters in the same sequence as they appear in the username.
  • Either adminpass or keyname is empty.
  • Either adminpass or keyname is set.

keyname

No

String

Specifies the key name.

userid

No

String

Specifies the user ID.

Response

For details, see Responses (Task).

Example Request

Reinstall an OS and use the key pair for login authentication after the reinstallation.

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/reinstallos

{
    "os-reinstall": {
        "keyname": "KeyPair-350b", 
        "userid": "7e25b1da389f4697a79df3a0e5bd494e"
    }
}

Example Response

See Responses (Task).

{      
    "job_id": "ff80808288d41e1b018990260955686a" 
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Status Management