tencent cloud

Feedback

ResetInstances

Last updated: 2022-06-01 18:41:34

1. API Description

Domain name for API request: ecm.tencentcloudapi.com.

This API is used to reinstall an instance. If you specify the ImageId parameter, the specified image will be used; otherwise, the image used by the current instance will be used. If you don't specify the password, a password will be sent later in Message Center.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 Params. The value used for this API: ResetInstances.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
InstanceIdSet.N Yes Array of String List of IDs of the instances to be reinstalled.
ImageId No String ID of the image from which to install the instance. If this parameter is not specified, the current image of the instance will be used.
Password No String Password. If this parameter is not specified, the password will be subsequently displayed in the Message Center.
EnhancedService No EnhancedService Whether to enable CM and CWP. If this parameter is not specified, they will be enabled by default.
KeepData No String Whether to retain the data on the data disk. Valid values: true, false. Default value: true
KeepImageLogin No String Whether to keep the original settings for the image. You cannot specify this parameter if Password or KeyIds.N is specified. You can specify this parameter as TRUE only when you create an instance by using a custom image, shared image, or image imported from an external resource. Valid values:
TRUE: yes
FALSE: no

Default value: FALSE.
Note: this field may return null, indicating that no valid values can be obtained.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Reinstalling instance

This example shows you how to reinstall an instance.

Input Example

https://ecm.tencentcloudapi.com/?Action=ResetInstances
&InstanceIdSet.0=ein-492054ga
&InstanceIdSet.1=ein-482972ao
&ImageId=img-q9fy0if9
&Password=hpjtfgnb3nwa
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "s46ofg79-6hm8-4b48-b3aa-djl3424-6jgfh"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.InternalOperationFailure Internal error.
FailedOperation.OperationNotAllow The current operation is not allowed.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameter.ParameterConflict Only KeepImageLogin, Password, or KeyIds can be used at a time.
InvalidParameterValue.InvaildPassword The password is invalid.
InvalidParameterValue.InvalidImageArchitecture Models with a memory of 4 GB or above do not support 32-bit OS images.
InvalidParameterValue.InvalidImageID The image ID is invalid.
InvalidParameterValue.InvalidInstanceID The instance ID is invalid.
InvalidParameterValue.ParameterValueTooLarge The parameter value exceeds the limit.
OperationDenied.InstanceOperationInProgress The current operation is not allowed.
ResourceNotFound.InstanceNotExist The instance is invalid.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support