Skip to main content
Element Software
本产品推出了新版本。
简体中文版经机器翻译而成，仅供参考。如与英语版出现任何冲突，应以英语版为准。

CreateSnapshot

贡献者
PDF

您可以使用 `CreateSnapshot`创建卷的时间点副本。您可以从任何卷或现有快照创建快照。

如果不在此 API 方法中提供 SnapshotID ，则会从卷的活动分支创建快照。如果要将创建快照的卷复制到远程集群，则也可以将快照复制到同一目标。使用 enableRemoteReplication 参数启用快照复制。

备注 如果集群填充度处于第 1 ， 2 或 3 阶段，则可以创建快照。当集群填充度达到第 4 或第 5 阶段时，您无法创建快照。

参数

此方法具有以下输入参数：

名称 说明 键入 默认值 必填

attributes

名称 - 值对列表，采用 JSON 对象格式。

JSON 对象

无

否

enableRemoteReplication

指定是否将快照复制到远程存储。可能值：

  • true：快照将复制到远程存储。

  • false：快照不会复制到远程存储。

boolean

false

否

ensureSerialCreation

指定在执行上一个快照复制时不应创建快照。可能值包括：

  • true：这样可以确保一次只复制一个快照。如果先前的快照复制仍在进行中，则创建新快照将失败。

  • false：默认值。如果另一个快照复制仍在进行中，则允许创建此快照。

boolean

false

否

到期时间

指定删除快照的时间。不能与一起使用 retention。如果未指定 expirationTime 或 retention ，则快照不会过期。时间格式为基于时间的到期日期的 ISO 8601 日期字符串，否则它不会过期。如果值为 null、则会永久保留快照。值为 `fifo`时、会相对于卷上的其他FIFO快照、以先进先出的方式保留快照。如果没有可用的 FIFO 空间， API 将失败。

string

无

否

name

快照的名称。如果未输入任何名称，则会使用创建快照的日期和时间。允许的最大名称长度为 255 个字符。

string

无

否

retention

此参数与参数相同 expirationTime、只是时间格式为HH：mm：s如果 expirationTime`未指定或 `retention、则快照不会过期。

string

无

否

snapMirrorLabel

SnapMirror 软件用于在 SnapMirror 端点上指定快照保留策略的标签。

string

无

否

snapshotID

从中创建新快照的快照的唯一 ID 。传递的快照 ID 必须是给定卷上的快照。

整型

无

否

volumeID

要从中复制的卷映像的唯一 ID 。

整型

无

是

返回值

此方法具有以下返回值：

名称

说明

键入

校验和

表示已存储快照中正确数字的字符串。此校验和可在稍后用于比较其他快照以检测数据中的错误。

string

snapshotId

新快照的唯一 ID 。

Snapshot ID

Snapshot

包含有关新创建快照的信息的对象。

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