DescribeSnapshots - 查询快照列表

查询指定文件系统一个或多个快照的信息。

接口说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:DescribeSnapshotsget
*Snapshot
acs:nas:{#regionId}:{#accountId}:snapshot/*

请求参数

名称类型必填描述示例值
FileSystemTypestring

文件系统类型。

取值:extreme(极速型 NAS)

extreme
FileSystemIdstring

指定文件系统 ID。

extreme-22f****
SnapshotIdsstring

快照标识编码。

可以由多个快照 ID 组成,多个 ID 用半角逗号(,)隔开,最多支持 100 个 ID。

s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh****
SnapshotNamestring

快照名称。

FinanceJoshua
SnapshotTypestring

快照类型。

取值:

  • auto:自动快照
  • user:手动创建的快照
  • all(默认值):所有快照类型
all
Statusstring

快照状态。

取值:

  • progressing:正在创建的快照
  • accomplished:创建成功的快照
  • failed:创建失败的快照
  • all(默认):所有快照状态
all
PageSizeinteger

分页查询时设置的每页行数。

取值范围:1~100

默认值:10

10
PageNumberinteger

快照列表的页码。

起始值(默认值):1

1

返回参数

名称类型描述示例值
object
TotalCountinteger

快照总个数。

36
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSizeinteger

查询结果每页行数。

10
PageNumberinteger

快照列表的页码。

1
Snapshotsarray<object>

快照详情集合。

Snapshotobject
Statusstring

快照状态。

包括:

  • progressing:正在创建的快照
  • accomplished:创建成功的快照
  • failed:创建失败的快照
accomplished
Progressstring

创建快照的进度。以百分比表示。

100
CreateTimestring

创建时间。

按照ISO 8601标准表示,并使用 UTC 时间。格式为:yyyy-MM-ddThh:mmZ

2014-07-24T13:00:52Z
SourceFileSystemIdstring

源文件系统 ID。

如果快照的源文件系统已经被删除,该字段仍旧保留。

extreme-012****
RetentionDaysinteger

自动快照保留天数。

单位:天。

包括:

  • -1:永久保存,当快照数量达到额度上限后被自动删除。
  • 1~65536:指定保存天数,保留时间到期后快照会被自动释放。
30
RemainTimeinteger

正在创建的快照任务剩余完成时间。

单位:秒。

38
SourceFileSystemSizelong

源文件系统容量。

单位:GiB。

2000
SourceFileSystemVersionstring

源文件系统版本号。

1
SnapshotNamestring

快照名称。

创建快照时指定了快照名称,则返回快照名称。创建快照时未指定快照名称,则不返回此参数。

FinanceJoshua
EncryptTypeinteger

加密类型。

包括:

  • 0:不加密
  • 1:加密
1
Descriptionstring

接口说明信息。

FinanceDept
SnapshotIdstring

快照 ID。

s-extreme-snapsho****
FileSystemTypestring

文件系统类型。

extreme
SnapshotTypestring

快照创建类型。 枚举值:

  • auto: 自动创建快照
  • user: 手动创建快照
user

示例

正常返回示例

JSON格式

{
  "TotalCount": 36,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "Progress": "100",
        "CreateTime": "2014-07-24T13:00:52Z",
        "SourceFileSystemId": "extreme-012****",
        "RetentionDays": 30,
        "RemainTime": 38,
        "SourceFileSystemSize": 2000,
        "SourceFileSystemVersion": "1",
        "SnapshotName": "FinanceJoshua",
        "EncryptType": 1,
        "Description": "FinanceDept",
        "SnapshotId": "s-extreme-snapsho****",
        "FileSystemType": "extreme",
        "SnapshotType": "user"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-10OpenAPI 返回结构发生变更查看变更详情