跳到主要内容

查询云硬盘快照

描述

查询云硬盘快照信息,可查询一条或多条记录,可根据名称等多个查询条件查询

请求参数

参数名参数类型是否必填参数说明
ActionString操作方法:DescribeSnapshots
RegionString机房标识,取值参见地域列表
VolumeIdString云硬盘ID
Id.NString云硬盘快照ID,支持批量,N为自然数,格式:&Id.0=xxx&Id.1=xxx等
NameString名称
StartTimeString创建开始时间 格式yyyy-MM-dd HH:mm:ss
EndTimeString创建结束时间 格式yyyy-MM-dd HH:mm:ss
OffsetString记录偏移量,不指定取 0
CountString记录数量,不指定为全部
IsSystemString根据系统类型查询,取值范围:
  • true-查询系统盘快照
  • false-查询数据盘快照(默认值)
  • 返回参数

    名称类型说明
    ActionString执行的操作
    TaskIdString请求标识
    TotalCountInteger过滤条件下总共记录数
    SnapshotSetSnapshotItemType由SnapshotItemType组成的数组格式,返回云硬盘快照信息

    SnapshotItemType

    云硬盘快照信息的数据类型

    名称类型说明
    IdString快照标识
    NameString名称
    DescriptionString描述信息
    OwnerIdString快照所有者
    ProcessString快照的进度
    LockedBoolean快照是否锁定,true-锁定,false-未锁定
    StartTimeDateTime开始时间
    StatusString快照状态:CREATING,AVAILABLE,DELETING,ERROR,`ERROR_DELETING
    VolumeIdString卷标识
    SizeInteger快照大小,这里返回的大小单位为KB
    IsFileLockString是否是归档类型的快照

    请求示例

    https://api.chinac.com/v2/?Action=DescribeSnapshots
    &Id=vs-xxx
    &VolumeId=true
    &公共参数

    返回示例

    {
    "code": 10000,
    "message": "",
    "data": {
    "TaskId":"l2c9i20170509175400941",
    "Action":"DescribeSnapshots",
    "TotalCount":1,
    "SnapshotSet":[{
    "Id":"vs-4e9ih44jti40a",
    "Name":"333",
    "Description":"3333",
    "OwnerId":"1890420",
    "Process":"",
    "StartTime":"2017-05-04T19:29:54 +0800",
    "Status":"AVAILABLE",
    "VolumeId":"v-lj9ih44ao882y",
    "Size":1,
    "Locked":false,
    "IsFileLock":false
    }]
    }
    }