文档

DescribeSnapshotGroups - 查询快照一致性组

更新时间:

调用DescribeSnapshotGroups查询一个或多个快照一致性组的信息。

接口说明

InstanceIdSnapshotGroupId.NStatus.N不是必需的请求参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeSnapshotGroupsRead
  • SnapshotGroup
    acs:ecs:{#regionId}:{#accountId}:snapshotgroup/*
  • SnapshotGroup
    acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}

请求参数

名称类型必填描述示例值
RegionIdstring

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
InstanceIdstring

指定的实例 ID。

i-j6ca469urv8ei629****
Namestring

快照一致性组的名称。

testName
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsinteger

分页查询时每页行数。

最大值为 100。

默认值为 10。

10
SnapshotGroupIdarray

指定的快照一致性组 ID。N 的取值范围为 1~10。

string

指定的快照一致性组 ID。N 的取值范围为 1~10。

ssg-j6ciyh3k52qp7ovm****
Statusarray

快照一致性组的状态。N 的取值范围为 1~3。取值如下:

  • progressing:创建中。

  • accomplished:创建成功。

  • failed:创建失败。

string

快照一致性组的状态。N 的取值范围:1~3。取值如下:

  • progressing:创建中。

  • accomplished:创建成功。

  • failed:创建失败。

accomplished
AdditionalAttributesarray

该参数暂未开放使用。

string
说明 该参数暂未开放使用。
null
Tagobject []

快照一致性组的标签键值对。

Keystring

快照一致性组的标签键。N 的取值范围为 1~20。

TestKey
Valuestring

快照一致性组的标签值。N 的取值范围为 1~20。

TestValue
ResourceGroupIdstring

快照一致性组所属的资源组 ID。

rg-bp67acfmxazb4p****

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询起始标志。

说明 该返回值为空时,表示无更多返回的数据信息。
caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroupsobject []

快照一致性组的信息组成的数组。

Statusstring

快照一致性组的状态。可能值:

  • progressing:创建中。

  • accomplished:创建成功。

  • failed:创建失败。

accomplished
CreationTimestring

创建时间。

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

描述。

This is description.
ProgressStatusstring
说明 该参数暂未开放使用。
null
SnapshotGroupIdstring

快照一致性组 ID。

ssg-j6ciyh3k52qp7ovm****
InstanceIdstring

快照一致性组所属的实例 ID。该参数仅当快照一致性组内的所有云盘快照属于同一实例时有返回值。如果您的快照一致性组内的多个云盘快照分别属于不同的 ECS 实例,则您可以通过返回结果中的Snapshots.Snapshot.Tags.*参数,查看组内单个快照所属的实例 ID。

i-j6ca469urv8ei629****
Namestring

快照一致性组的名称。

testName
ResourceGroupIdstring

快照一致性组所属的资源组 ID。

rg-bp67acfmxazb4p****
Tagsobject []

快照一致性组的标签键值对。

Keystring

快照一致性组的标签键。

TestKey
Valuestring

快照一致性组的标签值。

TestValue
Snapshotsobject []

快照一致性组中包含的快照信息组成的数组。

SourceDiskIdstring

源云盘 ID。如果快照的源云盘已经被释放,该字段仍旧保留。

d-j6c3ogynmvpi6wy7****
Progressstring

快照创建进度,单位为百分比。

100%
Availableboolean

快照是否可用于创建云盘、回滚云盘。可能值:

  • true:可用。
  • false:不可用。
false
InstantAccessRetentionDaysinteger

快照极速可用功能的保留时间,保留时间到期后快照将自动释放。

说明 该参数已弃用。ESSD 云盘普通快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。
3
SnapshotIdstring

快照 ID。

s-j6cbzmrlbf09w72q****
InstantAccessboolean

是否开启了快照极速可用能力。可能值:

  • true:开启。ESSD 云盘默认开启该能力。
  • false:关闭。即快照为未开启极速可用能力的普通快照。
true
SourceDiskTypestring

源云盘类型。可能值:

  • system:系统盘。
  • data:数据盘。
system
Tagsobject []

快照一致性组内各个快照的标签键值对。默认包含了快照来源的信息。

Keystring

快照一致性组内各个快照的标签键。Key 和 Value 的默认值中提供了快照来源信息。

acs:ecs:createFrom
Valuestring

快照一致性组内各个快照的标签值。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错误码错误信息描述
403InvalidStatus.ValueNotSupported%s该资源当前的状态不支持此操作。
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.提供的RegionId不存在

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

变更历史

变更时间变更内容概要操作
2023-09-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)