创建快照
您可以使用 `CreateSnapshot`创建卷的某个时间点的副本。您可以从任何卷或现有快照创建快照。
如果您未通过此 API 方法提供 SnapshotID,则会从卷的活动分支创建快照。如果从中创建快照的卷正在复制到远程集群,则快照也可以复制到同一目标。使用 enableRemoteReplication 参数启用快照复制。
|
|
如果集群容量处于第 1、2 或 3 阶段,则可以创建快照。当集群容量达到 4 或 5 级时,无法创建快照。 |
参数
该方法有以下输入参数:
| 名称 | 描述 | 类型 | 默认值 | 必填项 |
|---|---|---|---|---|
|
JSON 对象格式的名称-值对列表。 |
JSON 对象 |
无 |
否 |
|
指定是否将快照复制到远程存储。可能值:
|
布尔值 |
false |
否 |
|
指定如果先前的快照复制正在进行中,则不应创建快照。可能的值有:
|
布尔值 |
|
否 |
过期时间 |
指定快照可以删除的时间。不能与……一起使用 |
string |
无 |
否 |
|
快照的名称。如果没有输入名称,则使用拍摄快照的日期和时间。名称长度上限为 255 个字符。 |
string |
无 |
否 |
|
此参数与以下参数相同: `expirationTime`参数,但时间格式为 HH:mm:ss。如果两者都不是 `expirationTime`也不 `retention`如果指定了快照,则快照将不会过期。 |
string |
无 |
否 |
|
SnapMirror软件用于指定SnapMirror端点上的快照保留策略的标签。 |
string |
无 |
否 |
|
用于创建新快照的快照的唯一 ID。传递的 snapshotID 必须是给定卷上的快照。 |
整数 |
无 |
否 |
|
要从中复制的卷映像的唯一 ID。 |
整数 |
无 |
是 |
返回值
此方法具有以下返回值:
名称 |
描述 |
类型 |
校验和 |
表示已存储快照中正确数字的字符串。之后可以使用此校验和来比较其他快照,以检测数据中的错误。 |
string |
snapshotID |
新快照的唯一标识符。 |
快照 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
}
}
Exception
当出现以下情况时,将显示 xNotPrimary 异常: `CreateSnapshot`调用 API 后,快照创建失败。此行为是预期的。重试 `CreateSnapshot`API调用。
自版本以来的新版本
9.6