跳到主要内容

查詢雲硬碟快照

描述

查詢雲硬碟快照資訊,可查詢一條或多條記錄,可根據名稱等多個查詢條件查詢

請求引數

引數名引數型別是否必填引數說明
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.yunpanel.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
    }]
    }
    }