创建云硬盘快照

功能介绍

创建云硬盘快照。

URI

• URI格式

  POST /v3/{project_id}/snapshots

• 参数说明

  名称	是否必选	描述
  project_id	是	项目ID。 获取方法请参见获取项目ID。

请求消息

• 请求参数

  参数	参数类型	是否必选	描述
  snapshot	Object	是	待创建的快照信息，请参见•snapshot参数说明。

• snapshot参数说明

  参数	参数类型	是否必选	描述
  volume_id	String	是	创建快照源云硬盘的ID。
  force	Boolean	否	强制创快照标示，默认为false。 当force标记为false时，云硬盘处于挂载状态时，不能强制创建快照。 当force标记为true时，即使云硬盘处于挂载状态时，仍可以创建快照。
  metadata	Object	否	云硬盘快照的元数据信息。
  description	String	否	云硬盘快照描述，可以为null。最大支持255个字节。
  name	String	否	云硬盘快照名称。最大支持255个字节。 说明： 对云硬盘创建备份时，同时会创建以autobk_snapshot_为名称前缀的快照，云硬盘控制台对此类快照会有操作限制。因此建议不要创建以autobk_snapshot_为名称前缀的快照，避免影响快照的正常使用。

• 请求样例

  {
      "snapshot": {
          "name": "snap-001", 
          "description": "Daily backup", 
          "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635", 
          "force": false, 
          "metadata": { }
      }
  }

响应消息

• 响应参数

  参数	参数类型	描述
  snapshot	Object	快照信息，请参见•snapshot参数说明。
  error	Object	出现错误时，返回的错误信息，具体请参见•error参数说明。

• snapshot参数说明

  参数	参数类型	描述
  id	String	云硬盘快照ID。
  status	String	云硬盘快照状态，具体请参见云硬盘快照状态。
  name	String	云硬盘快照名称。
  description	String	云硬盘快照描述信息。
  created_at	String	云硬盘快照创建时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX
  metadata	Object	云硬盘快照的元数据信息。
  volume_id	String	快照所属的云硬盘ID。
  size	Integer	云硬盘快照大小，单位为GB。
  updated_at	String	快照更新时间。 时间格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

• error参数说明

  参数	参数类型	描述
  message	String	出现错误时，返回的错误消息。
  code	String	出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码。

• 响应样例

  {
      "snapshot": {
          "status": "creating", 
          "description": "Daily backup", 
          "created_at": "2013-02-25T03:56:53.081642", 
          "metadata": { }, 
          "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635", 
          "size": 1, 
          "id": "ffa9bc5e-1172-4021-acaf-cdcd78a9584d", 
          "name": "snap-001", 
          "updated_at": "2013-02-25T03:56:53.081642"
      }
  }

  或

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

  其中error是泛指的错误，有badRequest、itemNotFound等，如报错：

  {
      "itemNotFound": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

状态码

• 正常

  202

错误码

请参考错误码。