华为云用户手册

请求示例 查询实例是否能在库表恢复时使用极速恢复。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/fast-restore { "restore_time" : "2023-06-25T11:35:40+0800", "instance_ids" : [ "14fc6c06d7e842829ee91d11c6b88b3ain01" ] }

响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 offsite_backup_instances Array of objects 跨区域备份实例信息。 详情请参见表3。 total_count Integer 总记录数。 表3 offsite_backup_instances字段数据结构说明 名称 参数类型 说明 id String 实例ID。 name String 创建的实例名称。 source_region String 源区域。 source_project_id String 租户在源区域下的project ID。 datastore Object 数据库信息。 详情请参见表4。 destination_region String 跨区域备份所在区域。 destination_project_id String 租户在目标区域下的project ID。 keep_days Integer 跨区域备份保留天数。 表4 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎。 version String 数据库版本。 正常响应样例 根据指定条件查询实例列表： { "total_count": 1, "offsite_backup_instances": [{ "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01", "name": "rds-instance-rep2", "source_region": "aaa", "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "datastore": { "type": "MySQL", "version": "5.7" }, "destination_region": "bbb", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9", "keep_days": 7 } ] } 查询所有实例列表： { "total_count": 1, "offsite_backup_instances": [{ "id": "ed7cc6166ec24360a5ed5c5c9c2ed726in01", "name": "rds-instance-rep2", "source_region": "aaa", "source_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "datastore": { "type": "MySQL", "version": "5.7" }, "destination_region": "bbb", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9", "keep_days": 7 } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/backups/offsite-backup-instance?offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 offset Integer 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit Integer 否 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 restore_time Array of objects 可恢复时间段列表。 详情请参见表3。 表3 restore_time字段数据结构说明 名称 参数类型 说明 start_time Integer 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Integer 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 正常响应样例 { "restore_time": [ { "start_time": 1532001446987, "end_time": 1532742139000 } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/offsite-restore-time?date=2020-12-26 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 date 否 所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

请求消息 请求参数 无。 URI样例 查询实例跨区域备份的所有可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/offsite-restore-time 根据指定日期查询实例跨区域备份的可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/offsite-restore-time?date=2020-12-26

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/offsite-backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 备份列表。 详情请参见表3。 total_count Integer 总记录数。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 备份ID。 name String 备份名称。 type String 备份类型。 取值如下： auto：自动全量备份和手动备份。仅RDS for SQL Server支持跨区域备份的手动备份类型。 incremental：自动增量备份。 size Long 备份大小（单位：KB）。 status String 备份状态，取值如下： BUILDING: 备份中。 COMPLETED: 备份完成。 FAILED：备份失败。 DELETING：备份删除中。 databases Array of objects 用户自建库，仅RDS for SQL Server返回该字段。 详情请参见表4。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间。 全量备份类型下，指备份结束时间。 RDS for MySQL增量备份类型，指备份文件中最后一个事务的提交时间。 格式为“yyyy-mm-ddThh:mm:ssZ”，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 datastore Object 数据库版本信息。 详情请参见表5。 instance_id String 备份所在实例ID。 associated_with_ddm Boolean 是否关联DDM标志。仅RDS for MySQL返回该字段。 表4 databases字段数据结构说明 名称 参数类型 说明 name String 用户自建数据库名。 表5 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎，当前仅支持MySQL引擎和SQL Server引擎。 version String 数据库版本。 正常响应样例 MySQL： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } PostgreSQL： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01" }], "total_count": 1 } SQL Server： { "backups": [ { "id": "d0ea632a5c32451dbdb157ef5c2ad3ecbr04", "name": "sqlserver-rds-1784-20221202062025775", "type": "auto", "size": 5956, "status": "COMPLETED", "begin_time": "2022-12-02T06:20:25+0000", "end_time": "2022-12-02T06:24:45+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" }, { "id": "07d6a8ab12304f9aa3f368a6cff21ac9br04", "name": "backup-81f1", "type": "auto", "size": 773, "status": "COMPLETED", "begin_time": "2022-12-02T06:12:22+0000", "end_time": "2022-12-02T06:16:37+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" } ], "total_count": 2 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/offsite-backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 backup_type 是 备份类型，取值如下： auto：自动全量备份和手动备份。仅RDS for SQL Server支持跨区域备份的手动备份类型。 incremental：自动增量备份。 backup_id 否 备份ID。 offset 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 begin_time 否 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： “begin_time”有值时，“end_time”必选。 end_time 否 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： “end_time”有值时，“begin_time”必选。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 policy_para Array of objects 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。 表3 policy_para字段数据结构说明 名称 参数类型 说明 backup_type String 指定备份的类型。取值如下： auto：自动全量备份。 incremental：自动增量备份。 manual：手动备份，仅RDS for SQL Server返回该备份类型 。 keep_days Integer 备份文件可以保存的天数。 destination_region String 设置跨区域备份策略的目标区域ID。 destination_project_id String 设置跨区域备份策略的目标project ID。 正常响应样例 备份策略关闭时： { "policy_para": { "keep_days": 0 } } RDS for MySQL、RDS for PostgreSQL自动备份策略和增量备份策略开启时： { "policy_para": [ { "keep_days": 7, "backup_type": "auto", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "incremental", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" } ] } RDS for SQL Server自动备份策略、增量备份策略和手动备份策略开启时： { "policy_para": [ { "keep_days": 7, "backup_type": "incremental", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "manual", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "auto", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" } ] } 异常响应 请参见异常请求结果。

请求示例 更新MySQL或PostgreSQ L实例 的跨区域自动全量备份策略。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy { "policy_para": { "backup_type": "auto", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 关闭MySQL或PostgreSQL实例的跨区域自动全量备份策略。 { "policy_para": { "backup_type": "auto", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 更新SQL Server实例的跨区域备份策略。 { "policy_para": { "backup_type": "all", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 关闭SQL Server实例的跨区域备份策略。 { "policy_para": { "backup_type": "all", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } }

接口约束 如果实例已开启跨区域备份策略，调用接口设置跨区域备份策略，仅会更改保留天数，其他参数设置无效。 RDS for MySQL和RDS for PostgreSQL自动全量备份和自动增量备份保留天数必须保持一致。 RDS for MySQL和RDS for PostgreSQL自动增量备份必须在开启自动全量备份后才能开启。 RDS for MySQL和RDS for PostgreSQL自动全量备份和自动增量备份都开启后，关闭时请按顺序依次关闭自动增量备份、自动全量备份。 RDS for MySQL和RDS for PostgreSQL选择卷快照备份方式的实例不支持跨区域备份。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 policy_para 是 Object 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。 表3 policy_para字段数据结构说明 名称 是否必选 参数类型 说明 backup_type 是 String 指定备份的类型。 RDS for SQL Server仅支持设置为“all”。 取值如下： auto：自动全量备份。 incremental：自动增量备份。 all：同时设置所有备份类型。 RDS for MySQL：同时设置自动全量和自动增量备份。 RDS for PostgreSQL：同时设置自动全量和自动增量备份。 RDS for SQL Server：同时设置自动全量、自动增量备份和手动备份。 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～1825。 保存天数设置为0时，表示关闭跨区域备份策略。 须知： 关闭备份策略后，备份任务将立即停止，如果有增量备份，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。 destination_region 是 String 设置跨区域备份策略的目标区域ID。 destination_project_id 是 String 设置跨区域备份策略的目标project ID。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 restore_time Array of objects 可恢复时间段列表。 详情请参见表3。 表3 restore_time字段数据结构说明 名称 参数类型 说明 start_time Integer 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Integer 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 正常响应样例 { "restore_time": [ { "start_time": 1532001446987, "end_time": 1532742139000 } ] } 异常响应 请参见异常请求结果。

请求消息 请求参数 无。 URI样例 查询实例的所有可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time 根据指定日期查询实例的可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time?date=2020-12-26

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/restore-time?date=2020-12-26 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 date 否 所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

请求示例 恢复表数据到指定时间点。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore/tables { "restoreTime": 1583720991838, "restoreTables": [ { "database": "restoretest", "tables": [ { "oldName": "test", "newName": "test_1583720991838" } ] } ], "is_fast_restore" : false }

功能介绍 为了保证数据完整性，降低对原实例的性能影响，在进行表级时间点恢复备份时，首先将选中时间点的全量数据和增量数据在后台恢复至一个临时实例，然后自动导出用户需要恢复的表，再将这些表恢复至原实例。 该接口计划于2025-09-14下线，建议及时切换到新接口表级时间点恢复（MySQL）。 该操作会在原实例上新生成恢复后的库表，请确保您的原实例磁盘空间充足。 调用接口前，您需要了解API 认证鉴权。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 restoreTime 是 Long 备份时间点。 restoreTables 是 Array of objects 数据库信息，详细说明请参见表3。 is_fast_restore 否 Boolean 是否使用极速恢复。取值：true、false。 配置该参数时，参考查询实例是否能在库表恢复时使用极速恢复（MySQL）接口判断本次恢复是否能使用极速恢复。能使用极速恢复时，如果实例存在XA事务，会导致数据丢失，请选择普通恢复，即设置参数值为“false”。 不传该参数时，将根据查询实例是否能在库表恢复时使用极速恢复（MySQL）的查询结果，默认是否使用极速恢复。如果支持极速恢复功能，并且实例存在XA事务，请选择普通恢复，即传参并设置参数值为“false”。 表3 restoreTables字段数据结构说明 名称 是否必选 参数类型 说明 database 是 String 数据库名称。 tables 是 Array of objects 表信息，详细说明请参见表4。 表4 tables字段数据结构说明 名称 是否必选 参数类型 说明 oldName 是 String 恢复前表名。 newName 是 String 恢复后表名。

请求示例 使用备份文件将数据恢复到实例。 POST https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 使用SQL Server备份文件将所有数据库恢复到实例。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "backup", "backup_id": "b021670e69ba4538b7b2ed07257306aebr04", "restore_all_database":true }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } } 将实例的数据恢复到指定时间点。 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 将SQL Server实例的部分数据库恢复到指定时间点。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } }

响应消息 正常响应要素说明 表12 要素说明 名称 参数类型 说明 instance Object 实例信息。 详情请参见表13。 job_id String 实例创建的任务id。仅按需实例时返回该参数。 order_id String 订单号，仅RDS for SQL Server创建包年包月时返回该参数。 表13 instance说明 名称 参数类型 说明 id String 实例ID。 name String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名，其中，RDS for SQL Server实例名唯一。 status String 实例状态。如BUILD，表示创建中。 datastore Object 数据库信息。 详情请参见表14。 ha Object HA配置参数，仅当您选择创建HA实例时该参数才可见。 详情请参见表15。 configuration_id String 参数模板id，仅当您创建实例指定用户自定义参数组时才可见。 port String 数据库端口信息。 RDS for MySQL数据库端口设置范围为1024～65535（其中12017和33071被RDS系统占用不可设置）。 RDS for PostgreSQL数据库端口修改范围为2100～9500。 对于RDS for SQL Server 2022 EE、2022 SE、2022 Web版、2019 EE、2019 SE、2019 Web版、2017 EE、2017 SE、2017 Web版：端口设置范围为1433和2100~9500（其中5050、5353、5355、5985和5986不可设置）。 除此之外的其他版本：端口设置范围为1433和2100~9500（其中5355、5985和5986不可设置）。 当不传该参数时，默认端口如下： RDS for MySQL默认3306。 RDS for PostgreSQL默认5432。 RDS for SQL Server默认1433。 backup_strategy Object 自动备份策略。 详情请参见表16。 enterprise_project_tag String 项目标签。 flavor_ref String 规格ID。 使用可参考查询数据库规格响应消息表3中的“spec_code”。 volume Object volume信息。 详情请参见表17。 region String 区域ID。 availability_zone String 可用区ID。 vpc_id String 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 subnet_id String 子网的网络ID信息，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 security_group_id String 指定实例所属的安全组。 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。 collation String RDS for SQL Server设定的字符集信息。 charge_info Object 计费方式信息，支持包年/包月和按需。 详情请参见表10。 表14 datastore字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 数据库引擎。支持的引擎如下，不区分大小写： MySQL PostgreSQL SQLServer version 是 String 数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。 complete_version 否 String 数据库完整版本号。仅在数据库引擎是”PostgreSQL”时返回。 表15 ha字段数据结构说明 名称 是否必选 参数类型 说明 mode 是 String 实例主备模式，取值：Ha。 replication_mode 是 String 备机同步参数。 取值：非空。 MySQL为“async”或“semisync”。 PostgreSQL为“async”或“sync”。 Microsoft SQL Server为“sync”。 说明： “async”为异步模式。 “semisync”为半同步模式。 “sync”为同步模式。 表16 backupStrategy字段数据结构说明 名称 是否必选 参数类型 说明 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30或45。 取值示例： 08:15-09:15 23:00-00:00 keep_days 否 Integer 指定已生成备份文件的可保存天数。 取值范围：0～732。该参数缺省，或取0值，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。 表17 volume字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 磁盘类型。 取值范围如下，区分大小写： ULTRAHIGH，表示超高IO型磁盘。 LOCALSSD，表示本地SSD盘。 CLOUDSSD，表示SSD云盘。 ESSD，表示极速型SSD。 size 是 Integer 磁盘大小。 取值范围：40GB~4000GB。必须为10的整数倍。 正常响应样例 MySQL { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "MySQL", "version": "5.7.31" }, "port": "3306", "volume": { "type": "ULTRAHIGH", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.mysql.s1.large", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0" }, "job_id": "bf003379-afea-4aa5-aa83-4543542070bc" } PostgreSQL { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "PostgreSQL", "version": "9.6.13" }, "port": "5432", "volume": { "type": "ULTRAHIGH", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.pg.s1.large", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0" }, "job_id": "bf003379-afea-4aa5-aa83-4543542070bc" } SQL Server { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "sqlserver", "version": "2014_SE" }, "port": "2100", "volume": { "type": "ULTRAHIGH", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.mssql.2014.se.s3.large.2", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0", "charge_info": { "charge_mode": "prePaid", "period_num": 1 }, "collation": "Cyrillic_General_CI_AS" }, "order_id": " CS 20122919584LQ7K" } Serverless型MySQL { "instance": { "id": "dbb35f31f4144086bf522ff8a124530din01", "name": "serverless", "status": "BUILD", "datastore": { "type": "MySQL", "version": "5.7.41" }, "ha": { "mode": "Ha", "replication_mode": "semisync" }, "port": "3307", "volume": { "type": "CLOUDSSD", "size": 100 }, "region": "aaa", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "flavor_ref": "rds.mysql.serverless.ha", "availability_zone": "bbb,ccc", "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4", "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e", "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c" }, "job_id": "908c05f7-958a-4411-b590-890eed175345" } 异常响应 请参见异常请求结果。

接口约束 原实例和目标实例的数据库类型必须一致，如都是MySQL。 原实例和目标实例的数据库版本约束如下： RDS for MySQL和RDS for PostgreSQL的原实例和目标实例的数据库版本必须一致。 RDS for SQL Server的原实例及目标实例的时区配置要完全一致，否则会有数据不一致风险。 RDS for SQL Server的原实例和目标实例的数据库版本约束参见表5。 RDS for MySQL和RDS for PostgreSQL数据库目标实例需大于或等于原实例的数据卷总大小。

请求示例 将 MySQL备份 文件恢复到新实例。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "targetInst", "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "async" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "ULTRAHIGH", "size": 40 }, "region": "aaa", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.147", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "UTC+04:00", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" } } 将SQL Server备份文件中的部分数据库恢复到新实例。 { "name": "targetInst", "datastore": { "type": "SQLServer", "version": "2014_SE" }, "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "sync" }, "flavor_ref": "rds.mssql.2014.se.s3.xlarge.2.ha", "volume": { "type": "ULTRAHIGH", "size": 40 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.147", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "charge_info": { "charge_mode": "prePaid", "period_type": "month", "period_num": 1, "is_auto_renew": false, "is_auto_pay": true }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr04", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "UTC+04:00", "collation": "Cyrillic_General_CI_AS", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe", "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db002", "db3": "" } } } 将MySQL实例的数据恢复到指定时间点。 { "name": "targetInst", "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "async" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "ULTRAHIGH", "size": 40 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "data_vip": "192.168.0.147", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr01", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "UTC+04:00", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 } } 将SQL Server实例的部分数据库恢复到指定时间点。 { "name": "targetInst", "datastore": { "type": "SQLServer", "version": "2014_SE" }, "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "sync" }, "flavor_ref": "rds.mssql.2014.se.s3.xlarge.2.ha", "volume": { "type": "ULTRAHIGH", "size": 40 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.147", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "charge_info": { "charge_mode": "prePaid", "period_type": "month", "period_num": 1, "is_auto_renew": false, "is_auto_pay": true }, "password": "Demo@12345678", "configuration_id": "52e86e87445847a79bf807ceda213165pr04", "enterprise_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c", "time_zone": "UTC+04:00", "collation": "Cyrillic_General_CI_AS", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } } } 将Serverless型MySQL备份文件恢复到新实例。 { "name": "serverless", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.serverless.ha", "volume": { "type": "CLOUDSSD", "size": 100 }, "region": "aaa", "availability_zone": "bbb,ccc", "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4", "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e", "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c", "port": 3307, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "password": "****", "time_zone": "UTC+08:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "serverless_info": { "min_cap": "0.5", "max_cap": "1" }, "restore_point": { "instance_id": "aceb1e359a444660bb8fe0696afc76e1in01", "type": "backup", "backup_id": "0db0b4b93e5d40afbd65ede29153dc46br01" } }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 files Array of objects 参数解释： 备份包含的文件列表。 详情请参见表3。 bucket String 参数解释： 文件所在的桶名。 取值范围： 不涉及。 表3 files字段数据结构说明 名称 参数类型 说明 name String 参数解释： 文件名。 取值范围： 不涉及。 size Long 参数解释： 文件大小，单位：KB。 取值范围： 不涉及。 download_link String 参数解释： 文件下载链接。 取值范围： 不涉及。 link_expired_time String 参数解释： 下载链接过期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 取值范围： 不涉及。 database_name String 参数解释： 数据库名。若文件不是数据库备份，则返回空。 取值范围： 不涉及。 正常响应样例 { "files": [ { "name": "43e4feaab48f11e89039fa163ebaa7e4br01.xxx", "size": 2803, "download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "link_expired_time":"2018-08-016T10:15:14+0800", "database_name" : "rdsbucket" } ], "bucket": "rdsbucket.bucketname" } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/backup-files?backup_id={backup_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 backup_id 是 参数解释： 备份ID。 获取方法可参考获取备份列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 参数解释： 备份列表。 详情请参见表3。 total_count Integer 参数解释： 总记录数。 取值范围： 不涉及。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 参数解释： 备份ID。 取值范围： 不涉及。 name String 参数解释： 备份名字。 取值范围： 不涉及。 type String 参数解释： 备份类型。 取值范围： auto：自动全量备份。 manual：手动全量备份。 fragment：差异全量备份。 incremental：自动增量备份。对于RDS for MySQL为Binlog备份。 size Long 参数解释： 备份大小，单位：KB 取值范围： 不涉及。 status String 参数解释： 备份状态。 取值范围： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 DELETING：备份删除中。 begin_time String 参数解释： 备份开始时间。 全量备份类型下，指备份开始时间。 MySQL增量备份类型，指备份文件中上一轮增备任务的最后一个事务的提交时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 参数解释： 备份结束时间。 全量备份类型下，指备份结束时间。 MySQL增量备份类型，指备份文件中最后一个事务的提交时间。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 datastore Object 参数解释： 数据库版本信息。 详情请参见表4。 databases Array of objects 参数解释： 用户自建库，仅Microsoft SQL Server的局部备份。 详情请参见表5。 instance_id String 参数解释： 备份所在实例ID。 取值范围： 不涉及。 associated_with_ddm Boolean 参数解释： 是否已被DDM实例关联。 取值范围： false：表示未被DDM实例关联。 true：表示被DDM实例关联。 表4 datastore字段数据结构说明 名称 参数类型 说明 type String 参数解释： 数据库引擎。 取值范围： 不区分大小写。 MySQL PostgreSQL SQLServer version String 参数解释： 数据库版本。 取值范围： 不涉及。 表5 databases字段数据结构说明 名称 参数类型 说明 name String 参数解释： 用户自建数据库名。 取值范围： 不涉及。 正常响应样例 RDS for MySQL实例： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } RDS for PostgreSQL实例： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br03", "name": "xxxx.xxx", "type": "incremental", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "1" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 ", "associated_with_ddm": false }], "total_count": 1 } RDS for SQL Server实例： { "backups": [{ "id ": "43e4feaab48f11e89039fa163ebaa7e4br04", "name": "xxxx.xxx", "type": "manual", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "SQLServer", "version": "2014_WEB" }, "databases": [{ "name": "user01" }, { "name": "user02" }], "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04", "associated_with_ddm": false }], "total_count": 1 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 backup_id 否 参数解释： 备份ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 backup_type 否 参数解释： 备份类型。 约束限制： 不涉及。 取值范围： auto：自动全量备份。 manual：手动全量备份。 fragment：差异全量备份。 incremental：自动增量备份。对于RDS for MySQL为Binlog备份。 默认取值： 不涉及。 status 否 参数解释： 备份状态，只支持筛选RDS for SQL Server的全量备份的状态。 约束限制： 不涉及。 取值范围： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 默认取值： 不涉及。 offset 否 参数解释： 索引位置，偏移量。 约束限制： 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 取值范围： 大于等于0的整数。 默认取值： 0 limit 否 参数解释： 查询记录数。 约束限制： 不能为负数. 取值范围： 最小值为1，最大值为100。 默认取值： 100 begin_time 否 参数解释： 查询开始时间。 约束限制： “begin_time”有值时，“end_time”必选。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 end_time 否 参数解释： 查询结束时间。 约束限制： “end_time”有值时，“begin_time”必选。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800

请求示例 创建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。 表5 backup字段数据结构说明 名称 参数类型 说明 id String 备份ID。 instance_id String 实例ID。 name String 备份名称。 description String 备份描述。 databases Array of objects 只支持SQL Server引擎实例，局部备份的用户自建数据库名列表，当有此参数时以局部备份为准。 详情请参见表3。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”，其中T指时间字段的开始；Z指时区偏移量。 status String 备份状态，取值： BUILDING: 备份中 COMPLETED: 备份完成 FAILED：备份失败 DELETING：备份删除中 type String 备份类型，取值： auto: 自动全量 manual: 手动全量 fragment: 差异全量 incremental: 自动增量。 正常响应样例 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" }] } } 异常响应 请参见异常请求结果。