查詢雲硬碟快照
描述
查詢雲硬碟快照資訊,可查詢一條或多條記錄,可根據名稱等多個查詢條件查詢
請求引數
| 引數名 | 引數型別 | 是否必填 | 引數說明 |
|---|---|---|---|
| Action | String | 是 | 操作方法:DescribeSnapshots |
| Region | String | 是 | 機房標識,取值參見地域列表 |
| VolumeId | String | 否 | 雲硬碟ID |
| Id.N | String | 否 | 雲硬碟快照ID,支援批次,N為自然數,格式:&Id.0=xxx&Id.1=xxx等 |
| Name | String | 否 | 名稱 |
| StartTime | String | 否 | 建立開始時間 格式yyyy-MM-dd HH:mm:ss |
| EndTime | String | 否 | 建立結束時間 格式yyyy-MM-dd HH:mm:ss |
| Offset | String | 否 | 記錄偏移量,不指定取 0 |
| Count | String | 否 | 記錄數量,不指定為全部 |
| IsSystem | String | 否 | 根據系統型別查詢,取值範圍: |
返回引數
| 名稱 | 型別 | 說明 |
|---|---|---|
| Action | String | 執行的操作 |
| TaskId | String | 請求標識 |
| TotalCount | Integer | 過濾條件下總共記錄數 |
| SnapshotSet | SnapshotItemType | 由SnapshotItemType組成的陣列格式,返回雲硬碟快照資訊 |
SnapshotItemType
雲硬碟快照資訊的資料型別
| 名稱 | 型別 | 說明 |
|---|---|---|
| Id | String | 快照標識 |
| Name | String | 名稱 |
| Description | String | 描述資訊 |
| OwnerId | String | 快照所有者 |
| Process | String | 快照的進度 |
| Locked | Boolean | 快照是否鎖定,true-鎖定,false-未鎖定 |
| StartTime | DateTime | 開始時間 |
| Status | String | 快照狀態:CREATING,AVAILABLE,DELETING,ERROR,`ERROR_DELETING |
| VolumeId | String | 卷標識 |
| Size | Integer | 快照大小,這裡返回的大小單位為KB |
| IsFileLock | String | 是否是歸檔型別的快照 |
請求示例
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
}]
}
}