文件存储查询快照列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cfs.tencentcloudapi.com 。

查询文件系统快照列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCfsSnapshots。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	是	String	公共参数，详见产品支持的地域列表。
FileSystemId	否	String	文件系统ID 示例值：cfs-gagaggag
SnapshotId	否	String	快照ID 示例值：snapcfs-xx
Offset	否	Integer	分页起始位置，默认为0 示例值：10
Limit	否	Integer	页面长度，默认为20 示例值：10
Filters.N	否	Array of Filter	过滤条件。 SnapshotId - Array of String - 是否必填：否 -（过滤条件）按快照ID过滤。 SnapshotName - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。 FileSystemId - Array of String - 是否必填：否 -（过滤条件）按文件系统ID过滤。 FsName - Array of String - 是否必填：否 -（过滤条件）按文件系统名过滤。 Status - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤 (creating：表示创建中 \| available：表示可用。\| rollbacking：表示回滚。\| rollbacking_new：表示由快照创建新文件系统中） tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag:tag-key - Array of String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
OrderField	否	String	排序取值示例值：CreationTime
Order	否	String	排序升序或者降序示例值：ASC，DESC

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总个数示例值：20
Snapshots	Array of SnapshotInfo	快照信息描述示例值：fsf
TotalSize	Integer	快照列表快照汇总示例值：333
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询快照

输入示例

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCfsSnapshots
<公共请求参数>

{
    "FileSystemId": "cfs-12345"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Snapshots": [
            {
                "CreationTime": "abc",
                "SnapshotName": "abc",
                "SnapshotId": "abc",
                "Status": "abc",
                "RegionName": "abc",
                "FileSystemId": "abc",
                "Size": 1,
                "AliveDay": 1,
                "Percent": 1,
                "AppId": 1,
                "DeleteTime": "abc",
                "FsName": "abc",
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ],
                "SnapshotType": "abc",
                "SnapshotTime": "abc"
            }
        ],
        "TotalSize": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnauthorizedOperation	请求未CAM授权。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.InvalidFileSystemId	FileSystemId无效。
ResourceNotFound.SnapshotNotFound	快照ID 不存在。
UnsupportedOperation.OutOfService	用户已欠费, 请充值后重试。
UnsupportedOperation.UnverifiedUser	用户未经过实名认证。

查询快照列表

本页目录：