tencent cloud

Feedback

DeleteSnapshots

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

    1. API Description

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

    This API is used to delete a snapshot.
    The snapshot must be in NORMAL status. To query the status of a snapshot, you can call the DescribeSnapshots API and see the SnapshotState field in the response.

    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: DeleteSnapshots.
    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.
    SnapshotIds.N Yes Array of String List of IDs of snapshots to be deleted, which can be queried through DescribeSnapshots.

    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 Deleting snapshot

    Input Example

    https://lighthouse.tencentcloudapi.com/?Action=DeleteSnapshots
    &SnapshotIds.0=lhsnap-nv6aqcv6
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "95cd6073-240b-4337-8c04-46345fcbbeb1"
        }
    }
    

    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.RequestError A request error occurred.
    FailedOperation.SnapshotOperationFailed Failed to manipulate the snapshot.
    InternalError.RequestError There was an error in the request.
    InvalidParameterValue.Duplicated Invalid parameter value: duplicate values are not allowed.
    InvalidParameterValue.LimitExceeded Invalid parametric value: the number of parameter values exceeds the upper limit.
    InvalidParameterValue.SnapshotIdMalformed Invalid parametric value: the snapshot ID format is invalid.
    ResourceNotFound.SnapshotIdNotFound The snapshot ID does not exist.
    ResourceNotFound.SnapshotNotFound The snapshot does not exist.
    UnauthorizedOperation.NoPermission No permission
    UnsupportedOperation.InvalidSnapshotState Unsupported operation: the snapshot status is invalid.
    UnsupportedOperation.SnapshotBusy The snapshot is busy.
    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