华为云用户手册

云数据库 RDS-修改指定实例的数据库备注:接口约束

接口约束如果您需要使用该功能，请联系客服提交开启修改数据库备注权限的申请。实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。更新备注的操作不受数据库是否存在影响。若备注存在则更新，不存在则自动新建备注。更新为空值备注将会被删除。若新建备注过程中数据库被删除或不存在，则备注依旧会保存。该方法只针对新版本的实例生效，必须大于等于指定的内核版本，如果不符合内核小版本要求，请参考升级内核小版本升级至最新。 RDS for MySQL 5.6：大于等于5.6.51.3。 RDS for MySQL 5.7：大于等于5.7.33.1。 RDS for MySQL 8.0：大于等于8.0.25.1。除RDS界面和API以外的其他方式创建的数据库和账号，如果创建的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），例如包含中文或不支持的特殊字符，那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。如果源库的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），迁移到目标库RDS for MySQL后，该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

云数据库 RDS
云数据库 RDS-更改主备实例的数据同步方式:响应消息

响应消息正常响应要素说明名称说明 workflowId 任务ID。 instanceId 实例ID。 replicationMode 同步模式。正常响应样例 { "instanceId": "c8a7d0abe94840dda99bc437e9442982in01", "replicationMode": "async", "workflowId": "7b55d6ca-dc8e-4844-a9da-6c53a1506db3" } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-创建参数模板:请求示例

请求示例创建参数模板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" } }

云数据库 RDS
云数据库 RDS-创建参数模板:响应消息

响应消息正常响应要素说明表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" } } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-授予用户角色:URI

URI URI格式 POST /v3/{project_id}/instances/{instance_id}/db-user-role 参数说明表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 instance_id 是参数解释：实例ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-获取指定诊断项的诊断结果:响应消息

响应消息正常响应要素说明表3 字段说明名称参数类型说明 diagnosis String 参数解释：诊断项。取值范围： high_pressure lock_wait insufficient_capacity slow_sql_frequency disk_performance_cap mem_overrun age_exceed connections_exceed total_count Integer 参数解释：实例数量。取值范围：不涉及。 instances Array of objects 参数解释：实例ID。请参见表4。表4 instances字段数据结构说明名称参数类型说明 id String 参数解释：实例ID。取值范围：正常响应样例 { "diagnosis" : "high_pressure", "total_count" : 1, "instances" : [ { "id" : "abd21a25fdedfd6db69721f4b761bc38in04" } ] } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-获取指定诊断项的诊断结果:URI

URI URI格式 GET /v3/{project_id}/instances/diagnosis/info 参数说明表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。表2 请求参数参数是否必选参数类型描述 engine 是 String 参数解释：引擎类型。约束限制：不涉及。取值范围： mysql postgresql sqlserver 默认取值：不涉及。 diagnosis 是 String 参数解释：诊断项。约束限制：不涉及。取值范围： high_pressure lock_wait insufficient_capacity slow_sql_frequency disk_performance_cap mem_overrun age_exceed connections_exceed 默认取值：不涉及。 offset 否 Integer 参数解释：索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。约束限制：不涉及。取值范围：必须为数字，不能为负数。默认取值：默认为0，偏移0条数据，表示从第一条数据开始查询。 limit 否 Integer 参数解释：返回结果的条数。约束限制：不涉及。取值范围：不涉及。默认取值： 10

云数据库 RDS
云数据库 RDS-查询错误日志:请求消息

请求消息表2 参数说明名称是否必选参数类型说明 start_time 是 String 开始日期，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。开始时间不能早于当前时间一个月之前。 end_time 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。只能查询当前时间前一个月内的错误日志。 level 否 String 日志级别，默认为ALL。枚举值： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE line_num 否 String 日志单行序列号，第一次查询时不需要此参数，后续分页查询时需要使用，可从上次查询的返回信息中获取。line_num应在start_time和end_time之间。 search_type 否 String 搜索方式。默认forwards。配合line_num使用，以line_num为起点，向前搜索或向后搜索。 limit 否 Integer 每页多少条记录（查询结果），取值范围是1~100，不填时默认为10。

云数据库 RDS
云数据库 RDS-查询错误日志:请求示例

请求示例查询错误日志，每页10条记录。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/error-logs { "start_time":"2023-01-05T08:00:00+0800", "end_time":"2023-01-11T20:00:00+0800", "limit":10, "line_num":"1672908793000000000", "search_type":"forwards" }

云数据库 RDS
云数据库 RDS-查询错误日志:响应消息

响应消息正常响应要素说明表3 要素说明名称参数类型说明 error_log_list Array of objects 日志数据集合。详情请参见表4。表4 error_log_list字段数据结构说明名称参数类型说明 time String 日期时间，UTC时间。 level String 日志级别。 content String 错误日志内容。 line_num String 日志单行序列号。正常响应样例 { "error_log_list" : [ { "time" : "2022-08-23T22:59:17Z", "level" : "WARNING", "content" : "Occur error when reading bytes from a network handler. Client actively closes the connection.", "line_num" : "1595659490239433658" } ] } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-表级时间点恢复（MySQL）:请求消息

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

云数据库 RDS
云数据库 RDS-表级时间点恢复（MySQL）:请求示例

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

云数据库 RDS
云数据库 RDS-表级时间点恢复（MySQL）:URI

URI URI格式 POST /v3.1/{project_id}/instances/{instance_id}/restore/tables 参数说明表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 instance_id 是参数解释：实例ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-查询扩展日志（SQL Server）:响应消息

