Help Center/ Cloud Data Center / API Reference/ API/ iMetal Instance Management/ Batch Reinstalling OSs
Updated on 2025-12-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Batch Reinstalling OSs

Function

This API is used to reinstall an OS using a new OS image. This API asynchronous. You can query the instance status by calling the ShowInstanceStatus API. If the status changes to pending, the OS is being reinstalled. If the status changes to running, the OS reinstallation is complete.

Prerequisites: The instance is in the running state.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/instances/reinstall

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID.

Constraints

N/A

Range

Project ID of the account.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

image_id

No

String

Definition

Image ID, which is the ID of the private image created in IMS. You can view the ID on the CloudDC console or query the ID using the IMS API. This parameter is optional. If this parameter is not specified, the current image ID is used by default.

Constraints

N/A

Range

N/A

Default Value

An empty string. The current image ID is used by default.

password

Yes

String

Definition

Initial login password of the administrator account. For Linux, the administrator is root. For Windows, the administrator is Administrator.

Constraints

N/A

Range

8 to 26 characters

The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?

The password cannot contain the username or the username spelled backwards.

Default Value

N/A

instance_id_set

No

Array of strings

Definition

The list of instance IDs.

Constraints

An instance ID list can contain a maximum of 50 IDs.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

instances

Array of instances objects

Definition

Returned instance information.

Constraints

N/A
Table 5 instances

Parameter

Type

Description

id

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Status code: 429

Table 8 Response body parameters

Parameter

Type

Description

-

String

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error description.

Example Requests

Batch reinstalling OSs

PUT https://{endpoint}/v1/{project_id}/instances/reinstall

Example Responses

Status code: 202

The OS has been installed.

{
  "instances" : [ {
    "id" : "0197f36d-d83b-7258-b177-3784b7887a17"
  } ]
}

Status Codes

Status Code

Description

202

The OS has been installed.

400

Invalid request parameter.

401

The request is not authenticated.

429

The request is overloaded.

500

Internal server error.

Error Codes

See Error Codes.