执行备份策略

功能介绍

手工执行备份策略，创建备份。

URI

• URI

  POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints

• 参数说明

  表1 参数说明

  参数	是否必选	参数类型	描述
  project_id	是	String	项目ID。 获取方法请参见获取项目ID。
  provider_id	是	String	备份提供商ID，当前取值固定值：fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。

请求

• 要素说明

  表2 要素说明

  参数	是否必选	参数类型	描述
  checkpoint	是	checkpoint_req	请参照checkpoint_req 字段数据结构说明

• checkpoint_req 字段数据结构说明

  表3 checkpoint_req 字段数据结构说明

  参数	是否必选	参数类型	描述
  parameters	是	checkpoint_param	备份参数
  plan_id	是	String	备份策略ID，参考查询备份策略列表接口返回的备份策略ID

• checkpoint_param 字段数据结构说明

  表4 checkpoint_param 字段数据结构说明

  参数	是否必选	参数类型	描述
  auto_trigger	否	Boolean	是否自动触发
  resources	否	List<String>	待备份的资源ID列表

• 请求样例

  POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints
  {
    "checkpoint" : {
      "plan_id" : "62171999-3df1-42f7-9513-6f9b1bea4744",
      "parameters" : {
        "auto_trigger" : false,
        "resources" : [ "7a32a8b5-7977-4e24-b5da-e0eb457db75b", "b2b433bf-7dd6-4a74-aa8f-85673dfbda48" ]
      }
    }
  }

响应

• 要素说明

  表5 要素说明

  参数	参数类型	描述
  checkpoint	checkpoint_resp	请参考checkpoint_resp字段数据结构说明

• checkpoint_resp 字段数据结构说明

  表6 checkpoint_resp 字段数据结构说明

  参数	参数类型	描述
  status	String	状态，取值为['protecting','deleting','available','error']
  created_at	String	创建时间，如：2016-12-06T21:20:29.898823
  id	String	备份记录ID
  resource_graph	String	资源图，备份所包含的各种资源和备份对应情况图，取值为null时表示该备份只包含整机资源备份。
  project_id	String	项目ID 获取方法请参见获取项目ID
  protection_plan	plan_resp	备份策略信息
  extra_info	String	备份对象的附加信息，如备份创建方式等信息

• plan_resp 字段数据结构说明

  表7 plan_resp 字段数据结构说明

  参数	参数类型	描述
  id	String	备份策略ID
  name	String	备份策略名称
  resources	List<resource>	备份对象列表

• resource字段数据结构说明

  表8 resource字段数据结构说明

  参数	参数类型	描述
  id	String	待备份对象ID
  type	String	备份对象的实体对象类型。 当前支持的取值包含两个：OS::Nova::Server，该值代表备份对象为云服务器，OS::Ironic::BareMetalServer，该值代表备份对象为裸金属服务器。
  name	String	备份对象名称
  extra_info	String	资源的附加信息

• extra_info参数说明

  参数	参数类型	描述
  exclude_volumes	List	磁盘的ID列表，如果备份对象为云服务器或者裸金属服务器，代表备份时不对该服务器下指定的磁盘进行备份。

• 响应样例

  {
    "checkpoint" : {
      "status" : "protecting",
      "created_at" : "2016-12-06T21:20:29.898823",
      "id" : "14626f11-b54a-44ea-8e69-7463e527506a",
      "resource_graph" : null,
      "project_id" : "b942cc8342734d15bcb246babb1953cf",
      "protection_plan" : {
        "id" : "6a6cda7e-7b89-4b14-8e5c-3b6821a97d2c",
        "resources" : [ {
          "type" : "OS::Nova::Server",
          "id" : "1c960fe4-e679-421a-97cd-4f7463d2344b",
          "name" : "server0",
          "extra_info": "{"exclude_volumes": ["53dbb1f8-0b14-4850-9346-ef5067acbeb5"]}"
        } ],
        "name" : "backup"
      },
      "extra_info": "{"created_by": "manual"}"
    }
  }

状态码

• 正常

  状态码	说明
  200	OK

• 异常

  状态码	说明
  400	请求参数不合法
  401	鉴权失败
  403	没有操作权限
  404	请求对象不存在
  500	服务内部错误
  503	服务不可用

错误码

请参考错误码。