Help Center/ Elastic Cloud Server/ API Reference/ APIs (Recommended)/ Status Management/ Changing an ECS OS (Using an Image Without Cloud-Init Installed)
Updated on 2022-09-26 GMT+08:00
View PDF

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

Function

This API is used to change the OS of an ECS.

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

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

Constraints

  • Only an ECS with a system disk supports changing OS.
  • You are not allowed to perform other operations when changing the OS. Otherwise, changing the OS will fail.

URI

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

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-change

Yes

Object

Changes the OS of an ECS. For details, see Table 3.
Table 3 os-change field description

Parameter

Mandatory

Type

Description

adminpass

No

String

Specifies the initial password of the ECS administrator.

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:
  • Either adminpass or keyname is empty.
  • Either adminpass or keyname is set.

keyname

No

String

Specifies the key name.

Keys can be created using the key creating API (Creating and Importing an SSH Key Pair) or obtained using the SSH key query API (Querying SSH Key Pairs).

userid

No

String

Specifies the user ID. When the keyname parameter is being specified, the value of this parameter is used preferentially. If this parameter is left blank, the user ID in the token is used by default.

imageid

Yes

String

Specifies the ID of the new image in UUID format.

You can obtain the image ID from the console or by following the instructions provided in "Querying Images" in Image Management Service API Reference.

mode

No

String

Specifies whether the ECS supports OS change when the ECS is running.

If the parameter value is withStopServer, the ECS supports OS change when the ECS is running. In such a case, the system automatically stops the ECS before changing its OS.

Response

For details, see Responses (Task).

Example Request

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/changeos
{
    "os-change": {
        "keyname": "KeyPair-350b", 
        "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
        "imageid": "e215580f-73ad-429d-b6f2-5433947433b0"
    }
}

Example Response

See Responses (Task).

{      
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" 
}

Returned Values

See Returned Values for General Requests.

Error Codes

See Error Codes.

Parent topic: Status Management