调用DescribeSnapshotGroups接口查询快照一致性组。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeSnapshotGroups

要执行的操作，取值：DescribeSnapshotGroups。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

SnapshotGroupIds.N string[] 可选示例值：sg-4sduwo75f9en37xq****

查询的快照一致性组ID。

说明

N表示快照一致性组ID的序号，多个快照一致性组ID之间用&分隔，取值范围为1～10。

ProjectName string 可选示例值：default

快照一致性组所属项目。

InstanceId string 可选示例值：i-ycmu5f4nfphhw5dh****

快照一致性组所属的ECS实例ID。

Name string 可选示例值：testName

快照一致性组的名称。

Status.N string[] 可选示例值：available

快照一致性组的状态，取值如下：

Creating：创建中

Available：可用

failed：错误

说明

N表示快照一致性组状态的序号，多个快照一致性组状态之间用&分隔，取值范围为1～10。

PageSize integer 可选示例值：10

每页大小，默认为10。

PageNumber integer 可选示例值：1

起始页，默认为1。

TagFilters.N.Key string[] 可选示例值：key1

快照一致性组的标签键。

TagFilters.N.Values.N string[] 可选示例值：value

快照一致性组的标签值。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageSize integer 示例值：10

每页大小。

PageNumber integer 示例值：1

页码。

TotalCount integer 示例值：2

快照一致性组的总数。

SnapshotGroups object[] 示例值：/

快照一致性组的详细信息。

ImageId string 示例值：image-yubc9nsmoghyu8v****

快照一致性组的镜像ID。

ProjectName string 示例值：default

项目名称。

Snapshots object[] 示例值：/

快照的详细信息。

SnapshotType string 示例值：user

快照类型，取值说明如下：

user：手动创建的快照。

auto: 通过自动快照策略创建的快照。

Description string 示例值：data

快照描述。

ZoneId string 示例值：cn-beijing-a

快照所属可用区。

CreationTime string 示例值：2023-11-06T06:38:51+08:00"

快照创建时间。

SnapshotName string 示例值：Created-from-sg-4sduwo75f9en37xq74xh

快照名称。

Status string 示例值：available

快照状态，取值如下：

available：可用。

creating：创建中。

rollbacking：回滚中。

deleted：已删除。

failed：错误。

VolumeId string 示例值：vol-g8blwv5s83lzq2h5****

云盘ID。

VolumeSize long 示例值：200

云盘大小，单位GB。

VolumeType string 示例值：data

云盘类型，取值说明如下：

ESSD_PL0：极速型SSD云盘，PL0规格。

ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。

SnapshotId string 示例值：snap-4sduwo75faen383x****

快照ID。

VolumeName string 示例值：cm-test-img-reserved-volume-1-2

云盘名称。

ProjectName string 示例值：default

快照所属项目。

VolumeKind string 示例值：data

云盘种类，取值说明如下:

system：系统盘。

data：数据盘。

VolumeStatus string 示例值：available

云盘状态，取值说明如下：

available：可用。

attaching：挂载中。

attached：已挂载。

detaching：卸载中。

creating：创建中。

deleting：删除中。

error：错误。

extending：扩容中。

RetentionDays integer 示例值：30

自动快照保留天数。

Progress integer 示例值：20

快照转储进度。

SnapshotGroupId string 示例值：sg-3wr1z86cky4p5d6d****

快照一致性组ID。

ImageId string 示例值：image-yubc9nsmoghyu8v****

快照的镜像ID。

Shared boolean 示例值：true

该快照是否被共享给他人。

Tags object[] 示例值：/

快照的标签。

Key string 示例值：user

快照一致性组的标签键。

Value string 示例值：aaa

快照一致性组的标签值。

InstantAccess boolean 示例值：true

快照是否启用极速可用能力，取值说明如下：

true：启用

false：未启用

SnapshotGroupId string 示例值：sg-4sduwo75f9en37xq****

快照一致性组的ID。

InstanceId string 示例值：i-ycmu5f4nfphhw5dh****

快照一致性组所属的ECS实例ID

CreationTime string 示例值：2023-11-06T06:38:51+08:00

快照一致性组的创建时间。

Description string 示例值：data

快照一致性组的描述。

Name string 示例值：test-name

快照一致性组的名称。

Status string 示例值：available

快照一致性组的状态。

Tags object[] 示例值：/

快照一致性组的标签。

Key string 示例值：user

快照一致性组的标签键。

Value string 示例值：aaa

快照一致性组的标签值。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrInvalidAccountId	account id invalid	账号ID无效。

云服务器