DescribeSnapshots - 查詢快照列表 - File Storage NAS

查詢指定檔案系統一個或多個快照的資訊。

介面說明

該功能免費公測中，公測期間不保障Apsara File Storage NAS 服務等級協議（SLA）。
僅極速型 NAS 進階型支援該功能。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

nas:DescribeSnapshots

get

*Snapshot

acs:nas:{#regionId}:{#accountId}:snapshot/*

無

請求參數

名稱	類型	必填	描述	樣本值
FileSystemType	string	否	檔案系統類型。取值：extreme（極速型 NAS）	extreme
FileSystemId	string	否	指定檔案系統 ID。	extreme-22f****
SnapshotIds	string	否	快照標識編碼。可以由多個快照 ID 組成，多個 ID 用半形逗號（,）隔開，最多支援 100 個 ID。	s-extreme-67pxwk9aevrkr**,s-extreme-snapsho,s-extreme-6tmsbas6ljhwh**
SnapshotName	string	否	快照名稱。	FinanceJoshua
SnapshotType	string	否	快照類型。取值： auto：自動快照 user：手動建立的快照 all（預設值）：所有快照類型	all
Status	string	否	快照狀態。取值： progressing：正在建立的快照 accomplished：建立成功的快照 failed：建立失敗的快照 all（預設）：所有快照狀態	all
PageSize	integer	否	分頁查詢時設定的每頁行數。取值範圍：1~100 預設值：10	10
PageNumber	integer	否	快照列表的頁碼。起始值（預設值）：1	1

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	快照總個數。	36
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSize	integer	查詢結果每頁行數。	10
PageNumber	integer	快照列表的頁碼。	1
Snapshots	object
Snapshot	array<object>	快照詳情集合。
	object
Status	string	快照狀態。包括： progressing：正在建立的快照 accomplished：建立成功的快照 failed：建立失敗的快照	accomplished
Progress	string	建立快照的進度。以百分比表示。	100
CreateTime	string	建立時間。按照ISO 8601標準表示，並使用 UTC 時間。格式為：`yyyy-MM-ddThh:mmZ`。	2014-07-24T13:00:52Z
SourceFileSystemId	string	源檔案系統 ID。如果快照的源檔案系統已經被刪除，該欄位仍舊保留。	extreme-012****
RetentionDays	integer	自動快照保留天數。單位：天。包括： -1：永久儲存，當快照數量達到額度上限後被自動刪除。 1~65536：指定儲存天數，保留時間到期後快照會被自動釋放。	30
RemainTime	integer	正在建立的快照任務剩餘完成時間。單位：秒。	38
SourceFileSystemSize	integer	源檔案系統容量。單位：GiB。	2000
SourceFileSystemVersion	string	源檔案系統版本號碼。	1
SnapshotName	string	快照名稱。建立快照時指定了快照名稱，則返回快照名稱。建立快照時未指定快照名稱，則不返回此參數。	FinanceJoshua
EncryptType	integer	加密類型。包括： 0：不加密 1：加密	1
Description	string	介面說明資訊。	FinanceDept
SnapshotId	string	快照 ID。	s-extreme-snapsho****
FileSystemType	string	檔案系統類型。	extreme
SnapshotType	string	快照建立類型。枚舉值： auto: 自動建立快照 user: 手動建立快照	user
CompletedTime	string	完成時間。按照ISO 8601標準表示，並使用 UTC 時間。格式為：`yyyy-MM-ddThh:mmZ`。說明這個欄位僅在快照狀態完成時有效，在快照建立過程中，這個欄位的值和 CreateTime 一致。	2014-07-24T13:10:52Z

樣本

正常返回樣本

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",
        "CompletedTime": "2014-07-24T13:10:52Z"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。