# 创建资源备份 当前云服务器备份接口仅供存量用户使用，新用户无法使用，新用户建议使用[云备份服务](https://support.huaweicloud.com/cbr/index.html)及其[相关接口](https://support.huaweicloud.com/api-cbr/CreateVault.html)。 #### 功能介绍 选择资源直接备份。 #### URI - URI POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/{resource_id}/action - 参数说明 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-csbs/zh-cn_topic_0136033750.html)。 | | provider_id | 是 | String | 备份提供商ID，当前取值固定值：fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。 | | resource_id | 是 | String | 备份服务器或服务器中某些磁盘的ID。服务器ID请参见《弹性云服务器API参考》获取。 | ![](https://support.huaweicloud.com/api-csbs/public_sys-resources/notice_3.0-zh-cn.png) 文中所有备份提供商ID的当前取值均为："fc4d5750-22e7-4798-8a46-f48f62c4c1da"。 #### 请求 - 要素说明 表2要素说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | protect | 是 | protect_param | 备份参数。 详情请参见[表3]。 | - protect_param 字段数据结构说明 表3protect_param 字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | backup_name | 否 | String | 备份名称，长度限制：1- 255，只能由中文、字母、数字、"_"、"-"组成。 | | description | 否 | String | 备份描述，长度限制：0- 255，除了"\<"、"\>"不能输入，其它字符均可。 | | incremental | 否 | Boolean | 备份执行的类型，取值为True代表执行增量备份，取值为False代表执行全量备份。如果是首次备份，则无论是否指定该参数或者该参数取任意值，总是执行全量备份；如果非首次备份，指定该参数为False代表本次执行全量备份，不指定该参数或者该参数取值为True代表本次执行增量备份。 | | resource_type | 否 | String | 备份对象的实体对象类型。 当前支持的取值包含两个：OS::Nova::Server，该值代表备份对象为云服务器，OS::Ironic::BareMetalServer，该值代表备份对象为裸金属服务器。如果不传递该参数则默认备份对象为云服务器。 | | extra_info | 否 | Dict | 备份对象的附加信息。 | | app_consistency | 否 | Integer | 是否做应用一致性备份；0代表不做应用一致性备份；1代表做应用一致性备份且应用一致性备份失败后，不继续做崩溃一致性备份；2代表做应用一致性备份且应用一致性备份失败后，继续做崩溃一致性备份。未输入app_consistency参数时，不做应用一致性备份。应用一致性备份将备份应用备份时刻内存中的数据，保障数据备份时刻完整一致性，使用该参数请先咨询当前局点是否已支持该特性。 | - extra_info参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | exclude_volumes | 否 | List\ | 磁盘的ID列表，如果备份对象为云服务器或者裸金属服务器，代表备份时不对该服务器下指定的磁盘进行备份。 | - 请求样例 ``` POST https://{endpoint}/v1/b942cc8342734d15bcb246babb1953cf/providers/fc4d5750-22e7-4798-8a46-f48f62c4c1da/resources/9506416d-db6c-406e-8bca-c0f43793d914/action { "protect" : { "backup_name" : "backup", "description" : "backup des", "extra_info" : { "exclude_volumes": ["8a8ccde2-0b9a-4450-a5f3-150816635f46"] }, "app_consistency": 1 } } ``` #### 响应 - 要素说明 表4要素说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | checkpoint | protect_resp | 备份响应。 详情请参见[表5]。 | - protect_resp 字段数据结构说明 表5protect_resp 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | 备份状态， Enum:\[ waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting,deleted\] | | created_at | String | 创建时间,如:"2017-04-18T01:21:52.701973" | | id | String | 备份记录ID | | resource_graph | String | 资源图,备份子备份包含关系结构图 | | project_id | String | 项目ID 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-csbs/zh-cn_topic_0136033750.html)。 | | protection_plan | plan_resp | 备份计划信息 详情请参见[表6]。 | | extra_info | String | 额外添加信息 | - plan_resp 字段数据结构说明 表6plan_resp 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 备份策略ID。 | | name | String | 备份策略名称。 | | resources | List\ | 备份对象列表。 详情请参见[表7]。 | - resource 字段数据结构说明 表7resource 字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 待备份对象ID | | type | String | 备份对象的实体对象类型。 当前支持的取值包含两个：OS::Nova::Server，该值代表备份对象为云服务器，OS::Ironic::BareMetalServer，该值代表备份对象为裸金属服务器。 | | name | String | 备份对象名称 | | extra_info | Dict | 备份对象的附加信息 | - extra_info参数说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | exclude_volumes | List\ | 磁盘的ID列表，如果备份对象为云服务器或者裸金属服务器，代表备份时不对该服务器下指定的磁盘进行备份。 | - 响应样例 ``` { "checkpoint" : { "status" : "protecting", "created_at" : "2017-04-18T01:21:52.701973", "id" : "4468f4b8-7c78-4222-a2ca-346b5d557dd2", "resource_graph" : null, "project_id" : "b942cc8342734d15bcb246babb1953cf", "extra_info" : null, "protection_plan" : { "id" : "fake_04f8ea0f-2000-4389-a5ce-93a3e20d0faf", "resources" : [ { "type" : "OS::Nova::Server", "id" : "9506416d-db6c-406e-8bca-c0f43793d914", "name" : "resource_9506416d-db6c-406e-8bca-c0f43793d914", "extra_info" : { "exclude_volumes": ["8a8ccde2-0b9a-4450-a5f3-150816635f46"] } } ], "name" : "server protect plan for 9506416d-db6c-406e-8bca-c0f43793d914" } } } ``` #### 状态码 - 正常 | 状态码 | 说明 | |:---|:---| | 200 | OK | - 异常 | 状态码 | 说明 | |:---|:---| | 400 | 请求参数不合法 | | 401 | 鉴权失败 | | 403 | 没有操作权限 | | 404 | 请求对象不存在 | | 500 | 服务内部错误 | | 503 | 服务不可用 | #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-csbs/zh-cn_topic_0071888297.html)。