调用DescribeSnapshots接口查询指定文件系统所有的快照列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSnapshots |
接口名称。 固定取值:DescribeSnapshots |
FileSystemType | String | 是 | extreme |
文件系统类型。 取值:extreme(极速型NAS) |
FileSystemId | String | 否 | extreme-22f**** |
指定文件系统ID。 |
SnapshotIds | String | 否 | s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh**** |
快照标识编码。 可以由多个快照ID组成,多个ID用半角逗号(,)隔开,最多支持100个ID。 |
SnapshotName | String | 否 | FinanceJoshua |
快照名称。 |
SnapshotType | String | 否 | all |
快照类型。 取值:
|
Status | String | 否 | all |
快照状态。 取值:
|
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。 取值范围:1~100 默认值:10 |
PageNumber | Integer | 否 | 1 |
快照列表的页码。 起始值(默认值):1 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
快照列表的页码。 |
PageSize | Integer | 10 |
查询结果每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
请求ID。 |
Snapshots | Array of Snapshot |
快照详情集合。 |
|
Snapshot | |||
CreateTime | String | 2014-07-24T13:00:52Z |
创建时间。 按照ISO 8601标准表示,并使用UTC时间。格式为: |
Description | String | FinanceDept |
接口说明信息。 |
EncryptType | Integer | 1 |
加密类型。 包括:
|
Progress | String | 100 |
创建快照的进度。以百分比表示。 |
RemainTime | Integer | 38 |
正在创建的快照任务剩余完成时间。 单位:秒。 |
RetentionDays | Integer | 30 |
自动快照保留天数。 单位:天。 包括:
|
SnapshotId | String | s-extreme-snapsho**** |
快照ID。 |
SnapshotName | String | FinanceJoshua |
快照名称。 创建快照时指定了快照名称,则返回快照名称。创建快照时未指定快照名称,则不返回此参数。 |
SourceFileSystemId | String | extreme-012**** |
源文件系统ID。 如果快照的源文件系统已经被删除,该字段仍旧保留。 |
SourceFileSystemSize | Long | 2000 |
源文件系统容量。 单位:GiB。 |
SourceFileSystemVersion | String | 1 |
源文件系统版本号。 |
Status | String | accomplished |
快照状态。 包括:
|
TotalCount | Integer | 36 |
快照总个数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeSnapshots
&FileSystemType=extreme
&<公共请求参数>
正常返回示例
XML
格式
<TotalCount>36</TotalCount>
<PageSize>10</PageSize>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
<PageNumber>1</PageNumber>
<Snapshots>
<Snapshot>
<Status>accomplished</Status>
<Progress>100</Progress>
<Description>FinanceDept</Description>
<SourceFileSystemVersion>1</SourceFileSystemVersion>
<CreateTime>2014-07-24T13:00:52Z</CreateTime>
<SourceFileSystemId>extreme-012****</SourceFileSystemId>
<RetentionDays>30</RetentionDays>
<SnapshotName>FinanceJoshua</SnapshotName>
<SnapshotId>s-extreme-snapsho****</SnapshotId>
<SourceFileSystemSize>2000</SourceFileSystemSize>
<EncryptType>1</EncryptType>
<RemainTime>38</RemainTime>
</Snapshot>
</Snapshots>
JSON
格式
{
"TotalCount": 36,
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"Snapshots": {
"Snapshot": {
"Status": "accomplished",
"Progress": 100,
"Description": "FinanceDept",
"SourceFileSystemVersion": 1,
"CreateTime": "2014-07-24T13:00:52Z",
"SourceFileSystemId": "extreme-012****",
"RetentionDays": 30,
"SnapshotName": "FinanceJoshua",
"SnapshotId": "s-extreme-snapsho****",
"SourceFileSystemSize": 2000,
"EncryptType": 1,
"RemainTime": 38
}
}
}
错误码
访问错误中心查看更多错误码。