You need to enable JavaScript to run this app.
导航
DescribeSnapshots
最近更新时间:2024.04.25 17:11:26首次发布时间:2022.04.28 10:05:43

调用DescribeSnapshots接口查询快照列表。

调试

请求参数

名称类型是否必填示例值描述
ActionStringDescribeSnapshots要执行的操作,取值:DescribeSnapshots
SnapshotIds.NStringSnapshotIds.1=snap-31akybwsxi8rudc6****&SnapshotIds.2=snap-31ak39j5bh8rubsn****需要查询的快照ID。
VolumeIdStringvol-bp1s5fnvk4gn2tws0****快照相关的云盘ID。
SnapshotNameStringtestSnapshotName快照名称。

SnapshotStatus.N

Aarray

available

快照状态,取值说明如下:

  • available:可用。
  • creating:创建中。
  • rollbacking:回滚中。
  • deleted:已删除。
  • failed:错误。
ZoneIdStringcn-beijing-a可用区ID。
PageSizeInt10每页查询数量,默认为10。
PageNumberInt1起始页,默认为1。
Filter.1.KeyStringCreationStartTime查询资源时的筛选键,取值必须为CreationStartTime。同时设置Filter.1.KeyFilter.1.Value可以查询在指定时间点后创建的资源信息。
Filter.1.ValueString2019-12-13T17:00Z查询资源时的筛选值。指定该参数时必须同时指定Filter.1.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用UTC +0时区。
Filter.2.KeyStringCreationEndTime查询资源时的筛选键,取值必须为CreationEndTime。同时设置Filter.2.KeyFilter.2.Value可以查询在指定时间点前创建的资源信息。
Filter.2.ValueString2019-12-13T22:00Z查询资源时的筛选值。指定该参数时必须同时指定Filter.2.Key参数,格式为:yyyy-MM-ddTHH:mmZ,采用UTC +0时区。
ProjectNameStringdefault根据快照所属的Project(项目)名筛选快照。

TagFilters.N.Key

String

TagFilters.1.Key=tag

根据标签查询资源时指定的标签键。说明如下:

  • TagFilters.N.Key:N表示标签键的序号。取值范围:1~10。

  • 多个标签键之间用&分隔,不允许重复。

  • 不传入该参数则表示查询所有标签。

  • 传入空字符串时,则返回错误码InvalidTagFilterKey.Malformed

TagFilters.N.Values.N

String

TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test

根据标签查询资源时指定的标签值。说明如下:

  • TagFilters.N.Values.N:第一个N表示标签键的序号。取值范围:1~10。

  • TagFilters.N.Values.N:第二个N表示标签值的序号。取值范围:1~3。

  • 多个标签值之间用&分隔。

  • 如果传入该参数,则必须先传入TagFilters.N.Key

  • 不传入该参数则表示查询同一标签键下的所有标签值。

  • 传入空字符串时,表示查询标签值为空的标签。

返回数据

名称类型示例值说明
PageSizeInt1每页查询数量。
PageNumberInt10查询起始页。
TotalCountInt1查询的快照总个数。
SnapshotsArray of Snapshot-快照详情集合,具体请参见下表“Snapshots结构”。

Snapshots结构

名称类型示例值说明
CreationTimeString2021-12-12 03:33:04.374716快照创建时间。
DescriptionStringtest快照描述信息。
SnapshotIdStringsnap-3tigy72q3u3vj0x2****快照ID。
SnapshotNameStringsnapshotname快照名称。

SnapshotType

String

user

快照类型,取值说明如下:

  • user:手动快照。
  • auto:自动快照。

Status

String

available

快照状态,取值说明如下:

  • available:可用。
  • creating:创建中。
  • rollbacking:回滚中。
  • deleted:已删除。
  • failed:错误。
VolumeIdStringvol-bp1s5fnvk4gn2tws0****云盘ID。

VolumeKind

String

system

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

  • system:系统盘。
  • data:数据盘。
VolumeNameStringtest云盘名称。
VolumeSizeInt20云盘大小,单位为GiB。
VolumeStatusStringavailable云盘状态,取值说明如下:
  • available:可用
  • attaching:挂载中
  • attached:已挂载
  • detaching:卸载中
  • creating:创建中
  • deleting:删除中
  • error:错误
  • extending:扩容中
  • VolumeType

    String

    ESSD_PL0

    云盘类型,取值说明如下:

    • ESSD_PL0:极速型SSD云盘,PL0规格。
    • ESSD_FlexPL:极速型SSD云盘,FlexPL规格。
    ZoneIdStringcn-beijing-a快照所在的可用区ID。
    RetentionDaysInt30自动快照的保留天数。
    ProjectNameStringdefault快照所属项目。
    TagsArray of Struct-快照的标签信息,具体请参见下表“ Tag结构 ”。

    Tag结构

    名称类型示例值描述
    KeyStringtag快照的标签键。
    ValueStringtest快照的标签值。

    请求示例

    GET /?Action=DescribeSnapshots&SnapshotIds.1=snap-31akybwsxi8rudc6****&SnapshotIds.2=snap-31ak39j5bh8rubsn****&Version=2020-04-01 HTTP/1.1
    Host: open.volcengineapi.com
    Region: cn-beijing
    ServiceName: storage_ebs
    

    返回示例

    {
     		"ResponseMetadata": {
        		"RequestId": "20220311010333010194099035060C0***",
            "Action": "DescribeSnapshots",
            "Version": "2020-04-01",
            "Service": "storage_ebs",
            "Region": "cn-beijing"
            },
            "Result": {
                    "PageNumber": 1,
                    "PageSize": 10,
                    "Snapshots": [{
                            "CreationTime": "2022-03-10T22:33:46+08:00",
                            "Description": "test",
                            "SnapshotId": "snap-31ak39j5bh8rubsn****",
                            "SnapshotName": "snapshot2",
                            "SnapshotType": "user",
                            "Status": "available",
                            "Tags": [
    				                    {
    				                        "Key": "tag",
    				                        "Value": "value"
    				                    }
    				                ],
                            "VolumeId": "vol-31ale588uo8rud93****",
                            "VolumeKind": "data",
                            "VolumeName": "snap_test",
                            "VolumeSize": 20,
                            "VolumeStatus": "available",
                            "VolumeType": "ESSD_PL0",
                            "ZoneId": "cn-beijing-b"
                            "ProjectName": "default"
                    }, {
                            "CreationTime": "2022-03-10T21:57:14+08:00",
                            "Description": "test",
                            "SnapshotId": "snap-31akybwsxi8rudc6****",
                            "SnapshotName": "snapshot",
                            "SnapshotType": "user",
                            "Status": "available",
                            "Tags": [
    				                    {
    				                        "Key": "tag",
    				                        "Value": "value"
    				                    }
    				                ],
                            "VolumeId": "vol-31ale588uo8rud93****",
                            "VolumeKind": "data",
                            "VolumeName": "snap_test",
                            "VolumeSize": 20,
                            "VolumeStatus": "available",
                            "VolumeType": "ESSD_PL0",
                            "ZoneId": "cn-beijing-b"
                            "ProjectName": "default"
                    }],
                    "TotalCount": 2
            }   
    } 
    

    错误码

    HttpCode错误码错误信息
    404InvalidFilterValueFilterValue非法