Help Center> Elastic Cloud Server> API Reference> APIs (Recommended)> Status Management> Changing an ECS OS (Using an Image with Cloud-Init Installed)
Updated on 2024-04-15 GMT+08:00
View PDF

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

Function

This API is used to change an ECS OS. During the system disk reinstallation using a new image, the data disks of the ECS remain unchanged.

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.

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

Constraints

  • You can only use an image with Cloud-Init or Cloudbase-Init installed. If the image has no Cloudbase-Init or Cloudbase-init installed, use the API described in Changing an ECS OS (Using an Image Without Cloud-Init Installed).
  • 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 /v2/{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 an ECS OS. 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.

The password must meet the following 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:
  • The Windows ECS password cannot contain the username, the username in reverse, or more than two characters in the same sequence as they appear in the username.
  • Linux ECSs can use user_data to inject passwords. In such a case, adminpass is unavailable.
  • Specify either adminpass or keyname, not both of them.
  • If both adminpass and keyname are empty, Linux ECSs can use user_data specified in metadata.
  • adminpass, keyname, and the user_data in metadata can be empty only when a private image password is used or when a password is set after the OS is reinstalled. Additionally, the following requirements must be met:

    Windows OSs do not support private image passwords.

    If you need to set the password after the OS change, ensure that the __os_feature_list field of the image contains {"onekey_resetpasswd": "true"}. Reset the ECS password after the OS change.

  • If you use this field to change the OS of an ECS with Cloud-Init installed, the region in which the ECS is deployed does not support password-authenticated OS changing. In such a case, use key pair authentication.

keyname

No

String

Specifies the key pair 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 or manually paid.

  • true: The order will be automatically paid.
  • false: You must manually pay the order.
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 this feature. The system automatically stops the ECS and then changes 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.

user_data

No

String

Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected.

NOTE:
  • The content of user_data must be encoded with base64.
  • The maximum size of the content to be injected (before encoding) is 32 KB.

For more details, see Injecting User Data into ECSs.

Examples

Before base64 encoding:

  • Linux
    #!/bin/bash
echo user_test > /home/user.txt
  • Windows
    rem cmd
echo 111 > c:\aaa.txt

After base64 encoding:

  • Linux
    IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==
  • Windows
    cmVtIGNtZAplY2hvIDExMSA+IGM6XGFhYS50eHQ=

__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

See Responses (Task).

Example Request

  • After the ECS OS is switched, use the password for login authentication. For security purposes, store the password in ciphertext in configuration files or environment variables.
    POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos

{
    "os-change": {
        "adminpass": "$ADMIN_PASS",
        "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
        "imageid": "e215580f-73ad-429d-b6f2-5433947433b0",
        "mode": "withStopServer"
    }
}
  • Change the OS and use the key pair for login authentication after the OS change.
    POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos

{
    "os-change": {
        "keyname": "KeyPair-350b", 
        "userid": "7e25b1da389f4697a79df3a0e5bd494e", 
        "imageid": "e215580f-73ad-429d-b6f2-5433947433b0"
    }
}
  • If the ECS OS is switched using encrypted full-ECS images of the system disk, use the password for login authentication. For security purposes, store the password in ciphertext in configuration files or environment variables.
    POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos

{
    "os-change": {
        "adminpass": "$ADMIN_PASS",
        "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