tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ApplyInstanceSnapshot

Last updated: 2024-11-28 11:50:42

    1. API Description

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

    This API is used to roll back the system disk snapshot of the specified instance.

  • Only rollback to the original system disk is supported.
  • Only snapshots in `NORMAL` status can be used for rollback. To query the status of a snapshot, you can call the `DescribeSnapshots` API and see the `SnapshotState` field in the response.
  • When a snapshot is rolled back, the status of the instance must be `STOPPED` or `RUNNING`. You can call the `DescribeInstances` API to query the instance status. Instances in `RUNNING` status will be forcibly shut down before snapshot rollback.

    • 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: ApplyInstanceSnapshot.
    Version Yes String Common Params. The value used for this API: 2020-03-24.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
    InstanceId Yes String Instance ID.
    SnapshotId Yes String Snapshot ID.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Rolling back instance snapshot

    Input Example

    https://lighthouse.intl.tencentcloudapi.com/?Action=ApplyInstanceSnapshot
&InstanceId=lhins-k31c771o
&SnapshotId=lhsnap-nv6aqcv6
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "96aee6e3-172c-4f0f-be7c-fc46b9865763"
    }
}

    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.DescribeInstanceStatus An error occurred when querying the instance status.
    FailedOperation.SnapshotOperationFailed Failed to manipulate the snapshot.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InvalidParameterValue.DiskSizeNotMatch The disk size has changed.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.SnapshotIdMalformed Invalid parametric value: the snapshot ID format is invalid.
    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.DiskNotFound The disk does not exist.
    ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
    ResourceNotFound.SnapshotIdNotFound The snapshot ID does not exist.
    ResourceNotFound.SnapshotNotFound The snapshot does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.DiskBusy The disk is busy.
    UnsupportedOperation.DiskLatestOperationUnfinished Unsupported operation: the last operation of the disk has not been completed.
    UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
    UnsupportedOperation.InvalidSnapshotState Unsupported operation: the snapshot status is invalid.
    UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    UnsupportedOperation.SnapshotBusy The snapshot is busy.
    UnsupportedOperation.SystemBusy System busy
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy