Reinstalling an ECS OS (Using an Image with Cloud-Init Installed)¶
Function¶
This API is used to reinstall an ECS OS. During the system disk reinstallation using the original image, the data disks of the ECS remain unchanged.
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.
Constraints¶
You can only use an image with Cloud-Init or Cloudbase-Init installed.
You can reinstall OS only on an ECS that is stopped or for which OS reinstallation has failed.
You are not allowed to reinstall the OS of 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 /v2/{project_id}/cloudservers/{server_id}/reinstallos
Table 1 describes the parameters in the URI.
Parameter | Mandatory | Description |
---|---|---|
project_id | Yes | Specifies the project ID. |
server_id | Yes | Specifies the ECS ID. |
Request¶
Table 2 describes the request parameters.
Parameter | Mandatory | Type | Description |
---|---|---|---|
os-reinstall | Yes | Object | Reinstalls an ECS OS. For details, see Table 3. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
keyname | Yes | String | Specifies the key pair name. |
userid | Yes | String | Specifies the user ID. This parameter is mandatory when keyname is used. |
metadata | No | Object | Specifies metadata of the reinstalled ECS. For more information, see Table 4. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
BYOL | No | String | Specifies whether a user has the license of an image.
The default value is not true, indicating that BYOL is not used. |
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
For more details, see "Injecting User Data into ECSs" in the Elastic Cloud Server User Guide. Examples Before base64 encoding:
After base64 encoding:
|
__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 through HTTPS requests, see "Querying the List of CMKs" in Key Management Service API Reference. |
Response¶
See Responses (Task).
Example Request¶
After the ECS OS is reinstalled, 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}/reinstallos { "os-reinstall": { "userid": "7e25b1da389f4697a79df3a0e5bd494e", "mode": "withStopServer" } }
Reinstall an OS and use the key pair for login authentication after the reinstallation.
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/reinstallos { "os-reinstall": { "keyname": "KeyPair-350b", "userid": "7e25b1da389f4697a79df3a0e5bd494e" } }
If the ECS OS is reinstalled 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}/reinstallos { "os-reinstall": { "userid": "7e25b1da389f4697a79df3a0e5bd494e", "metadata": { "__system__encrypted": "1", "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846" } } }
Example Response¶
See Responses (Task).
{
"job_id": "ff80808288d41e1b018990260955686a"
}
Returned Values¶
Error Codes¶
See Error Codes.