tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateInstanceSnapshot

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

    1. API Description

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

    This API is used to create a system disk snapshot of the specified instance.

    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: CreateInstanceSnapshot.
    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 ID of the instance for which to create a snapshot.
    SnapshotName No String Snapshot name, which can contain up to 60 characters.

    3. Output Parameters

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

    4. Example

    Example1 Creating an instance snapshot

    This example shows you how to create an instance snapshot.

    Input Example

    https://lighthouse.tencentcloudapi.com/?Action=CreateInstanceSnapshot
&InstanceId=lhins-k31c771o
&SnapshotName=snap_20200903
&<Common request parameters>

    Output Example

    {
    "Response": {
        "SnapshotId": "lhsnap-nv6aqcv6",
        "RequestId": "0580622c-03ef-4ae0-8192-016783412094"
    }
}

    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.
    InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
    InternalError.GetSnapshotAllocQuotaLockError Failed to get the snapshot quota lock.
    InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
    InvalidParameterValue.SnapshotNameTooLong Invalid parametric value: the length of the snapshot name exceeds the upper limit.
    LimitExceeded.SnapshotQuotaLimitExceeded The snapshot quota is exceeded.
    OperationDenied.OperationDeniedCreateSnapshot Creating snapshot is not allowed.
    OperationDenied.OperationDeniedCreateSnapshotForStorageBundle Instances using storage packages do not support snapshot creation.
    ResourceNotFound.BlueprintIdNotFound The image ID does not exist.
    ResourceNotFound.DiskNotFound The disk does not exist.
    ResourceNotFound.InstanceIdNotFound The instance ID 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.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy