Domain name for API request: cvm.tencentcloudapi.com.
This API is used to reinstall the operating system of the specified instance.
ImageId, the specified image is used. Otherwise, the image used by the current instance is used.Linux and Windows, the system disk ID of the instance will change, and the snapshots that are associated with the system disk can no longer be used to roll back and restore data.Linux and Windows for instances whose system disk type is CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD.A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: ResetInstance. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response. |
| ImageId | No | String | Specified effective image ID in the format of img-xxx. There are four types of images:You can obtain the available image IDs in the following ways: public images, custom images, and shared images, log in to the CVM console; for IDs of marketplace images, go to Cloud Marketplace.ImageId in the response.Default value: current image. |
| SystemDisk | No | SystemDisk | System disk configurations in the instance. For instances with a cloud disk as the system disk, you can expand the capacity of the system disk to the specified value after re-installation by using this parameter. If the parameter is not specified, lower system disk capacity will be automatically expanded to the image size, and extra disk costs are generated. You can only expand but cannot reduce the system disk capacity. By re-installing the system, you only modify the system disk capacity, but not the type. |
| LoginSettings | No | LoginSettings | Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center. |
| EnhancedService | No | EnhancedService | Enhanced services. You can use this parameter to specify whether to enable services such as Cloud Monitor and Cloud Security. If this parameter is not specified, Cloud Monitor and Cloud Security will be enabled by default. |
| HostName | No | String | Host name of the CVM, editable during the system reinstallation. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to reinstall an instance using the specified image, login password, and enhanced services, and expand the system disk of the instance.
GET https://cvm.tencentcloudapi.com/?Action=ResetInstance
&InstanceId=ins-r8hr2upy
&ImageId=img-pmqg1cw7
&SystemDisk.DiskSize=60
&LoginSettings.Password=Qcloud@TestApi123++
&EnhancedService.SecurityService.Enabled=TRUE
&EnhancedService.MonitorService.Enabled=TRUE
&<Common request parameters>{
"Response": {
"RequestId": "a0a66377-b79f-4a21-846c-d997d6022968"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalServerError | Internal error. |
| InvalidAccount.InsufficientBalance | Insufficient account balance. |
| InvalidImageId.Malformed | Invalid image ID format. |
| InvalidImageId.NotFound | The image cannot be found. |
| InvalidInstance.NotSupported | This instance is not supported. |
| InvalidInstanceId.Malformed | Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length. |
| InvalidInstanceId.NotFound | No instance found. |
| InvalidParameter.HostNameIllegal | The specified HostName is invalid. |
| InvalidParameter.InstanceImageNotSupport | This API does not support instance images. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.IllegalHostName | The value of HostName is invalid. |
| InvalidParameterValue.InvalidImageState | Invalid image status. |
| InvalidPassword | Invalid password. The specified password does not meet the password requirements. For example, the password length does not meet the requirements. |
| MissingParameter | Missing parameter. |
| MissingParameter.MonitorService | The instance type must have Cloud Monitor enabled. |
| MutexOperation.TaskRunning | An identical job is running. |
| OperationDenied.InstanceOperationInProgress | The instance has an operation in progress. Please try again later. |
| UnauthorizedOperation.MFAExpired | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid. |
| UnauthorizedOperation.MFANotFound | Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists. |
| UnsupportedOperation.InstanceChargeType | This instance billing mode does not support the operation. |
| UnsupportedOperation.InstanceStateEnterRescueMode | Instances are entering the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStateExitRescueMode | Instances are exiting from the rescue mode, and this operation is not supported. |
| UnsupportedOperation.InstanceStatePending | The instances are being created, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRebooting | The instances are being restarted, and this operation is not supported. |
| UnsupportedOperation.InstanceStateRescueMode | Instances in the rescue mode are not available for this operation. |
| UnsupportedOperation.InstanceStateServiceLiveMigrate | The instances are being migrated, and this operation is not supported. |
| UnsupportedOperation.InstanceStateShutdown | Isolated instances do not support this operation. |
| UnsupportedOperation.InstanceStateStopping | The instance is being shut down, and this operation is not supported. |
| UnsupportedOperation.InstanceStateTerminating | The instance is being terminated, and the operation is not supported. |
| UnsupportedOperation.KeyPairUnsupportedWindows | Key-pair login is not available to Windows instances. |
| UnsupportedOperation.StoppedModeStopCharging | The instance does not support the no charges when shut down feature. |
Was this page helpful?