更新时间:2022-02-22 GMT+08:00

创建备份(OpenStack原生)

功能介绍

创建一个云硬盘备份。

URI

  • URI格式

    POST /v2/{project_id}/backups

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

    获取项目ID方法请参考 获取项目ID

请求

  • 参数说明

    参数

    是否必选

    参数类型

    描述

    backup

    dict

    待创建的备份信息。详情见 backup 参数说明

  • backup 参数说明

    参数

    是否必选

    参数类型

    描述

    volume_id

    string

    待备份的磁盘ID。

    snapshot_id

    string

    待备份的磁盘对应的快照ID。

    name

    string

    备份名称,最大支持64个字符(不区分中英文),只能是中文、英文、数字、下划线(_)和中划线(-),不支持auto开头的名称。

    description

    string

    备份描述,长度限制:0- 255,除了“<”、“>”不能输入,其它字符均可。

    container

    string

    备份容器,保留字段,目前该参数会被忽略。

    incremental

    boolean

    是否增量备份,true表示增量,false表示全量。VBS默认会首次全量备份,后续增量备份,故该参数会被忽略。

    force

    boolean

    是否对挂载的卷进行强制备份,true表示强制,false表示不强制,默认为false。

    project_id

    string

    项目ID。

    获取项目ID方法请参考 获取项目ID

  • 请求样例
    {
        "backup": {
            "volume_id": "c68ae7fb-0aa5-4a97-ab01-ed02c5b7e768",
            "snapshot_id": "2bb856e1-b3d8-4432-a858-09e4ce939389",
            "name": "backup1",
            "description": "Backup_Demo"
        }
    }

响应

  • 要素说明

    参数

    参数类型

    描述

    backup

    dict

    创建的备份信息。

    id

    string

    备份ID。

    name

    string

    备份名称。

    links

    list<dict>

    备份URL信息。

    href

    string

    表示本备份的URL。

    rel

    string

    rel表示本次查询结果和当前href的关系。

  • 响应样例
    {
      "backup": {
        "id": "54ba0e69-48a0-4a77-9cdf-a7979a7e2648",
        "links": [
          {
            "href": "https://volume.Region.dc1.domainname.com/v2/5751d8c3f2f6415993ee4326b41630ec/backups/54ba0e69-48a0-4a77-9cdf-a7979a7e2648",
            "rel": "self"
          },
          {
            "href": "https://volume.Region.dc1.domainname.com/5751d8c3f2f6415993ee4326b41630ec/backups/54ba0e69-48a0-4a77-9cdf-a7979a7e2648",
            "rel": "bookmark"
          }
        ],
        "name": "backup1"
      }
    }

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

状态码

  • 正常

    202

  • 异常

    状态码

    说明

    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

    网关超时。

错误码

请参考错误码