DescribeSnapshots - 列举快照--文件存储 NAS-火山引擎

文档中心

立即注册

导航

DescribeSnapshots - 列举快照

最近更新时间：2025.05.16 14:12:25首次发布时间：2023.07.10 11:11:52

调用 DescribeSnapshots 接口查询指定文件系统的快照。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeSnapshots	要执行的操作，取值：DescribeSnapshots。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
SnapshotIds	String	否	snap-472a716f****	快照ID。
SnapshotName	String	否	FinanceJoshua	快照名称。
SnapshotType	String	否	Manual	快照类型,取值说明如下： `Maunal`：手动快照。
Status	String	否	all	快照状态。取值说明如下： `Progressing`：正在创建的快照。 `Accomplished`：创建成功的快照。 `Failed`：创建失败的快照。 `all`（默认）：所有快照状态。
PageSize	Integer	否	10	分页查询时设置的每页行数。
PageNumber	Integer	否	1	快照列表的页码。
FileSystemId	String	否	extreme-22f****	指定文件系统 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalCount	Integer	36	快照总个数。
PageSize	Integer	10	分页查询时设置的每页行数。
PageNumber	Integer	1	快照列表的页码。
Snapshots	Array of Object	详情请参见返回示例	快照详细信息。

请求示例

POST /?Action=DescribeSnapshots&Version=2022-01-01 HTTP/1.1
Host: filenas.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/filenas/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022111519580201022508219905543F28",
        "Action": "DescribeSnapshots",
        "Version": "2022-01-01",
        "Service": "FileNAS",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 10,
        "PageSize": 1,
        "Snapshots": [
            {
                "CreatedTime": "2022-11-15T16:35:09+08:00",
                "Description": "",
                "FileSystemId": "enas-cn01961fc437****",
                "FileSystemName": "doctest",
                "IsEncrypt": false,
                "Progress": "100",
                "RetentionDays": 2147483647,
                "SnapshotId": "snap-67dcbc01****",
                "SnapshotName": "test1",
                "SnapshotType": "Manual",
                "SourceSize": 100,
                "SourceVersion": "1.1.10.7",
                "Status": "Accomplished",
                "ZoneId": "cn-beijing-a"
            },
            {
                "CreatedTime": "2022-11-15T16:23:03+08:00",
                "Description": "",
                "FileSystemId": "enas-cn01961fc437****",
                "FileSystemName": "doctest",
                "IsEncrypt": false,
                "Progress": "100",
                "RetentionDays": 2147483647,
                "SnapshotId": "snap-1a1b8ef4****",
                "SnapshotName": "test",
                "SnapshotType": "Manual",
                "SourceSize": 100,
                "SourceVersion": "1.1.10.7",
                "Status": "Accomplished"
            }
        ],
        "TotalCount": 2
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	An internal error has occurred.	内部错误。