DescribeSnapshotGroups--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeSnapshotGroups

最近更新时间：2024.11.01 18:49:57首次发布时间：2024.02.01 16:03:50

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSnapshotGroups	要执行的操作，取值：DescribeSnapshotGroups。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
SnapshotGroupIds.N	Array of String	否	sg-4sduwo75f9en37xq****	查询的快照一致性组ID。说明 `N`表示快照一致性组ID的序号，多个快照一致性组ID之间用`&`分隔，取值范围为1～10。
ProjectName	String	否	default	快照一致性组所属项目。
InstanceId	String	否	i-ycmu5f4nfphhw5dh****	快照一致性组所属的ECS实例ID。
Name	String	否	testName	快照一致性组的名称。
Status.N	Array of String	否	available	快照一致性组的状态，取值如下： Creating：创建中 Available：可用 failed：错误说明 `N`表示快照一致性组状态的序号，多个快照一致性组状态之间用`&`分隔，取值范围为1～10。
PageSize	Integer	否	10	每页大小，默认为10。
PageNumber	Integer	否	1	起始页，默认为1。

返回数据

名称	类型	示例值	描述
PageSize	Integer	15	每页大小。
PageNumber	Integer	1	页数。
TotalCount	Integer	1	快照一致性组总的数量。
SnapshotGroups	Array of SnapshotGroup	-	快照一致性组信息列表，具体请参见下表“SnapshotGroups结构”。

SnapshotGroups结构

名称	类型	示例值	描述
SnapshotGroupId	String	sg-4sduwo75f9en37xq****	快照一致性组ID。
CreationTime	String	2023-11-06T06:38:51+08:00	创建时间。
InstanceId	String	i-ycmu5f4nfphhw5dh****	ECS实例ID。
Status	String	available	快照一致性组的状态。
Name	String	test-name	快照一致性组的名称。
Description	String	data	快照一致性组的描述。
ProjectName	String	default	快照一致性组所属项目。
ImageId	String	image-ycta6yy1oghhw66t****	快照一致性组的镜像ID。
Tags	Array of Tag	-	快照一致性组的标签，具体请参见下表“Tags结构”。
Snapshots	Array of Snapshots	-	快照信息列表，具体请参见下表“Snapshots结构”。

Tags结构

名称	类型	示例值	描述
Key	String	testkey	快照一致性组的标签键。
Value	String	testvalue	快照一致性组的标签值。

Snapshots结构

名称	类型	示例值	描述
SnapshotId	String	snap-4sduwo75faen383x****	快照ID。
ZoneId	String	cn-beijing-a	快照所属可用区。
VolumeId	String	vol-g8blwv5s83lzq2h5****	云盘ID。
Status	String	available	快照状态，取值如下： available：可用。 creating：创建中。 rollbacking：回滚中。 deleted：已删除。 failed：错误。
SnapshotName	String	Created-from-sg-4sduwo75f9en37xq74xh	快照名称。
Description	String	data	快照描述。
CreationTime	String	2023-11-06T06:38:51+08:00"	快照创建时间。
SnapshotType	String	user	快照类型，取值说明如下： user：手动创建的快照。 auto: 通过自动快照策略创建的快照。
VolumeType	String	ESSD_PL0	云盘类型，取值说明如下： ESSD_PL0：极速型SSD云盘，PL0规格。 ESSD_FlexPL: 极速型SSD云盘，FlexPL规格。
VolumeSize	Integer	200	云盘大小，单位GiB。
VolumeKind	String	system	云盘种类，取值说明如下: system：系统盘。 data：数据盘。
VolumeName	String	cm-test-img-reserved-volume-1-2	云盘名称。
VolumeStatus	String	available	云盘状态，取值说明如下： available：可用。 attaching：挂载中。 attached：已挂载。 detaching：卸载中。 creating：创建中。 deleting：删除中。 error：错误。 extending：扩容中。
RetentionDays	Integer	30	自动快照保留天数。
ProjectName	String	default	快照所属项目。
ImageId	String	image-yubc9nsmoghyu8v****	快照的镜像ID。
Progress	Integer	20	快照转储进度。
Tags	Array of Tag	-	快照的标签，具体请参见下表“Tags结构”。

Tags结构

名称	类型	示例值	描述
Key	String	aaa	快照的标签键
Value	String	bbb	快照的标签值。

请求示例

GET /?Action= DescribeSnapshotGroups&Version=2020-04-01&SnapshotGroupIds.1=sg-4sduwo75f9en37xq**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
  "ResponseMetadata": {
    "RequestId": "c5725893-f888-43f2-90a7-770c67a0****",
    "Action": "DescribeSnapshotGroups",
    "Version": "2020-04-01",
    "Service": "storage_ebs",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 15,
    "SnapshotGroups": [
      {
        "CreationTime": "2023-11-06T06:38:51+08:00",
        "Description": "",
        "ImageId": "",
        "InstanceId": "i-ycmu5f4nfphhw5dh****",
        "Name": "test-name",
        "ProjectName": "default",
        "SnapshotGroupId": "sg-4sduwo75f9en37xq****",
        "Snapshots": [
          {
            "CreationTime": "2023-11-06T06:38:51+08:00",
            "Description": "",
            "ImageId": "",
            "ProjectName": "default",
            "SnapshotGroupId": "sg-4sduwo75f9en37xq****",
            "SnapshotId": "snap-4sduwo75faen383x****",
            "SnapshotName": "Created-from-sg-4sduwo75f9en37x****",
            "SnapshotType": "user",
            "Status": "available",
            "VolumeId": "vol-g8blwv5s83lzq2h5****",
            "VolumeKind": "system",
            "VolumeName": "cm-test-img-reserved-volume-1-2",
            "VolumeSize": 200,
            "VolumeStatus": "",
            "VolumeType": "ESSD_PL0",
            "ZoneId": "cn-beijing-a"
          }
        ],
        "Status": "available",
        "Tags": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ],
    "TotalCount": 1
  }
}

错误码

无特殊错误码。