You need to enable JavaScript to run this app.
导航
文件存储 NAS
  • 文档首页
    • /
  • 文件存储 NAS

DescribeSnapshots

最近更新时间：2023.10.17 14:47:16

首次发布时间：2023.07.10 11:11:52

我的收藏

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

请求参数

参数类型是否必选示例值描述
FileSystemIdString否extreme-22f****指定文件系统 ID。
SnapshotIdsString否snap-472a716f****快照 ID。
SnapshotNameString否FinanceJoshua快照名称。

SnapshotType

String

否

Manual

快照类型，取值说明如下：

  • Manual：手动快照。

Status

String

否

all

快照状态。取值说明如下：

  • Progressing：正在创建的快照。
  • Accomplished：创建成功的快照。
  • Failed：创建失败的快照。
  • all（默认）：所有快照状态。
PageSizeInteger否10分页查询时设置的每页行数。
PageNumberInteger否1快照列表的页码。

返回参数

参数类型示例值描述
TotalCountInteger36快照总个数。
PageSizeInteger10分页查询时设置的每页行数。
PageNumberInteger1快照列表的页码。
SnapshotsArray of Snapshot详情请参见返回示例快照详细信息。

Snapshot

参数类型示例值描述

Status

String

Progressing

快照状态。说明如下：

  • Progressing：正在创建。
  • Accomplished：创建成功。
  • Failed：创建失败
ZoneIdStringcn-beijing-a可用区 ID。
ProgressString100快照创建进度。
IsEncryptBooleanfalse是否加密，当前仅支持 false，即不加密。
CreateTimeString2022-11-16T11:18:02+08:00快照创建时间。
SnapshotIdStringsnap-472a716f****快照 ID。
SourceSizeInteger100文件系统容量，单位为 GiB。
DescriptionStringtest快照描述信息。
FileSystemIdStringenas-cnbj1c789dca****文件系统 ID。
SnapshotNameStringtestcreate快照名称。
SnapshotTypeStringManual快照类型，默认为 Manual，即手动快照。
RetentionDaysInteger2147483647快照保留时间，默认为 2147483647，即永久保留。
SourceVersionString1.1.10.7文件系统版本。
FileSystemNameStringdoctest文件系统名称。

示例

请求示例

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
    }
}