Batch Reinstalling OSs
Function
This API is used to reinstall an OS using a new OS image. It is an asynchronous API. 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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition The project ID. Constraints N/A Range The project ID of the account Default Value N/A |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
image_id |
No |
String |
Definition Image ID, which 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 Default login password for the instance administrator. For Linux, the administrator is root. For Windows, the administrator is Administrator. Constraints N/A Range The value can contain 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 cannot contain more than 50 IDs. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
instances |
Array of instances objects |
Definition Returned instance information. Constraints N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Instance ID. Constraints N/A Range N/A Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Status code: 429
Parameter |
Type |
Description |
---|---|---|
- |
String |
- |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. Constraints N/A Range N/A Default Value N/A |
error_msg |
String |
Definition Error message. Constraints N/A Range N/A Default Value N/A |
Example Requests
Request for batch reinstalling OSs
GET https://{endpoint}/v1/{project_id}/instances/reinstall
Example Responses
Status code: 202
OSs 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
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot