DescribeSnapshotGroups - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the information of one or more snapshot-consistent groups.

Operation description

Usage notes

You can specify multiple request parameters to be queried, such as InstanceId, SnapshotGroupId.N, and Status.N. Specified parameters have logical AND relations. Only the specified parameters are included in the filter conditions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the snapshot-consistent group. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	No	The ID of the instance.	i-j6ca469urv8ei629****
Name	string	No	The name of the snapshot-consistent group.	testName
NextToken	string	No	The token that determines the start point of the next query. Set the value to the NextToken value that is returned from the last call.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
SnapshotGroupId	array	No	The ID of snapshot-consistent group N. Valid values of N: 1 to 10.
	string	No	The ID of snapshot-consistent group N. Valid values of N: 1 to 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	No	The state of snapshot-consistent group N. Valid values of the second N: 1, 2, and 3. Valid values: progressing: The snapshot-consistent group is being created. accomplished: The snapshot-consistent group is created. failed: The snapshot-consistent group fails to be created.
	string	No	The state of snapshot-consistent group N. Valid values of the second N: 1, 2, and 3. Valid values: progressing: The snapshot-consistent group is being created. accomplished: The snapshot-consistent group is created. failed: The snapshot-consistent group fails to be created.	accomplished
AdditionalAttributes	array	No	This parameter is not publicly available.
	string	No	Note This parameter is not publicly available.	hide
Tag	object []	No	The tags of the snapshot-consistent group.
Key	string	No	The key of tag N of the snapshot-consistent group. Valid values of N: 1 to 20.	TestKey
Value	string	No	The value of tag N 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 parameters

Parameter	Type	Description	Example
	object
NextToken	string	The token used to start the next query. Note If the return value is empty, no more data exists.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object []	Details of the snapshot-consistent groups.
Status	string	The state of the snapshot-consistent group. Valid values: progressing: The snapshot-consistent group was being created. accomplished: The snapshot-consistent group was created. failed: The snapshot-consistent group failed to be created.	accomplished
CreationTime	string	The time when the snapshot-consistent group was created.	2021-03-23T10:58:48Z
Description	string	The description of the snapshot-consistent group.	This is description.
ProgressStatus	string	Note This parameter is not publicly available.	null
SnapshotGroupId	string	The ID of the snapshot-consistent group.	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	The ID of the instance to which the snapshot-consistent group belongs. This parameter has a value only when all disk snapshots in the snapshot-consistent group belong to the same instance. If disk snapshots in the snapshot-consistent group belong to different instances, you can check the response parameters that start with `Snapshots.Snapshot.Tags.` to determine the ID of the instance to which each snapshot in the snapshot-consistent group belongs.	i-j6ca469urv8ei629****
Name	string	The name of the snapshot-consistent group.	testName
ResourceGroupId	string	The ID of the resource group to which the snapshot-consistent group belongs.	rg-bp67acfmxazb4p****
Tags	object []	The tags of the snapshot-consistent group.
Key	string	The tag key of the snapshot-consistent group.	TestKey
Value	string	The tag value of the snapshot-consistent group.	TestValue
Snapshots	object []	Details of the snapshots in the snapshot-consistent group.
SourceDiskId	string	The ID of the source disk. This parameter is retained even after the source disk of the snapshot is released.	d-j6c3ogynmvpi6wy7****
Progress	string	The progress of the snapshot creation task. Unit: percent (%).	100%
Available	boolean	Indicates whether the snapshot can be used to create or roll back disks. Valid values: true false	false
InstantAccessRetentionDays	integer	The retention period of the instant access feature. After the retention period ends, the snapshot is automatically released. Note This parameter is deprecated. The normal snapshots of enhanced SSDs (ESSDs) are upgraded to support the instant access feature by default. No additional configurations are required to enable the feature and you are not charged for the feature. For more information, see Use the instant access feature.	3
SnapshotId	string	The ID of the snapshot.	s-j6cbzmrlbf09w72q****
InstantAccess	boolean	Indicates whether the instant access feature is enabled. Valid values: true: The instant access feature is enabled. By default, the instant access feature is enabled for ESSDs. false: The instant access feature is disabled. The snapshot is a normal snapshot for which the instant access feature is disabled.	true
SourceDiskType	string	The type of the source disk. Valid values: system: system disk data: data disk	system
Tags	object []	The tags of the snapshot. The default values contain snapshot source information.
Key	string	The tag key of the snapshot. The default values of Key and Value contain snapshot source information.	acs:ecs:createFrom
Value	string	The tag value of the snapshot. The default values of Key and Value contain snapshot source information.	i-bp11qm0o3dk4iuc****

Examples

Sample success responses

JSONformat

{
  "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****"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidStatus.ValueNotSupported	%s	The resource is in a state that does not support the current operation.
403	InvalidSnapshotGroupId.MustBeOne	The size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.	-
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	The RegionId provided does not exist

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-09-18

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 403
	delete Error Codes: 404
Output Parameters	The response structure of the API has changed.