建立Snapshot
建議變更
PDF
您可以使用 `CreateSnapshot`建立磁碟區的時間點複本。您可以從任何磁碟區或現有的快照建立快照。
如果您未使用此API方法提供SnapshotID、則會從磁碟區的作用中分支建立快照。如果要將建立快照的磁碟區複寫到遠端叢集、也可以將快照複寫到相同的目標。使用enableRemoteReplication參數來啟用快照複寫。
|
如果叢集完整度處於階段1、2或3、您可以建立快照。叢集完整度達到階段4或5時、您無法建立快照。 |
參數
此方法具有下列輸入參數：
| 名稱 | 說明 | 類型 | 預設值 | 必要 |
|---|---|---|---|---|
|
Json物件格式的名稱-值配對清單。 |
Json物件 |
無 |
否 |
|
指定是否將快照複寫至遠端儲存設備。可能值：
|
布林值 |
錯 |
否 |
|
指定如果正在進行先前的快照複寫、則不應建立快照。可能的值包括：
|
布林值 |
|
否 |
過期時間 |
指定快照可移除的時間。無法與搭配 `retention`使用。如果未指定過期時間或保留時間、則快照不會過期。時間格式為ISO 8601日期字串、適用於基於時間的到期日、否則將不會過期。的值 `null`會導致永久保留快照。的值 `fifo`會使快照以先進先出的方式保留、相對於磁碟區上的其他 FIFO 快照。如果沒有可用的FIFO空間、API將會失敗。 |
字串 |
無 |
否 |
|
快照的名稱。如果未輸入名稱、則會使用拍攝快照的日期和時間。名稱長度上限為255個字元。 |
字串 |
無 |
否 |
|
此參數與參數相同 |
字串 |
無 |
否 |
|
SnapMirror軟體用來指定SnapMirror端點上的快照保留原則的標籤。 |
字串 |
無 |
否 |
|
用於建立新快照的快照的唯一ID。傳遞的SnapshotID必須是指定磁碟區上的快照。 |
整數 |
無 |
否 |
|
要複製之Volume映像的唯一ID。 |
整數 |
無 |
是的 |
傳回值
此方法具有下列傳回值：
名稱 |
說明 |
類型 |
Checksum |
代表儲存快照中正確數字的字串。此Checksum稍後可用於比較其他快照、以偵測資料中的錯誤。 |
字串 |
Snapshot ID |
新快照的唯一ID。 |
Snapshot ID |
Snapshot |
包含新建立之快照相關資訊的物件。 |
申請範例
此方法的要求類似於下列範例：
{
"method": "CreateSnapshot",
"params": {
"volumeID": 1
},
"id": 1
}
回應範例
此方法會傳回類似下列範例的回應：
{
"id": 1,
"result": {
"checksum": "0x0",
"snapshot": {
"attributes": {},
"checksum": "0x0",
"createTime": "2016-04-04T17:14:03Z",
"enableRemoteReplication": false,
"expirationReason": "None",
"expirationTime": null,
"groupID": 0,
"groupSnapshotUUID": "00000000-0000-0000-0000-000000000000",
"name": "2016-04-04T17:14:03Z",
"snapshotID": 3110,
"snapshotUUID": "6f773939-c239-44ca-9415-1567eae79646",
"status": "done",
"totalSize": 5000658944,
"virtualVolumeID": null,
"volumeID": 1
},
"snapshotID": 3110
}
}
例外狀況
呼叫 API 且無法建立快照時、會顯示 xNotPrimary 例外 CreateSnapshot。這是預期的行為。重試 CreateSnapshot API 呼叫。
新的自版本
9.6