tencent cloud



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

1. API Description

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

This API is used to create 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: CreateCfsSnapshot.
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.
FileSystemId Yes String File system ID
SnapshotName No String Snapshot name
ResourceTags.N No Array of TagInfo Snapshot tag

3. Output Parameters

Parameter Name Type Description
SnapshotId String File system 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 a file system snapshot

Input Example

&<Common request parameters>

Output Example

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

5. Developer Resources


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.UnauthorizedOperation Request unauthorized.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.InvalidSnapshotName The file system snapshot parameter name is invalid.
InvalidParameter.SnapshotNameLimitExceeded The file system snapshot name exceeds the upper limit.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.FsSizeLimitExceeded The file system quota exceeds the upper limit.
InvalidParameterValue.InvalidFileSystemId FileSystemId is invalid.
InvalidParameterValue.InvalidFsStatus Invalid file system status.
InvalidParameterValue.InvalidResourceTags Invalid parameter value: invalid resource tag value.
InvalidParameterValue.InvalidTagKey The tag key cannot be empty.
InvalidParameterValue.InvalidTagValue The tag value is empty or the character is invalid.
InvalidParameterValue.MissingFileSystemId FileSystemId is missing.
InvalidParameterValue.TagKeyFilterLimitExceeded Invalid parameter value: the number of tag keys exceeds the upper limit (6).
InvalidParameterValue.TagKeyLimitExceeded The length of the tag key exceeds the upper limit of 127 bytes.
InvalidParameterValue.TagValueFilterLimitExceeded The number of tag values exceeds the maximum (10).
InvalidParameterValue.TagValueLimitExceeded The length of the tag value exceeds the upper limit of 255 bytes.
ResourceInsufficient.TagLimitExceeded The quantity of the resource tags reached the upper limit.
ResourceInsufficient.TagQuotasExceeded The tag quota is insufficient.
ResourceNotFound The resource does not exist.
ResourceNotFound.FileSystemNotFound The file system does not exist.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnverifiedUser Unverified user.
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