# 创建手动备份 - CreatingaManualBackup #### 功能介绍 创建手动备份。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=CreateManualBackup)中调试该接口。 #### URI POST /v3/{project_id}/backups 表1参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | name | 是 | String | **参数解释：** 备份名称。 **约束限制：** 不涉及。 **取值范围**： 4\~64个字符，必须以英文字母开头，区分大小写，可以包含英文字母、数字、中划线或者下划线，不能包含其他特殊字符。 **默认取值** **：** 不涉及。 | | description | 否 | String | **参数解释：** 备份文件描述信息。 **约束限制：** 不涉及。 **取值范围**： 不超过256个字符，且不能包含回车和 ! \< " = ' \> \&这些特殊字符。 **默认取值** **：** 不涉及。 | #### 请求示例 创建GaussDB手动全量备份。 ``` POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups { "instance_id" : "7e01ac5ac5274957ba506f3851d11d51in14", "name" : "backupwqwq3", "description" : "manual backup" } ``` #### 响应参数 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | backup | Object | **参数解释** **：** 备份信息。 详情请参见[表5]。 | | job_id | String | **参数解释** **：** 任务ID。 **取值范围** **：** 不涉及。 | 表5backup字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释** **：** 备份ID。 **取值范围** **：** 不涉及。 | | name | String | **参数解释** **：** 备份名称，不可重复。 **取值范围** **：** 不涉及。 | | description | String | **参数解释** **：** 备份描述。 **取值范围** **：** 不超过256个字符，且不能包含回车和 ! \< " = ' \> \&这些特殊字符。 | | begin_time | String | **参数解释** **：** 备份开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围** **：** 不涉及。 | | status | String | **参数解释** **：** 备份状态。 **取值范围** **：** - BUILDING：备份中。 - COMPLETED：备份完成。 - FAILED：备份失败。 | | type | String | **参数解释** **：** 备份类型。 **取值范围** **：** "manual"表示手动全量备份。 | | instance_id | String | **参数解释** **：** 实例ID。 **取值范围**： 不涉及。 | #### 响应示例 ``` { "backup": { "id": "e76112bfb2074871bf54cb8df5af7f64br14", "name": "backupwqwq32", "description": "manual backup", "status": "BUILDING", "type": "manual", "begin_time": "2022-05-09T18:02:31+0800", "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14" }, "job_id": "e4733090-b2c8-4ea7-a33a-f55f65723fb3" } ``` #### 状态码 - 正常 202 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。