tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeCfsSnapshots

Last updated: 2023-07-04 17:29:54

1. API Description

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

This API is used to query the list of snapshots of a file system.

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: DescribeCfsSnapshots.
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 No String File system ID
SnapshotId No String Snapshot ID
Offset No Integer The starting position of paging
Limit No Integer Page length
Filters.N No Array of Filter Filters
OrderField No String Order field
Order No String Sorting order (ascending or descending)

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number
Snapshots Array of SnapshotInfo Snapshot information description
TotalSize Integer Total size of snapshots
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying a snapshot

Input Example

https://cfs.tencentcloudapi.com/?Action=DescribeCfsSnapshots
&FileSystemId=cfs-12345
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalSize": 1,
        "TotalCount": 1,
        "RequestId": "xx",
        "Snapshots": [
            {
                "Status": 1,
                "SnapshotName": "xx",
                "Percent": 1,
                "FileSystemId": "xx",
                "Size": 1,
                "AppId": 1,
                "SnapshotId": "xx",
                "AliveDay": 1,
                "CreationTime": "xx",
                "DeleteTime": "xx",
                "FsName": "xx",
                "RegionName": "xx"
            }
        ]
    }
}

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.UnauthorizedOperation Request unauthorized.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidFileSystemId FileSystemId is invalid.
ResourceNotFound.SnapshotNotFound The snapshot ID does not exist.
UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
UnsupportedOperation.UnverifiedUser Unverified user.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy