DescribeSnapshotGroups - 查詢快照一致性組 - Elastic Compute Service

查詢一個或多個快照一致性組的資訊。例如狀態、所屬的執行個體ID、快照建立進度等。

介面說明

InstanceId、SnapshotGroupId.N和Status.N不是必需的請求參數，但是可以構建過濾器邏輯，參數之間為邏輯與（And）關係。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeSnapshotGroups

get

SnapshotGroup

acs:ecs:{#regionId}:{#accountId}:snapshotgroup/*

SnapshotGroup

acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
InstanceId	string	否	指定的執行個體 ID。	i-j6ca469urv8ei629****
Name	string	否	快照一致性組的名稱。	testName
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	否	分頁查詢時每頁行數。最大值為 100。預設值為 10。	10
SnapshotGroupId	array	否	指定的快照一致性組 ID。N 的取值範圍為 1~10。	ssg-j6ciyh3k52qp7ovm****
	string	否	指定的快照一致性組 ID。N 的取值範圍為 1~10。	ssg-j6ciyh3k52qp7ovm****
Status	array	否	快照一致性組的狀態。N 的取值範圍為 1~3。取值如下： progressing：建立中。 accomplished：建立成功。 failed：建立失敗。	accomplished
	string	否	快照一致性組的狀態。N 的取值範圍：1~3。取值如下： progressing：建立中。 accomplished：建立成功。 failed：建立失敗。	accomplished
AdditionalAttributes	array	否	該參數暫未開放使用。	hide
	string	否	說明該參數暫未開放使用。	null
Tag	array<object>	否	快照一致性組的標籤索引值對。
	object	否	快照一致性組的標籤索引值對。
Key	string	否	快照一致性組的標籤鍵。N 的取值範圍為 1~20。	TestKey
Value	string	否	快照一致性組的標籤值。N 的取值範圍為 1~20。	TestValue
ResourceGroupId	string	否	快照一致性組所屬的資源群組 ID。	rg-bp67acfmxazb4p****

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	下一個查詢起始標誌。說明該傳回值為空白時，表示無更多返回的資料資訊。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	請求 ID。	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	快照一致性組的資訊組成的數組。
	array<object>
Status	string	快照一致性組的狀態。可能值： progressing：建立中。 accomplished：建立成功。 failed：建立失敗。	accomplished
CreationTime	string	建立時間。按照ISO 8601標準表示，並需要使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。	2021-03-23T10:58:48Z
Description	string	描述。	This is description.
ProgressStatus	string	說明該參數暫未開放使用。	null
SnapshotGroupId	string	快照一致性組 ID。	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	快照一致性組所屬的執行個體 ID。該參數僅當快照一致性組內的所有雲端硬碟快照屬於同一執行個體時有傳回值。如果您的快照一致性組內的多個雲端硬碟快照分別屬於不同的 ECS 執行個體，則您可以通過返回結果中的`Snapshots.Snapshot.Tags.*`參數，查看組內單個快照所屬的執行個體 ID。	i-j6ca469urv8ei629****
Name	string	快照一致性組的名稱。	testName
ResourceGroupId	string	快照一致性組所屬的資源群組 ID。	rg-bp67acfmxazb4p****
Tags	object
Tag	array<object>	快照一致性組的標籤索引值對。
	object
Key	string	快照一致性組的標籤鍵。	TestKey
Value	string	快照一致性組的標籤值。	TestValue
Snapshots	object
Snapshot	array<object>	快照一致性組中包含的快照資訊組成的數組。
	array<object>
SourceDiskId	string	源雲端硬碟 ID。如果快照的源雲端硬碟已經被釋放，該欄位仍舊保留。	d-j6c3ogynmvpi6wy7****
Progress	string	快照建立進度，單位為百分比。	100%
Available	boolean	快照是否可用於建立雲端硬碟、復原雲端硬碟、共用快照。可能值： true：可用。 false：不可用。	false
InstantAccessRetentionDays	integer	快照極速可用功能的保留時間，保留時間到期後快照將自動釋放。說明該參數已棄用。ESSD 雲端硬碟標準快照已升級為預設極速可用，您無需額外配置，且不產生額外花銷。	3
SnapshotId	string	快照 ID。	s-j6cbzmrlbf09w72q****
InstantAccess	boolean	是否開啟了快照極速可用能力。可能值： true：開啟。ESSD 雲端硬碟預設開啟該能力。 false：關閉。即快照為未開啟極速可用能力的標準快照。說明該參數已棄用。ESSD 雲端硬碟標準快照已升級為預設極速可用，您無需額外配置，且不產生額外花銷。	true
SourceDiskType	string	源雲端硬碟類型。可能值： system：系統硬碟。 data：資料盤。	system
Tags	object
Tag	array<object>	快照一致性組內各個快照的標籤索引值對。預設包含了快照來源的資訊。
	object
Key	string	快照一致性組內各個快照的標籤鍵。Key 和 Value 的預設值中提供了快照來源資訊。	acs:ecs:createFrom
Value	string	快照一致性組內各個快照的標籤值。Key 和 Value 的預設值中提供了快照來源資訊。	i-bp11qm0o3dk4iuc****

樣本

正常返回樣本

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A",
  "SnapshotGroups": {
    "SnapshotGroup": [
      {
        "Status": "accomplished",
        "CreationTime": "2021-03-23T10:58:48Z",
        "Description": "This is description.",
        "ProgressStatus": "null",
        "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
        "InstanceId": "i-j6ca469urv8ei629****",
        "Name": "testName",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Snapshots": {
          "Snapshot": [
            {
              "SourceDiskId": "d-j6c3ogynmvpi6wy7****",
              "Progress": "100%",
              "Available": false,
              "InstantAccessRetentionDays": 3,
              "SnapshotId": "s-j6cbzmrlbf09w72q****",
              "InstantAccess": true,
              "SourceDiskType": "system",
              "Tags": {
                "Tag": [
                  {
                    "Key": "acs:ecs:createFrom",
                    "Value": "i-bp11qm0o3dk4iuc****"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	標籤中存在重複的鍵，請保持鍵的唯一性。
403	InvalidSnapshotGroupId.MustBeOne	The size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.
403	InvalidStatus.ValueNotSupported	The specified parameter status is not valid. The expected status is progressing, accomplished or failed.	指定的參數status是無效的，期望的status是progressing、accomplished或者failed。
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	地區資訊錯誤
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.

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

變更歷史

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