Use DescribeSnapshotGroups to query snapshot-consistent group information - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries information about one or more snapshot-consistent groups, such as the status, instance ID, and snapshot creation progress.

Operation description

InstanceId, SnapshotGroupId.N, and Status.N are not required request parameters, but you can use them to build filter logic. The parameters have a logical AND relationship.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeSnapshotGroups

get

SnapshotGroup

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

SnapshotGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
InstanceId	string	No	The instance ID.	i-j6ca469urv8ei629****
Name	string	No	The name of the snapshot-consistent group.	testName
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous API call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The maximum number of entries per page in a paging query. Maximum value: 100. Default value: 10.	10
SnapshotGroupId	array	No	The ID of the snapshot-consistent group. Valid values of N: 1 to 10.	ssg-j6ciyh3k52qp7ovm****
	string	No	The ID of the snapshot-consistent group. Valid values of N: 1 to 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	No	The status of the snapshot-consistent group. Valid values of N: 1 to 3. Valid values: progressing: The snapshot-consistent group is being created. accomplished: The snapshot-consistent group is created. failed: The snapshot-consistent group failed to be created.	accomplished
	string	No	The status of the snapshot-consistent group. Valid values of N: 1 to 3. Valid values: progressing: The snapshot-consistent group is being created. accomplished: The snapshot-consistent group is created. failed: The snapshot-consistent group failed to be created.	accomplished
AdditionalAttributes	array	No	This parameter is not publicly available.	hide
	string	No	Note This parameter is not publicly available.	null
Tag	array<object>	No	The tag key-value pairs of the snapshot-consistent group.
	object	No	The tag key-value pairs of the snapshot-consistent group.
Key	string	No	The tag key of the snapshot-consistent group. Valid values of N: 1 to 20.	TestKey
Value	string	No	The tag value of the snapshot-consistent group. Valid values of N: 1 to 20.	TestValue
ResourceGroupId	string	No	The ID of the resource group to which the snapshot-consistent group belongs.	rg-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token for the next query. Note If this parameter is empty, no more results are available.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	The information about the snapshot-consistent groups.
	array<object>	The details of the snapshot-consistent group.
SnapshotGroupId	string	The ID of the snapshot-consistent group.	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	The instance ID of the snapshot-consistent group. This parameter is returned only when all disk snapshots in the snapshot-consistent group belong to the same instance. If the disk snapshots in the snapshot-consistent group belong to different ECS instances, you can use the `Snapshots.Snapshot.Tags.*` parameter in the response to query the instance ID of each individual snapshot in the group.	i-j6ca469urv8ei629****
Status	string	The status of the snapshot-consistent group. Valid values: progressing: being created. accomplished: created. failed: failed to be created.	accomplished
ProgressStatus	string	Note This parameter is not publicly available.	null
Name	string	The name of the snapshot-consistent group.	testName
Description	string	The description.	This is description.
CreationTime	string	The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-03-23T10:58:48Z
ResourceGroupId	string	The ID of the resource group to which the snapshot-consistent group belongs.	rg-bp67acfmxazb4p****
Tags	object
Tag	array<object>	The tag key-value pairs of the snapshot-consistent group.
	object
Key	string	The tag key of the snapshot-consistent group.	TestKey
Value	string	The tag value of the snapshot-consistent group.	TestValue
Snapshots	object
Snapshot	array<object>	The information about the snapshots in the snapshot-consistent group.
	array<object>
SnapshotId	string	The snapshot ID.	s-j6cbzmrlbf09w72q****
SourceDiskId	string	The ID of the source disk. This field is retained even if the source disk of the snapshot has been released.	d-j6c3ogynmvpi6wy7****
SourceDiskType	string	The type of the source disk. Valid values: system: system disk. data: data disk.	system
Available	boolean	Indicates whether the snapshot can be used to create disks, roll back disks, or share snapshots. Valid values: true: available. false: not available.	false
Progress	string	The snapshot creation progress, in percentage.	100%
InstantAccess	boolean	Indicates whether the snapshot instant access feature is enabled. Valid values: true: enabled. This feature is enabled by default for enterprise SSD disks. false: disabled. The snapshot is a standard snapshot without the instant access feature enabled. Note This parameter is deprecated. Standard snapshots of enterprise SSD disks have been upgraded to instant access enabled by default. No additional configuration or fees are required.	true
InstantAccessRetentionDays	integer	The retention period of the snapshot instant access feature. After the retention period expires, the snapshot undergoes automatic release. Note This parameter is deprecated. Standard snapshots of enterprise SSD disks have been upgraded to instant access enabled by default. No additional configuration or fees are required.	3
Tags	object
Tag	array<object>	The tag key-value pairs of each snapshot in the snapshot-consistent group. By default, the source information of the snapshot is included.
	object
Key	string	The tag key of each snapshot in the snapshot-consistent group. The default values of Key and Value contain the source information of the snapshot.	acs:ecs:createFrom
Value	string	The tag value of each snapshot in the snapshot-consistent group. The default values of Key and Value contain the source information of the snapshot.	i-bp11qm0o3dk4iuc****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
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.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.