创建备份

功能介绍

创建一个云硬盘备份。

接口调用成功仅代表备份任务下发成功，备份状态请通过备份查询接口查看。

URI

• URI格式

  POST /v2/{project_id}/cloudbackups

• 参数说明

  参数	是否必选	描述
  project_id	是	项目ID。 获取项目ID方法请参考 获取项目ID。

请求

• 参数说明

  参数	是否必选	参数类型	描述
  backup	是	dict	待创建的备份，详情见 backup 字段数据结构说明

• backup 字段数据结构说明

  参数	是否必选	参数类型	描述
  volume_id	是	string	需要进行备份的磁盘ID。
  snapshot_id	否	string	需要进行备份的磁盘对应的快照ID。
  name	是	string	备份名称，最大支持64个字符(不区分中英文)，只能是中文、英文、数字、下划线（_）和中划线（-），不支持auto开头的名称。
  description	否	string	备份描述，最大支持64个字符(不区分中英文)，且不能包含“<”和“>”。
  tags	否	list<dict>	待设置到该备份资源上的标签。详情见 tag 字段数据结构说明

  • tag 字段数据结构说明

    参数	是否必选	参数类型	描述
    key	是	string	键。最大长度36个字符。 字符集：不能包含非打印字ASCII(0-31),"=","*","<",">","\",",","|","/"
    value	是	string	值。最大长度43个字符，可以为空字符串。 字符集：不能包含非打印字ASCII(0-31),"=","*","<",">","\",",","|","/"

• 请求样例

  {
      "backup": {
          "volume_id": "c68ae7fb-0aa5-4a97-ab01-ed02c5b7e768",
          "snapshot_id": null,
          "name": "backup1",
          "description": "Backup_Demo",
          "tags":[{
              "key":"key",
              "value":"value"
           }]
          
      }
  }

响应

• 要素说明

  参数	参数类型	描述
  job_id	string	正常返回时返回的任务ID。
  message	string	出现错误时，返回的错误消息。
  code	string	出现错误时，返回的错误码。 错误码的具体含义请参考错误码。

• 响应样例

  {
  "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
  }

  或

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

状态码

• 正常

  200

• 异常

  状态码	说明
  400 Bad Request	服务器未能处理请求。
  401 Unauthorized	被请求的页面需要用户名和密码。
  403 Forbidden	对被请求页面的访问被禁止。
  404 Not Found	服务器无法找到被请求的页面。
  405 Method Not Allowed	请求中指定的方法不被允许。
  406 Not Acceptable	服务器生成的响应无法被客户端所接受。
  407 Proxy Authentication Required	用户必须首先使用代理服务器进行验证，这样请求才会被处理。
  408 Request Timeout	请求超出了服务器的等待时间。
  409 Conflict	由于冲突，请求无法被完成。
  500 Internal Server Error	请求未完成。服务异常。
  501 Not Implemented	请求未完成。服务器不支持所请求的功能。
  502 Bad Gateway	请求未完成。服务器从上游服务器收到一个无效的响应。
  503 Service Unavailable	请求未完成。系统暂时异常。
  504 Gateway Timeout	网关超时。

错误码

请参考错误码。