调用DescribeSnapshotGroups查询一个或多个快照一致性组的信息-阿里云帮助中心

接口说明

InstanceId、SnapshotGroupId.N和Status.N不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSnapshotGroups	系统规定参数。取值：DescribeSnapshotGroups。
RegionId	String	是	cn-hangzhou	所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
InstanceId	String	否	i-j6ca469urv8ei629****	指定的实例ID。
Name	String	否	testName	快照一致性组的名称。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a4883	查询凭证（Token），取值为上一次API调用返回的NextToken参数值。
MaxResults	Integer	否	10	分页查询时每页行数。最大值为100。默认值为10。
SnapshotGroupId.N	String	否	ssg-j6ciyh3k52qp7ovm****	指定的快照一致性组ID。N的取值范围为1~10。
Status.N	String	否	accomplished	快照一致性组的状态。N的取值范围：1~3。取值如下： progressing：创建中。 accomplished：创建成功。 failed：创建失败。
AdditionalAttributes.N	String	否	null	说明该参数暂未开放使用。
Tag.N.Key	String	否	TestKey	快照一致性组的标签键。N的取值范围为1~20。
Tag.N.Value	String	否	TestValue	快照一致性组的标签值。N的取值范围为1~20。
ResourceGroupId	String	否	rg-bp67acfmxazb4p****	快照一致性组所属的资源组ID。

返回数据

名称	类型	示例值	描述
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	下一个查询起始标志。说明该返回值为空时，表示无更多返回的数据信息。
RequestId	String	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A	请求ID。
SnapshotGroups	Array of SnapshotGroup		快照一致性组的信息组成的数组。
SnapshotGroup
Status	String	accomplished	快照一致性组的状态。可能值： progressing：创建中。 accomplished：创建成功。 failed：创建失败。
CreationTime	String	2021-03-23T10:58:48Z	创建时间。
Description	String	This is description.	描述。
ProgressStatus	String	null	说明该参数暂未开放使用。
SnapshotGroupId	String	ssg-j6ciyh3k52qp7ovm****	快照一致性组ID。
InstanceId	String	i-j6ca469urv8ei629****	快照一致性组所属的实例ID。该参数仅当快照一致性组内的所有云盘快照属于同一实例时有返回值。如果您的快照一致性组内的多个云盘快照分别属于不同的ECS实例，则您可以通过返回结果中的`Snapshots.Snapshot.Tags.*`参数，查看组内单个快照所属的实例ID。
Name	String	testName	快照一致性组的名称。
ResourceGroupId	String	rg-bp67acfmxazb4p****	快照一致性组所属的资源组ID。
Tags	Array of Tag		快照一致性组的标签键值对。
Tag
Key	String	TestKey	快照一致性组的标签键。
Value	String	TestValue	快照一致性组的标签值。
Snapshots	Array of Snapshot		快照一致性组中包含的快照信息组成的数组。
Snapshot
SourceDiskId	String	d-j6c3ogynmvpi6wy7****	源云盘ID。如果快照的源云盘已经被释放，该字段仍旧保留。
Progress	String	100%	快照创建进度，单位为百分比。
Available	Boolean	false	快照是否可用于创建云盘、回滚云盘。可能值： true：可用。 false：不可用。
InstantAccessRetentionDays	Integer	3	快照极速可用功能的保留时间，保留时间到期后快照将自动释放。
SnapshotId	String	s-j6cbzmrlbf09w72q****	快照ID。
InstantAccess	Boolean	true	是否开启了快照极速可用功能。可能值： true：开启。仅ESSD云盘支持开启该功能。 false：关闭。即快照为未开启快照极速可用功能的普通快照。
SourceDiskType	String	system	源云盘类型。可能值： system：系统盘。 data：数据盘。
Tags	Array of Tag		快照一致性组内各个快照的标签键值对。默认包含了快照来源的信息。
Tag
Key	String	acs:ecs:createFrom	快照一致性组内各个快照的标签键。Key和Value的默认值中提供了快照来源信息。
Value	String	i-bp11qm0o3dk4iuc****	快照一致性组内各个快照的标签值。Key和Value的默认值中提供了快照来源信息。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeSnapshotGroups
&RegionId=cn-hangzhou
&SnapshotGroupId.1=ssg-j6ciyh3k52qp7ovm****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSnapshotGroupsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A</RequestId>
    <SnapshotGroups>
        <SnapshotGroup>
            <Status>accomplished</Status>
            <Description>This is description.</Description>
            <InstanceId/>
            <CreationTime>2021-03-23T10:58:48Z</CreationTime>
            <SnapshotGroupId>ssg-j6ciyh3k52qp7ovm****</SnapshotGroupId>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Name>testName</Name>
            <Tags>
                <Tag>
                    <Value>TestValue</Value>
                    <Key>TestKey</Key>
                </Tag>
            </Tags>
            <Snapshots>
                <Snapshot>
                    <SnapshotId>s-j6cbzmrlbf09w72q****</SnapshotId>
                    <Progress>100%</Progress>
                    <Available>false</Available>
                    <InstantAccessRetentionDays>3</InstantAccessRetentionDays>
                    <SourceDiskType>system</SourceDiskType>
                    <SourceDiskId>d-j6c3ogynmvpi6wy7****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <Value>i-bp11qm0o3dk4iuc****</Value>
                            <Key>acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </Snapshot>
                <Snapshot>
                    <SnapshotId>s-bp1fgrjucs8wr31****</SnapshotId>
                    <Progress>100%</Progress>
                    <SourceDiskType>system</SourceDiskType>
                    <SourceDiskId>d-bp1bcsu5leotddp****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <Value>i-bp1emqgxsg88zdl****</Value>
                            <Key>acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </Snapshot>
            </Snapshots>
        </SnapshotGroup>
    </SnapshotGroups>
</DescribeSnapshotGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode	错误码	错误信息	描述
403	InvalidStatus.ValueNotSupported	%s	该资源当前的状态不支持此操作。

访问错误中心查看更多错误码。