查询一个或多个快照一致性组的信息。例如状态、所属的实例ID、快照创建进度等。
接口说明
InstanceId、SnapshotGroupId.N和Status.N不是必需的请求参数，但是可以构建过滤器逻辑，参数之间为逻辑与（And）关系。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:DescribeSnapshotGroups | get | SnapshotGroup acs:ecs:{#regionId}:{#accountId}:snapshotgroup/*SnapshotGroup acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| InstanceId | string | 否 | 指定的实例 ID。 | i-j6ca469urv8ei629**** |
| Name | string | 否 | 快照一致性组的名称。 | testName |
| NextToken | string | 否 | 查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。 | caeba0bbb2be03f84eb48b699f0a4883 |
| MaxResults | integer | 否 | 分页查询时每页行数。 最大值为 100。 默认值为 10。 | 10 |
| SnapshotGroupId | array | 否 | 指定的快照一致性组 ID。N 的取值范围为 1~10。 | |
| string | 否 | 指定的快照一致性组 ID。N 的取值范围为 1~10。 | ssg-j6ciyh3k52qp7ovm**** | |
| Status | array | 否 | 快照一致性组的状态。N 的取值范围为 1~3。取值如下：
| |
| string | 否 | 快照一致性组的状态。N 的取值范围：1~3。取值如下：
| accomplished | |
| AdditionalAttributes | array | 否 | 该参数暂未开放使用。 | |
| string | 否 | 说明
该参数暂未开放使用。
| null | |
| Tag | array<object> | 否 | 快照一致性组的标签键值对。 | |
| object | 否 | 快照一致性组的标签键值对。 | ||
| Key | string | 否 | 快照一致性组的标签键。N 的取值范围为 1~20。 | TestKey |
| Value | string | 否 | 快照一致性组的标签值。N 的取值范围为 1~20。 | TestValue |
| ResourceGroupId | string | 否 | 快照一致性组所属的资源组 ID。 | rg-bp67acfmxazb4p**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 标签中存在重复的键，请保持键的唯一性。 |
| 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. | 指定的参数status是无效的，期望的status是progressing、accomplished或者failed。 |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 地域信息错误 |
| 404 | InvalidInstanceId.NotFound | The InstanceId provided does not exist in our records. | 指定的实例不存在，请您检查实例 ID 是否正确。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-02-26 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2025-02-06 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-12-17 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-12-02 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-09-18 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |