All Products
Search
Document Center

Elastic Compute Service:DescribeSnapshotGroups

Last Updated:Sep 29, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeSnapshotGroupsget
  • SnapshotGroup
    acs:ecs:{#regionId}:{#accountId}:snapshotgroup/*
  • SnapshotGroup
    acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the snapshot-consistent group. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdstringNo

The ID of the instance.

i-j6ca469urv8ei629****
NamestringNo

The name of the snapshot-consistent group.

testName
NextTokenstringNo

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
MaxResultsintegerNo

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

10
SnapshotGroupIdarrayNo

The ID of snapshot-consistent group N. Valid values of N: 1 to 10.

stringNo

The ID of snapshot-consistent group N. Valid values of N: 1 to 10.

ssg-j6ciyh3k52qp7ovm****
StatusarrayNo

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.
stringNo

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
AdditionalAttributesarrayNo

This parameter is not publicly available.

stringNo
Note This parameter is not publicly available.
hide
Tagarray<object>No

The tags of the snapshot-consistent group.

objectNo

The tags of the snapshot-consistent group.

KeystringNo

The key of tag N of the snapshot-consistent group. Valid values of N: 1 to 20.

TestKey
ValuestringNo

The value of tag N of the snapshot-consistent group. Valid values of N: 1 to 20.

TestValue
ResourceGroupIdstringNo

The ID of the resource group to which the snapshot-consistent group belongs.

rg-bp67acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The token used to start the next query.

Note If the return value is empty, no more data exists.
caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The ID of the request.

3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroupsarray<object>

Details of the snapshot-consistent groups.

SnapshotGroupobject
Statusstring

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
CreationTimestring

The time when the snapshot-consistent group was created.

2021-03-23T10:58:48Z
Descriptionstring

The description of the snapshot-consistent group.

This is description.
ProgressStatusstring
Note This parameter is not publicly available.
null
SnapshotGroupIdstring

The ID of the snapshot-consistent group.

ssg-j6ciyh3k52qp7ovm****
InstanceIdstring

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****
Namestring

The name of the snapshot-consistent group.

testName
ResourceGroupIdstring

The ID of the resource group to which the snapshot-consistent group belongs.

rg-bp67acfmxazb4p****
Tagsarray<object>

The tags of the snapshot-consistent group.

Tagobject
Keystring

The tag key of the snapshot-consistent group.

TestKey
Valuestring

The tag value of the snapshot-consistent group.

TestValue
Snapshotsarray<object>

Details of the snapshots in the snapshot-consistent group.

Snapshotobject
SourceDiskIdstring

The ID of the source disk. This parameter is retained even after the source disk of the snapshot is released.

d-j6c3ogynmvpi6wy7****
Progressstring

The progress of the snapshot creation task. Unit: percent (%).

100%
Availableboolean

Indicates whether the snapshot can be used to create or roll back disks. Valid values:

  • true
  • false
false
InstantAccessRetentionDaysinteger

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
SnapshotIdstring

The ID of the snapshot.

s-j6cbzmrlbf09w72q****
InstantAccessboolean

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
SourceDiskTypestring

The type of the source disk. Valid values:

  • system: system disk
  • data: data disk
system
Tagsarray<object>

The tags of the snapshot. The default values contain snapshot source information.

Tagobject
Keystring

The tag key of the snapshot. The default values of Key and Value contain snapshot source information.

acs:ecs:createFrom
Valuestring

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 codeError codeError messageDescription
403InvalidStatus.ValueNotSupported%sThe resource is in a state that does not support the current operation.
403InvalidSnapshotGroupId.MustBeOneThe size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.-
404InvalidRegionId.NotFoundThe 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 timeSummary of changesOperation
2023-09-18The Error code has changed. The response structure of the API has changedView Change Details