tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ResetInstance

最后更新时间：2024-01-04 16:11:07

    1. API Description

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

    This API is used to reinstall the operating system of the specified instance.

    • If you specify an ImageId, 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.
    • If the operating system switches between 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.
    • If no password is specified, you will get a random password via internal message.
    • You can only use this API to switch the operating system between Linux and Windows for instances whose system disk type is CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD.
    • Currently, this API only supports instances in Mainland China regions.

    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: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    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:
  • Public images
  • Custom images
  • Shared images
  • Marketplace images

    • You can obtain the available image IDs in the following ways:
  • for IDs of public images, custom images, and shared images, log in to the CVM console; for IDs of marketplace images, go to Cloud Marketplace.
  • Call the API DescribeImages and look for ImageId in the response.


    • Default value: current image.
    SystemDisk No SystemDisk Configurations of the system disk. For an instance whose system disk is a cloud disk, this parameter can be used to expand the system disk by specifying a new capacity after reinstallation. The system disk capacity can only be expanded but not shrunk. Reinstalling the system can only resize rather than changing the type of the system disk.
    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.
  • Periods (.) or hyphens (-) cannot be the start or end of a host name or appear consecutively in a host name.
  • For Windows instances, the host name must consist of 2-15 characters , including uppercase and lowercase letters, numbers, or hyphens (-). It cannot contain periods (.) or contain only numbers.
  • For other instances, such as Linux instances, the host name must consist of 2-60 characters, including multiple periods (.), and allows uppercase and lowercase letters, numbers, or hyphens (-) between any two periods (.).
    		•
    UserData No String User data provided to the instance. This parameter needs to be encoded in base64 format with the maximum size of 16 KB. For more information on how to get the value of this parameter, see the commands you need to execute on startup for Windows or Linux.

    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 you how to reinstall an instance using the specified image, login password, and enhanced services, and expand the system disk of the instance.

    Input Example

    POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetInstance
<Common request parameters>

{
    "InstanceId": "ins-r8hr2upy",
    "SystemDisk": {
        "DiskSize": "60"
    },
    "EnhancedService": {
        "SecurityService": {
            "Enabled": "TRUE"
        },
        "MonitorService": {
            "Enabled": "TRUE"
        }
    },
    "LoginSettings": {
        "Password": "Qcloud@TestApi123++"
    },
    "ImageId": "img-pmqg1cw7"
}

    Output Example

    {
    "Response": {
        "RequestId": "a0a66377-b79f-4a21-846c-d997d6022968"
    }
}

    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.InvalidInstanceApplicationRoleEmr The EMR instance ins-xxxxxxxx does not support this operation.
    InternalError.TradeUnknownError Internal error.
    InternalServerError Internal error.
    InvalidAccount.InsufficientBalance Insufficient account balance.
    InvalidAccount.UnpaidOrder The account has unpaid orders.
    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.
    InvalidInstanceType.Malformed The specified InstanceType parameter has an invalid format.
    InvalidKeyPairId.Malformed Invalid key pair ID. The specified key pair ID has an invalid format. For example, skey-1122 has an invalid ID length.
    InvalidParameter.HostNameIllegal The specified HostName is invalid.
    InvalidParameter.InstanceImageNotSupport This API does not support instance images.
    InvalidParameter.ParameterConflict Specifying an SSH key will override the original one of the image.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.IllegalHostName The value of HostName is invalid.
    InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.InstanceTypeNotFound The specified instance type does not exist.
    InvalidParameterValue.InvalidAppIdFormat Invalid AppID
    InvalidParameterValue.InvalidImageForGivenInstanceType The specified image does not support the specified instance type.
    InvalidParameterValue.InvalidImageFormat A RAW image cannot be used to create a CVM. Choose another image.
    InvalidParameterValue.InvalidImageId The image does not support this operation.
    InvalidParameterValue.InvalidImageIdForRetsetInstance The image cannot be used to reinstall the current instance.
    InvalidParameterValue.InvalidImageState The image has another ongoing task. Please check and try again later.
    InvalidParameterValue.InvalidPassword Invalid password. The specified password does not meet the complexity requirements (e.g., too long or too short)
    InvalidParameterValue.InvalidUserDataFormat Incorrect UserData format. Use the Base64-encoded format.
    InvalidParameterValue.KeyPairNotFound The key does not exist.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    InvalidParameterValue.RequiredLocationImage
    InvalidParameterValue.ZoneNotSupported The availability zone does not support this operation.
    MissingParameter Missing parameter.
    MissingParameter.MonitorService The instance type must have Cloud Monitor enabled.
    MutexOperation.TaskRunning An identical job is running.
    OperationDenied.ChcInstallCloudImageWithoutDeployNetwork A CHC instance without network configured is not allowed for the installation of a cloud image
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    ResourceInUse The resource is in use.
    ResourceInsufficient.CloudDiskSoldOut The specified cloud disk has been sold out.
    ResourceNotFound.KeyPairNotFound
    ResourcesSoldOut.SpecifiedInstanceType The specified instance type is sold out.
    UnauthorizedOperation.InvalidToken Check if the token is valid.
    UnauthorizedOperation.MFAExpired Unauthorized operation. Make sure Multi-Factor Authentication (MFA) is valid.
    UnauthorizedOperation.MFANotFound Unauthorized operation. Make sure Multi-Factor Authentication (MFA) exists.
    UnsupportedOperation Unsupported operation.
    UnsupportedOperation.InstanceChargeType This instance billing mode does not support the operation.
    UnsupportedOperation.InstanceStateCorrupted The instances are permanently corrupted, and this operation is not supported.
    UnsupportedOperation.InstanceStateEnterRescueMode Instances are entering the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported.
    UnsupportedOperation.InstanceStateExitRescueMode Instances are exiting from the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateExitServiceLiveMigrate The instance ins-xxxxxx in the EXIT_SERVICE_LIVE_MIGRATE status is not supported.
    UnsupportedOperation.InstanceStateFreezing The operation is not supported for the frozen instances.
    UnsupportedOperation.InstanceStateIsolating Unable to isolate: the instance is isolated
    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.InstanceStateStarting The instance is starting up, and this operation is not supported.
    UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
    UnsupportedOperation.InstanceStateTerminated Terminated instances are not supported.
    UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
    UnsupportedOperation.InvalidImageLicenseTypeForReset The image license type does not match the instance. Select another image.
    UnsupportedOperation.KeyPairUnsupportedWindows Key-pair login is not available to Windows instances.
    UnsupportedOperation.ModifyEncryptionNotSupported Encryption attributes of the system disk cannot be modified.
    UnsupportedOperation.RawLocalDiskInsReinstalltoQcow2 This image does not support instance reinstallation.
    UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款