响应消息正常响应要素说明表2 要素说明名称参数类型说明 list Array of objects 扩展日志文件信息。详情请参见表3。 count Integer 文件总数。表3 SlowLogFile字段数据结构说明参数参数类型描述 file_name String 文件名。 file_size String 文件大小（单位：KB）。正常响应样例 { "list" : [ { "file_name" : "SQLTrace.xel", "file_size" : "1024" }, { "file_name" : "SQLTrace2.xel", "file_size" : "1024" } ], "count" : 2 } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-查询扩展日志（SQL Server）:URI

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/xellog-files 参数说明表1 参数说明名称是否必选说明 project_id 是租户在某一Region下的项目ID。获取方法请参见获取项目ID。 instance_id 是查询的实例ID。 offset 否索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否每页多少条记录，取值范围是1~100，不填时默认为10。

云数据库 RDS
云数据库 RDS-查询数据库磁盘类型:URI

URI URI格式 GET /v3/{project_id}/storage-type/{database_name}?version_name={version_name}&ha_mode={ha_mode} 参数说明表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 database_name 是参数解释：数据库引擎名。约束限制：不涉及。取值范围：支持如下数据库引擎，不区分大小写： MySQL PostgreSQL SQLServer 默认取值：不涉及。 version_name 是参数解释：数据库引擎版本号。约束限制：不涉及。取值范围：获取方法请参见查询数据库引擎的版本。对于MySQL引擎，需转化为其大版本号，例如5.6、5.7、8.0。默认取值：不涉及。 ha_mode 否参数解释：主备模式。约束限制：不涉及。取值范围： single：单机模式。 ha：主备模式。 replica：只读模式。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-查询跨区域备份可恢复时间段:请求消息

请求消息请求参数无。 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

云数据库 RDS
云数据库 RDS-查询跨区域备份可恢复时间段:响应消息

响应消息正常响应要素说明表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 } ] } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-查询跨区域备份可恢复时间段:URI

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。

云数据库 RDS
云数据库 RDS-设置实例读写状态:接口约束

接口约束该接口目前仅支持RDS for MySQL引擎。该接口目前仅支持单机实例和HA实例。实例在创建、变更规格、冻结、异常等状态下不能执行该操作。非该接口设置（如：磁盘满、DRS迁移等）导致实例只读的情况，不能通过该接口恢复实例为“读写”状态。该接口仅设置主实例的读写状态，区别于只读实例的概念。设置实例读写状态功能目前处于部分区域公测中，如果所在区域未开放此功能，请联系客服开通白名单。

云数据库 RDS
云数据库 RDS-查询自动备份策略:响应消息

响应消息正常响应要素说明表2 要素说明名称参数类型说明 backup_policy Object 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表3。表3 backup_policy字段数据结构说明名称参数类型说明 keep_days Integer 备份文件可以保存的天数。 start_time String 备份时间段。自动备份将在该时间段内触发，当前时间段为UTC时间。 period String 备份周期配置。自动备份将在每星期指定的天进行。正常响应样例自动备份策略关闭时： { "backup_policy": { "keep_days": 0 } } 自动备份策略开启时： { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2" } } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-查询实例内核小版本自动升级策略（PostgreSQL）:URI

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/db-auto-upgrade 参数说明表1 参数说明名称是否必选参数类型说明 project_id 是 String 参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：非空。取值范围：不涉及。默认取值：不涉及。 instance_id 是 String 参数解释：实例ID。约束限制：非空。取值范围：不涉及。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-查询慢日志统计信息:请求示例

请求示例查询慢日志的统计数据，每页10条记录。 POST https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slow-logs/statistics { "start_time":"2023-01-05T08:00:00+0800", "end_time":"2023-01-11T20:00:00+0800", "limit":10, "order":"asc" }

云数据库 RDS
云数据库 RDS-查询慢日志统计信息:URI

URI URI格式 POST /v3.1/{project_id}/instances/{instance_id}/slow-logs/statistics 参数说明表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 instance_id 是参数解释：要查询的实例ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-库级时间点恢复:请求示例

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

云数据库 RDS
云数据库 RDS-库级时间点恢复:响应消息

响应消息正常响应要素说明表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" } ] } 异常响应请参见异常请求结果。

云数据库 RDS
云数据库 RDS-库级时间点恢复:请求消息

请求消息表2 参数说明名称是否必选参数类型说明 instances 是 Array of objects 库级恢复实例信息。详细说明请参见表3。表3 instances字段数据结构说明名称是否必选参数类型说明 restore_time 是 Long 恢复时间点，采用毫秒时间戳。 instance_id 是 String 实例ID。 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
云数据库 RDS-重置数据库账号密码:请求消息

请求消息表2 参数说明名称是否必选参数类型说明 name 是 String 参数解释：数据库账号名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 password 是 String 参数解释：数据库账号密码。约束限制：不涉及。取值范围：非空，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊符号~!@#%^*-_=+?,组成，长度8~32个字符，不能包含数据库账号名称或名称的逆序。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-重置数据库账号密码:URI

URI URI格式 POST /v3/{project_id}/instances/{instance_id}/db_user/resetpwd 参数说明表1 参数说明名称是否必选说明 project_id 是参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。 instance_id 是参数解释：实例ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

云数据库 RDS
云数据库 RDS-查询跨区域备份实例列表:URI

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

云数据库 RDS

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！