华为云用户手册

请求示例 复制一个新的参数模板，名称为copy_by_v31。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations/66251c9024774eeb9edd8663a4cbb0a1pr04/copy { "name" : "copy_by_v31", "description" : "copy" }

URI URI格式 GET /v3/{project_id}/configurations/{config_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 config_id 是 参数模板ID。 当“config_id”为空（非空格）时，相当于获取参数模板列表的URL，具体请参见获取参数模板列表。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 description String 描述。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 configuration_parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见表3。 表3 configuration_parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 restart_required Boolean 是否需要重启。 “false”表示否。 “true”表示是。 readonly Boolean 是否只读。 “false”表示否。 “true”表示是。 value_range String 参数值范围，如integer取值0-1、boolean取值true或者false等。 type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 description String 参数描述。 正常响应样例 { "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name": "default-mysql-5.7", "datastore_version_name": "5.7", "datastore_name": "mysql", "description": "Default parameter group for mysql 5.7", "created": "2017-05-05T04:40:51+0800", "updated": "2017-05-05T04:40:51+0800", "configuration_parameters": [ { "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": true, "value_range": "1-65535", "type": "integer", "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns." }, { "name": "autocommit", "value": "ON", "restart_required": false, "readonly": true, "value_range": "ON|OFF", "type": "boolean", "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. " } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 configuration_parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见表3。 表3 configuration_parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 restart_required Boolean 是否需要重启。 “false”表示否。 “true”表示是。 readonly Boolean 是否只读。 “false”表示否。 “true”表示是。 value_range String 参数值范围，如Integer取值0-1、Boolean取值true或者false等。 type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 description String 参数描述。 正常响应样例 { "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2018-10-11 11:40:44", "updated": "2018-10-11 11:40:44", "configuration_parameters": [{ "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": false, "value_range": "1-65535", "type": "integer", "description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。" }] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 job_id String 任务ID。 restart_required Boolean 实例是否需要重启。 “true”需要重启。 “false”不需要重启。 ignored_params List 请求参数“values”中被忽略掉，没有生效的参数名称列表。 当参数不存在时，参数修改不会下发，并通过此参数返回所有被忽略的参数名称。 正常响应样例 { "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94", "restart_required" : "false", "ignored_params": [] } 异常响应 请参见异常请求结果。

接口约束 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库 RDS用户指南》中的“《云数据库(RDS) 25.1.30 用户指南(for 华为云Stack 8.5.1)》”中的“《云数据库 PostgreSQL 25.1.30 用户指南(for 华为云Stack 8.5.1)》”中“修改实例参数”的内容。 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。

请求示例 MySQL请求示例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations { "values" : { "max_connections" : "10", "autocommit" : "OFF", "binlog_checksum" : "CRC32", "innodb_purge_threads" : "4" } } PostgreSQL请求示例 { "values" : { "max_connections" : "10", "autovacuum" : "on", "bytea_output" : "escape", "client_encoding" : "UTF8", "cpu_tuple_cost" : "0.01" } }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 configuration_id String 参数模板ID。 configuration_name String 参数模板名称。 success Boolean 参数模板是否都应用成功。 “true”表示参数模板都应用成功。 “false”表示存在应用失败的参数模板。 job_id String 任务流ID。 正常响应样例 { "configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01", "configuration_name": "paramsGroup-bcf9", "job_id":"e4942c94-9d66-458e-beb7-90601664641e", "success":true } 异常响应 请参见异常请求结果。

请求示例 将参数模板应用到多个实例。 PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply { "instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"] }

请求示例 修改参数模板的参数值。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9 { "name": "configuration_test", "description": "configuration_test", "values": { "div_precision_increment": "6", "connect_timeout": "20" } }

接口约束 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。 修改参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复，默认参数模板不允许修改。 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库 RDS用户指南》中的“《云数据库(RDS) 25.1.30 用户指南(for 华为云Stack 8.5.1)》”中的“《云数据库 PostgreSQL 25.1.30 用户指南(for 华为云Stack 8.5.1)》”中“修改实例参数”的内容。 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。 要修改的参数信息，不可全部为空。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 configuration Object 参数模板信息。详情请参见表4。 表4 configuration字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 ignored_params List 请求参数“values”中被忽略掉，没有生效的参数名称列表。 当参数不存在时，参数修改不会下发，并通过此参数返回所有被忽略的参数名称。 正常响应样例 { "configuration": { "id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9", "name": "configuration_test", "ignored_params": {} } } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表4 要素说明 名称 参数类型 说明 configuration Object 参数模板信息。 详情请参见表5。 表5 configuration字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 description String 描述。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 正常响应样例 { "configuration": { "id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9", "name": "configuration_test", "datastore_version_name": "5.7", "datastore_name": "mysql", "description": "configuration_test", "created": "2017-04-09T08:27:56+0800", "updated": "2017-04-09T08:27:56+0800" } } 异常响应 请参见异常请求结果。

请求示例 创建参数模板configuration_test。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations { "name": "configuration_test", "description": "configuration_test", "values": { "div_precision_increment": "6", "connect_timeout": "20" }, "datastore": { "type": "mysql", "version": "5.7" } }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 configurations Array of objects 参数模板列表。 详情请参见表3。 表3 configurations字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 description String 参数模板描述。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 user_defined Boolean 是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。 正常响应样例 { "configurations": [{ "id": "887ea0d1bb0843c49e8d8e5a09a95652pr01", "name": "configuration_test", "description": "configuration_test", "datastore_version_name": "8.0", "datastore_name": "mysql", "created": "2019-05-15T11:53:34+0000", "updated": "2019-05-15T11:53:34+0000", "user_defined": true }, { "id": "3bc1e9cc0d34404b9225ed7a58fb284epr01", "name": "Default-MySQL-5.7", "description": "Default parameter group for MySQL 5.7", "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2019-05-27T03:38:51+0000", "updated": "2019-05-27T03:38:51+0000", "user_defined": false } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表7 要素说明 名称 参数类型 说明 restore_result Array of objects 表信息。详细说明请参见表8。 表8 restore_result字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID。 job_id String 工作流ID。 正常响应样例 { "restore_result" : [ { "instance_id" : "df29b535eec64ee1b286bd2c62871a9cin03", "job_id" : "749d6254-f4f0-4f72-aa32-876e220d2496" } ] } 异常响应 请参见异常请求结果。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 instances 否 Array of objects 表信息。详细说明请参见表3。 表3 instances字段数据结构说明 名称 是否必选 参数类型 说明 restore_time 否 Long 恢复时间。 instance_id 否 String 实例ID。 databases 否 Array of objects 数据库信息。详细说明请参见表4。 表4 databases字段数据结构说明 名称 是否必选 参数类型 说明 database 否 String 数据库名。 schemas 否 Array of objects 模式信息。详细说明请参见表5。 表5 schemas字段数据结构说明 名称 是否必选 参数类型 说明 schema 否 String 模式信息。 tables 否 Array of objects 表信息。详细说明请参见表6。 表6 tables字段数据结构说明 名称 是否必选 参数类型 说明 old_name 否 String 恢复前表名。 new_name 否 String 恢复后表名。 请求样例 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/batch/restore/tables { "instances": [{ "restore_time": 1688556737000, "instance_id": "df29b535eec64ee1b286bd2c62871a9cin03", "databases": [{ "database": "data1", "schemas": [{ "schema": "schema1", "tables": [{ "old_name": "table1", "new_name": "table1_1688556737000" }] }], }] }] }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 table_limit Integer 恢复表数量限制个数。 instances Array of objects 实例信息。详细说明请参见表4。 表4 instances字段数据结构说明 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 total_tables Integer 可恢复表的数量。 databases Array of objects 数据库信息。详细说明请参见表5。 表5 databases字段数据结构说明 参数 参数类型 描述 name String 数据库名。 total_tables Integer 可恢复表的数量。 schemas Array of objects 模式信息。详细说明请参见表6。 表6 schemas字段数据结构说明 参数 参数类型 描述 name String 模式名。 total_tables Integer 可恢复表的数量。 tables Array of objects 表信息。详细说明请参见表7。 表7 tables字段数据结构说明 参数 参数类型 描述 name String 表名。 正常响应样例 { "instances" : [ { "id" : "70f639ffa8e343e1b7797c1705d4fe71in03", "name" : "rds-e1c8", "databases" : [ { "name" : "db1", "schemas" : [ { "name" : "public", "tables" : [ { "name" : "tb1" } ], "total_tables" : 1 }, { "name" : "schema1", "tables" : [ { "name" : "tb1" } ], "total_tables" : 1 } ], "total_tables" : 2 } ], "total_tables" : 2 } ], "table_limit" : 2000 } 异常响应 请参见异常请求结果。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 instance_ids 是 Array of strings 实例ID集合。 restore_time 是 Long 恢复时间点。 database_name_like 否 String 数据库名，模糊查询。 table_name_like 否 String 数据库表名，模糊查询。 instance_name_like 否 String 实例名称，模糊查询。 请求样例 POST https://{endpoint}/v3/4879de6859e345c780f1a22d8bc6f229/postgresql/instances/history/tables { "instance_ids" : [ "f9e0b25a7b984a5cb193bebc98029914in03" ], "restore_time" : 1688554112000, "database_name_like" : "", "table_name_like" : "", "instance_name_like" : "" }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 instances 是 Array of objects 库级恢复实例信息。详细说明请参见表3。 表3 instances字段数据结构说明 名称 是否必选 参数类型 说明 restore_time 是 Long 恢复时间点，采用毫秒时间戳。 instance_id 是 String 实例ID。当前仅支持MySQL引擎实例。 databases 是 Array of objects 库信息。详细说明请参见表4。 is_fast_restore 否 Boolean 是否使用极速恢复。取值：true、false。 配置该参数时，参考查询实例是否能在库表恢复时使用极速恢复（MySQL）接口判断本次恢复是否能使用极速恢复。能使用极速恢复时，如果实例存在XA事务，会导致数据丢失，请选择普通恢复，即设置参数值为“false”。 不传该参数时，将根据查询实例是否能在库表恢复时使用极速恢复（MySQL）的查询结果，默认是否使用极速恢复。如果支持极速恢复功能，并且实例存在XA事务，请选择普通恢复，即传参并设置参数值为“false”。 表4 databases字段数据结构说明 名称 是否必选 参数类型 说明 old_name 是 String 恢复前库名。不支持含中文的库名。 new_name 是 String 恢复后库名。支持字母、数字、中划线、下划线和$字符的组合。不支持新库名和原库名重名。

请求示例 RDS for MySQ L实例 恢复指定库到指定时间点。 { "instances" : [ { "instance_id" : "5d742eda6e574ff3a003191638ef8c51in01", "restore_time" : 1699323939000, "databases" : [ { "old_name" : "dbtest", "new_name" : "dbtest_restore" } ] } ] }

响应消息 正常响应要素说明 表5 要素说明 名称 参数类型 说明 restore_result Array of objects 库级时间点恢复任务信息。详细说明请参见表6。 表6 restore_result字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID。 job_id String 工作流ID。 正常响应样例 RDS for MySQL实例恢复指定库到指定时间点： { "restore_result" : [ { "instance_id" : " 5d742eda6e574ff3a003191638ef8c51in01", "job_id" : "749d6254-f4f0-4f72-aa32-876e220d2496" } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 database_limit Integer 单个实例支持恢复的库数量上限。如果单个实例在可恢复时间点查询到的库超过上限，响应中只返回上限数量的库。 table_limit Integer 单个实例支持恢复的所有库中包含的总的表数量上限。如果数据库在可恢复时间点查询到的表数量超过上限，响应中只返回总表数不超出上限的库。 instances Array of objects 实例信息。详细说明请参见表4。 表4 instances字段数据结构说明 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 total_tables Integer 该实例中所有可恢复库中包含表的总个数。最大不超过table_limit。 databases Array of objects 数据库信息。详细说明请参见表5。 表5 databases字段数据结构说明 参数 参数类型 描述 name String 数据库名。当前不支持库名含中文的库恢复，可恢复库查询会过滤库名含中文的库。 total_tables Integer 该数据库中包含表的总个数。最大不超过table_limit。 正常响应样例 RDS for MySQL实例指定时间点查询可恢复的库： { "instances": [ { "id": "5d742eda6e574ff3a003191638ef8c51in01", "name": "AUTO-GENERATED-INSTANCE-57-HA-LOCALSSD", "databases": [ { "name": "dbtest", "total_tables": 1 }, { "name": "dbtest_restore", "total_tables": 1 } ], "total_tables": 2 } ], "database_limit": 2000, "table_limit": 20000 } 异常响应 请参见异常请求结果。

请求示例 查询RDS for MySQL实例指定时间点可恢复的库。 POST http://{endpoint}/v3/54623db08b174c858ba779d2aa7923a3/mysql/instances/history/databases { "instance_ids" : [ "5d742eda6e574ff3a003191638ef8c51in01" ], "restore_time" : 1688554422000, "database_name_like" : "", "instance_name_like" : "" }

请求示例 恢复表数据到指定时间点。 POST https://{endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/d8e6ca5a624745bcb546a227aa3ae1cfin01/restore/tables { "restore_time" : 1689859468000, "restore_tables" : [ { "database" : "database", "tables" : [ { "old_name" : "oldTable", "new_name" : "newTable" } ] } ] }

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

响应消息 正常响应要素说明 表3 响应Body参数 名称 参数类型 说明 support_fast_restore_list Array of objects 实例的极速恢复支持情况。详细说明请参见表support_fast_restore_list字段数据结构说明。 表4 support_fast_restore_list字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 is_support_fast_table_restore Boolean 表级恢复是否支持极速恢复。 is_support_fast_database_restore Boolean 库级恢复是否支持极速恢复。 正常响应样例 { "support_fast_restore_list" : [ { "instance_id" : "14fc6c06d7e842829ee91d11c6b88b3ain01", "is_support_fast_table_restore" : true, "is_support_fast_database_restore" : true } ] } 异常响应 请参见异常请求结果。

请求示例 查询实例是否能在库表恢复时使用极速恢复。 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。