tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteCfsSnapshot

Last updated: 2023-07-04 17:30:00

1. API Description

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

This API is used to delete a file system snapshot.

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: DeleteCfsSnapshot.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
SnapshotId No String File system snapshot ID
SnapshotIds.N No Array of String The list of the IDs of the file system snapshots to be deleted. At least one of SnapshotId and SnapshotIds must be specified.

3. Output Parameters

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

4. Example

Example1 Deleting a snapshot

Input Example

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

{
    "SnapshotId": "snapcfs-12345"
}

Output Example

{
    "Response": {
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
        "SnapshotId": "snapcfs-12345"
    }
}

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
AuthFailure A CAM signature/authentication error occurred.
AuthFailure.UnauthorizedOperation Request unauthorized.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidSnapshotStatus The snapshot is invalid.
ResourceNotFound.SnapshotNotFound The snapshot ID does not exist.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnauthorizedCfsQcsRole The CFS role was not authorized.
UnsupportedOperation.UnverifiedUser Unverified user.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy