建立快照
您可以使用 `CreateSnapshot`建立磁碟區的某個時間點的副本。您可以從任何磁碟區或現有快照建立快照。
如果您未透過此 API 方法提供 SnapshotID,則會從磁碟區的活動分支建立快照。如果從中建立快照的磁碟區正在複製到遠端集群,則快照也可以複製到相同目標。使用 enableRemoteReplication 參數啟用快照複製。
|
|
如果叢集容量處於第 1、2 或 3 階段,則可以建立快照。當叢集容量達到 4 或 5 級時,無法建立快照。 |
參數
此方法有以下輸入參數:
| Name | 描述 | 類型 | 預設值 | 必需的 |
|---|---|---|---|---|
|
JSON 物件格式的名稱-值對清單。 |
JSON 物件 |
沒有任何 |
不 |
|
指定是否將快照複製到遠端儲存。可能的值:
|
布林值 |
錯誤的 |
不 |
|
指定如果先前的快照複製正在進行中,則不應建立快照。可能的值有:
|
布林值 |
|
不 |
過期時間 |
指定快照可以刪除的時間。不能與…一起使用 |
細繩 |
沒有任何 |
不 |
|
快照的名稱。如果沒有輸入名稱,則使用拍攝快照的日期和時間。名稱長度上限為 255 個字元。 |
細繩 |
沒有任何 |
不 |
|
此參數與以下參數相同: `expirationTime`參數,但時間格式為 HH:mm:ss。如果兩者都不是 `expirationTime`也不 `retention`如果指定了快照,則快照將不會過期。 |
細繩 |
沒有任何 |
不 |
|
SnapMirror軟體用於指定SnapMirror端點上的快照保留策略的標籤。 |
細繩 |
沒有任何 |
不 |
|
用於建立新快照的快照的唯一 ID。傳遞的 snapshotID 必須是給定磁碟區上的快照。 |
整數 |
沒有任何 |
不 |
|
要從中複製的磁碟區映像的唯一 ID。 |
整數 |
沒有任何 |
是的 |
傳回值
此方法具有以下傳回值:
Name |
描述 |
類型 |
校驗和 |
表示已儲存快照中正確數字的字串。之後可以使用此校驗和來比較其他快照,以偵測資料中的錯誤。 |
細繩 |
snapshotID |
新快照的唯一識別碼。 |
快照 ID |
快照 |
包含有關新建立快照的資訊的物件。 |
請求範例
該方法的請求類似於以下範例:
{
"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
}
}
例外
當出現以下情況時,將顯示 xNotPrimary 異常: `CreateSnapshot`呼叫 API 後,快照建立失敗。這是預期行為。重試 `CreateSnapshot`API呼叫。
自版本以來的新版本
9.6