tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ResetInstance

Last updated: 2023-12-04 16:31:56

    1. API Description

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

    This API is used to reinstall the image on the specified instance.

    • If you specify a BlueprintId, the specified image is used; otherwise, the image used by the current instance is used.
    • The system disk will be formatted and reset. Therefore, make sure that no important files are stored on the system disk.
    • Currently, this API does not support switching the operating system between LINUX_UNIX and WINDOWS for instances.
    • This API is async. After the request is sent successfully, a RequestId will be returned. At this time, the operation is not completed immediately. The result of the instance operation can be queried by calling the DescribeInstances API. If the latest operation status (LatestOperationState) of the instance is SUCCESS, the operation is successful.

    A maximum of 10 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: ResetInstance.
    Version Yes String Common Params. The value used for this API: 2020-03-24.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID, which can be obtained from the InstanceId returned by the DescribeInstances API.
    BlueprintId No String Image ID, which can be obtained from the BlueprintId returned by the DescribeBlueprints API.

    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 an instance

    This example shows how to reinstall an instance by specifying the image.

    Input Example

    https://lighthouse.tencentcloudapi.com/?Action=ResetInstance
&InstanceId=lhins-ruy9d2tw
&BlueprintId=lhbp-5e8807lo
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "cb7aaa99-b31a-4767-9d41-4ebdbdf3ba9c"
    }
}

    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 Operation failed.
    FailedOperation.DescribeInstanceStatus An error occurred when querying the instance status.
    FailedOperation.InstanceOperationFailed Failed to manipulate the instance.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InternalError.InvalidCommandNotFound The command is not found.
    InvalidParameterValue.BlueprintConfigNotMatch The configuration of this instance does not meet the requirements of the specified image.
    InvalidParameterValue.BlueprintId The image ID is invalid, as instance reinstallation does not allow switching the OS type.
    InvalidParameterValue.BlueprintIdMalformed Invalid parameter value: the image ID format is invalid.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.InvalidParameterCombination Invalid package combination.
    InvalidParameterValue.InvalidPassword The password in the parameter is invalid.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.NotAllowToChangePlatformType It is not allowed to change the OS type.
    InvalidParameterValue.OutOfRange Invalid parametric value: it is not within the valid range.
    InvalidParameterValue.TooLong The length of the parameter value exceeds the upper limit.
    OperationDenied.InstanceCreating It is not allowed to manipulate this instance, as it is being created.
    OperationDenied.InstanceOperationInProgress It is not allowed to manipulate this instance, as the last operation is still in progress.
    ResourceNotFound.BlueprintIdNotFound The image ID does not exist.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    ResourceNotFound.KeyPairNotFound
    ResourceUnavailable.BlueprintUnavailable The image resource is not available.
    UnauthorizedOperation.MFANotFound MFA does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    UnsupportedOperation.SystemBusy System busy
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy