Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> Status Management> Changing an ECS OS (Using an Image Without Cloud-Init Installed)
Updated on 2024-04-15 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.

This API is an asynchronous API. After the OS change request is successfully delivered, a job ID is returned. This does not mean the OS change 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 OS change is successful.

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).

Huawei Cloud no longer provides Windows images. This API cannot be used to change an ECS OS to Windows.

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

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.

isAutoPay

No

String

Specifies whether the order is automatically paid.

  • true: The order will be automatically paid.
  • false: The order must be manually paid.
NOTE:

This parameter is used when the fees of a yearly/monthly ECS are changed. If this parameter is not specified, the order must be manually paid by default.

metadata

No

Object

Specifies the metadata of the ECS for which the OS is to be changed.

For more information, see Table 4.

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.
Table 4 metadata field description

Parameter

Mandatory

Type

Description

BYOL

No

String
If you have an OS or a software license (a license certified based on the number of physical servers and cores), you can migrate your services to the cloud platform using bring your own license (BYOL) model to continue using your existing licenses.
  • true: Use your existing licenses.
  • Other values are invalid and an error will be reported.

__system__encrypted

No

String

Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled).

If this parameter does not exist, the system disk will not be encrypted by default.

__system__cmkid

No

String

Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.

NOTE:

For details about how to obtain the CMK ID, see Querying the List of CMKs.

Response

For details, see Responses (Task).

Example Request

Change the OS and use the key pair for login authentication after the OS change.

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

{
    "os-change": {
        "keyname": "KeyPair-350b", 
        "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
        "imageid": "e215580f-73ad-429d-b6f2-5433947433b0",
        "metadata": {
              "__system__encrypted": "1",
              "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846"
        },
    }
}

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