# 创建手动备份 - CreateManualBackup #### 功能介绍 创建手动备份。 - 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。 - 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=CreateManualBackup)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rds/rds_10_0005.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | rds:backup:create | write | - | - | - | - | #### 接口约束 - SQL Server数据库引擎对单库创建手动备份时，支持批量执行。 - 只读实例不支持创建手动备份。 - 备份名称不能和已有备份重名。 #### URI - URI格式 POST /v3/{project_id}/backups - 参数说明 表1参数说明 | 名称 | 是否必选 | 说明 | |:---|:---|:---| | project_id | 是 | **参数解释：** 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求消息 表2参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释：** 实例ID。 可调用[查询数据库实例列表](https://support.huaweicloud.com/api-rds/rds_01_0004.html)接口，通过[表4](https://support.huaweicloud.com/api-rds/rds_01_0004.html#rds_01_0004__table2058713718267)中的"id"获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name | 是 | String | **参数解释**： 备份名称。 **约束限制**： 备份名称不能和已有备份重名。 **取值范围**： 4\~64个字符，必须以英文字母开头，区分大小写，可以包含英文字母、数字、中划线或者下划线，不能包含其他特殊字符。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 备份描述。 **约束限制**： 不涉及。 **取值范围**： 不能包含\>!\<"\&'=特殊字符，不大于256个字符。 **默认取值**： 不涉及。 | | databases | 否 | Array of objects | **参数解释**： 局部备份的用户自建数据库名列表，当有此参数时以局部备份为准。 详情请参见[表3]。 **约束限制**： - 只适用于PostgreSQL和SQL Server实例。 - backup_database_individually参数值为true时，databases参数必选。 | | backup_database_individually | 否 | Boolean | **参数解释**： 是否按库备份。 **约束限制**： 只适用于PostgreSQL和SQL Server实例。 **取值范围**： - true，按库备份。 - false，不按库备份。 **默认取值**： false | 表3databases字段数据结构说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | name | 是 | String | **参数解释**： 用户自建数据库名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求示例 - 创建RDS for MySQL实例的手动备份mybackup。 ``` POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "name": "mybackup", "description": "manual backup" } ``` - 创建RDS for PostgreSQL实例的手动备份mybackup。 ``` { "instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03", "name": "mybackup", "description": "manual backup" } ``` - 创建RDS for SQL Server实例的手动备份mybackup。 ``` { "instance_id": "34029da944074135a3bc24c75b3bb3edin04", "name": "mybackup", "description": "manual backup", "databases": [{ "name": "db1" }, { "name": "db2" }] } ``` #### 响应消息 - 正常响应要素说明 表4要素说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | backup | Object | **参数解释**： 备份信息。 详情请参见[表5]。 | 表5backup字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | id | String | **参数解释**： 备份ID。 **取值范围**： 不涉及。 | | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 备份名称。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 备份描述。 **取值范围**： 不涉及。 | | databases | Array of objects | **参数解释**： 只支持PostgreSQL和SQL Server引擎实例，局部备份的用户自建数据库名列表，当有此参数时以局部备份为准。 详情请参见[表6]。 | | begin_time | String | **参数解释**： 备份开始时间。 **取值范围**： 格式为"yyyy-mm-ddThh:mm:ssZ"，其中T指时间字段的开始；Z指时区偏移量。 | | status | String | **参数解释**： 备份状态。 **取值范围**： - BUILDING：备份中。 - COMPLETED：备份完成。 - FAILED：备份失败。 - DELETING：备份删除中。 | | type | String | **参数解释**： 备份类型。 **取值范围**： - auto：自动全量。 - manual：手动全量。 - fragment：差异全量。 - incremental：自动增量。 | 表6databases字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | name | String | **参数解释**： 用户自建数据库名。 **取值范围**： 不涉及。 | - 正常响应样例 **RDS for MySQL实例：** ``` { "backup": { "id": "cb211c0075104151a748a854bc8bd87dbr01", "name": "mybackup", "description": "manual backup", "begin_time": "2022-08-23T07:41:50Z", "status": "BUILDING", "type": "manual", "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } ``` **RDS for PostgreSQL实例：** ``` { "backup": { "id": "104b59afd83d4fc7b2c03ad14c4be080br03", "name": "mybackup", "description": "manual backup", "begin_time": "2022-08-23T07:20:36Z", "status": "BUILDING", "type": "manual", "instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03" } } ``` **RDS for SQL Server实例：** ``` { "backup": { "id": "6f7b5904b04043b38ad764e33daba810br04", "name": "mybackup", "description": "manual backup", "begin_time": "2022-08-23T07:15:28Z", "status": "BUILDING", "type": "manual", "instance_id": "34029da944074135a3bc24c75b3bb3edin04", "databases": [{ "name": "db1" }, { "name": "db2" }] } } ``` - 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。 #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。