使用ListSnapshots查詢快照列表-Simple Application Server-阿里雲 - Simple Application Server

查詢一個或多個已建立的快照資訊。

介面說明

InstanceId、DiskId、SnapshotIds和ResourceGroupId不是必需的請求參數，但是可以構建過濾器邏輯，參數之間為邏輯及（And）關係。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

swas-open:ListSnapshots

get

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/*

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	快照對應的輕量應用伺服器所屬的地域 ID。	cn-hangzhou
InstanceId	string	否	指定的輕量應用伺服器的執行個體 ID。	2ad1ae67295445f598017499dc****
DiskId	string	否	指定的磁碟 ID。	d-bp14wq0149cpp2xy****
SnapshotIds	string	否	快照 ID。取值可以由多個快照 ID 組成一個 JSON 陣列，最多支援 100 個 ID，ID 之間用半形逗號（,）隔開。	["s-bp16oazlsold4dks**", "s-bp16oazlsold4abc**"]
PageSize	integer	否	分頁查詢時設定的每頁列數。最大值：100。預設值：10。	10
PageNumber	integer	否	快照清單的頁碼。預設值：1。	1
SourceDiskType	string	否	快照來源雲端硬碟的雲端硬碟類型。取值範圍： System：系統磁碟。 Data：資料磁碟。	Data
Tag	array<object>	否	快照的標籤清單。
	object	否	標籤。
Key	string	否	快照的標籤鍵。標籤鍵長度的取值範圍：1~64。N 的取值範圍：1~20。	TestKey
Value	string	否	快照的標籤值。標籤值長度的取值範圍：1~64。N 的取值範圍：1~20。	TestValue
ResourceGroupId	string	否	指定的資源群組 ID。	rg-aek2bti7cf7****

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	快照的總筆數。	1
RequestId	string	請求 ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	分頁查詢時設定的每頁列數。	10
PageNumber	integer	快照清單的頁碼。	1
Snapshots	array<object>	快照資訊組成的陣列。
	array<object>
Status	string	快照狀態。可能值： progressing：正在建立。 accomplished：建立成功。 failed：建立失敗。 disabled：不支援回滾。	Accomplished
CreationTime	string	快照建立時間。時間格式以 ISO8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2021-03-09T07:12:49Z
SourceDiskId	string	來源磁碟 ID。即使快照的來源磁碟已經被釋放，仍保留該傳回值。	d-bp14wq0149cpp2xy****
SnapshotName	string	快照名稱。	test-SnapshotName
Progress	string	快照建立的進度。	100%
Remark	string	快照備註。	test-Remark
SnapshotId	string	快照 ID。	s-bp16oazlsold4dks****
SourceDiskType	string	快照來源磁碟的磁碟類型。可能值： System：系統磁碟。 Data：資料磁碟。	System
RegionId	string	地域 ID。	cn-hangzhou
InstanceId	string	輕量應用伺服器執行個體 ID。註：系統磁碟快照該欄位有值，資料磁碟快照該值為空。	2ad1ae67295445f598017499dc****
Tags	array<object>	快照的標籤清單。
	object	標籤。
Key	string	快照的標籤鍵。	TestKey
Value	string	快照的標籤值。	TestValue
RollbackTime	string	最近一次回滾時間。時間採用 UTC（Z）時區，格式為 YYYY-MM-DDThh:mm:ssZ。	2021-03-09T07:12:49Z
ResourceGroupId	string	快照所屬的資源群組 ID。	rg-aek2bti7cf7****

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": [
    {
      "Status": "Accomplished",
      "CreationTime": "2021-03-09T07:12:49Z",
      "SourceDiskId": "d-bp14wq0149cpp2xy****",
      "SnapshotName": "test-SnapshotName",
      "Progress": "100%",
      "Remark": "test-Remark",
      "SnapshotId": "s-bp16oazlsold4dks****",
      "SourceDiskType": "System",
      "RegionId": "cn-hangzhou",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "RollbackTime": "2021-03-09T07:12:49Z",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
400	InvalidSnapshotIds	The specified SnapshotIds is not valid.
500	InternalError	An error occurred while processing your request.
403	InvalidParam	The specified parameter value is invalid.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.

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

變更歷史

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