华为云用户手册

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 slow_log_list Array of objects 具体信息。 详情请参见表3。 total_record Integer 总记录数。 表3 slow_log_list字段数据结构说明 名称 参数类型 说明 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 账号。 query_sample String 执行语法。慢日志默认脱敏显示，如需明文显示，请联系客服人员添加白名单。 type String 语句类型。 start_time String 发生时间，UTC时间。 client_ip String IP地址。 正常响应样例 { "total_record": 1, "slow_log_list": [ { "count": "1", "time": "1.04899 s", "lock_time": "0.00003 s", "rows_sent": "0", "rows_examined": "0", "database": "mysql", "users": "root", "query_sample": "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N, @time_zone_id);", "type": "INSERT", "start_time": "2018-08-06T10:41:14", "client_ip": "192.*.*.1" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3.1/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 start_date 是 开始日期，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。只能查询当前时间前一个月内的慢日志。 offset 否 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 支持最多查询数据库最近的2000条慢日志信息，参数值须满足offset + limit取值小于等于2000。示例：offset取值为1900，limit取值100。 limit 否 每页多少条记录（查询结果），取值范围是1~100，不填时默认为10。 type 否 语句类型，取空值，表示查询所有语句类型，也可指定如下日志类型： INSERT UPDATE SELECT DELETE CREATE

URI URI格式 GET /v3.1/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 start_date 是 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 只能查询当前时间前一个月内的错误日志。 offset 否 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 每页多少条记录（查询结果），取值范围是1~100，不填时默认为10。 level 否 日志级别，默认为ALL，可取值如下： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 error_log_list Array of objects 具体信息。 详情请参见表3 errorLogList字段数据结构说明。 total_record Integer 总记录数。 表3 error_log_list字段数据结构说明 名称 参数类型 说明 time String 日期时间UTC时间。 level String 日志级别。 content 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." }, { "time": "2022-08-23T22:54:17Z", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." } ], "total_record": 2 } 异常响应 请参见异常请求结果。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/errorlog?offset=1&limit=10&start_date=2022-08-23T07:41:50+0800&end_date=2022-08-24T07:41:50+0800&level=ALL

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 list List 扩展日志下载链接列表，详见表4。 count Integer 扩展日志链接数量。 表4 linkInfo字段数据结构说明 名称 参数类型 说明 file_name String 生成的下载文件名。 status String 链接的生成状态。 FINISH，表示下载链接已经生成。 EXPORTING，表示正在生成文件。 FAILED，表示存在日志文件准备失败。 file_size String 文件大小，单位：KB。 file_link String 下载链接，链接的生成状态为EXPORTING，或者FAILED时不予返回。 create_at String 生成时间。 update_at String 更新时间。 正常响应样例 正在生成扩展日志下载链接 { "list": [ { "file_name": "HkEngineEventFile_0_133337769850300000.xel", "status": "EXPORTING", "file_size": "0", "create_at": "2023-08-14T03:35:24+0000", "update_at": "2023-08-14T03:35:24+0000" } ], "count": 1 } 扩展日志下载链接获取成功 { "list": [ { "file_name": "HkEngineEventFile_0_133337769850300000.xel", "status": "SUC CES S", "file_size": "0", "file_link": "https://obs.xxx:443/xxx-7a95af72c4d54a31ae0663263f0e35ea/6e22b18b43a74e4486264194f6e09f66_EL_HkEngineEventFile_0_133337769850300000.xel?xxx", "create_at": "2023-08-14T03:35:41+0000", "update_at": "2023-08-14T03:35:41+0000" } ], "count": 1 } 异常响应 请参见异常请求结果。

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

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。

请求示例 查询慢日志的统计数据，每页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" }

请求示例 查询错误日志，每页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" }

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

请求消息 表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。

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

请求示例 查询慢日志数据，每页10条记录。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slow-logs { "start_time":"2023-01-02T23:58:57+0000", "end_time":"2023-01-06T01:47:20+0000", "limit":10, "line_num":"1672908793000000000" }

URI URI格式 PUT /v3/{project_id}/instances/{instance_id}/slowlog-sensitization/{status} 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 要查询的实例ID。 status 是 String 开启或关闭慢日志敏感信息明文，取值为on或off。 on：表示开关打开。 off：表示开关关闭。

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

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 error_log_list Array of objects 具体信息。 详情请参见表3 errorLogList字段数据结构说明。 total_record Integer 总记录数。 表3 error_log_list字段数据结构说明 名称 参数类型 说明 time String 日期时间UTC时间。 level String 日志级别。 content String 错误日志内容。 正常响应样例 { "error_log_list": [{ "time": "2018-12-04T14:24:42", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }, { "time": "2018-12-04T14:24:42", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }], "total_record": 2 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 start_date 是 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 只能查询当前时间前一个月内的错误日志。 offset 否 页数偏移量，如1、2、3、4等，不填时默认为1。 limit 否 每页多少条记录，取值范围是1~100，不填时默认为10。 level 否 日志级别，默认为ALL，可取值如下： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/errorlog?offset=1&limit=10&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800&level=ALL

响应消息 正常响应要素说明 表2 要素说明 名称 是否必选 参数类型 说明 binlog_retention_hours 是 Integer 二进制日志保留时间。 binlog_clear_type 否 String 二进制日志保留策略，取值：time、fast time：表示按时长保留二进制文件。 fast：表示快速清理，不保留二进制文件。 正常响应样例 { "binlog_retention_hours": 3, "binlog_clear_type": "time" } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/slowlog/statistics?cur_page={cur_page}&per_page={per_page}&type={type}&start_date={start_date}&end_date={end_date}&sort={sort} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 cur_page 是 页偏移量，即当前页码，如1、2、3、4等。 per_page 是 每页多少条记录，取值范围是0~100。 start_date 是 开始日期，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 type 是 语句类型，取空值，表示查询所有语句类型，也可指定如下日志类型： INSERT UPDATE SELECT DELETE CREATE ALL sort 否 指定排序字段。 "executeTime"，表示按照执行时间降序排序。 字段为空或传入其他值，表示按照执行次数降序排序。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog/statistics?cur_page=1&per_page=2&type=INSERT&start_date=2020-02-06T10:41:14+0800&end_date=2020-02-07T10:41:14+0800&sort=executeTime

响应消息 正常响应要素说明 表2 字段说明 名称 参数类型 说明 pageNumber Integer 当前页码。 pageRecord Integer 每页条数。 slowLogList List 请参见表3。 totalRecord Integer 总条数。 startTime Long 开始时间。 endTime Long 结束时间。 表3 slowLogList字段数据结构说明 名称 参数类型 说明 count String 执行次数。 time String 执行时间。 lockTime String 等待锁时间。 rowsSent Long 结果行数量。 rowsExamined Long 扫描的行数量。 database String 所属数据库。 users String 账号。 querySample String 执行语法。 type String 语句类型。 clientIP String IP地址。 正常响应样例 { "pageNumber": 1, "pageRecord": 10, "slowLogList": [], "totalRecord": 0, "startTime": null, "endTime":null } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 tags Array of objects 标签列表，没有标签默认为空数组。 详情请参见表3。 表3 tags字段数据结构说明 名称 参数类型 说明 key String 标签键。 value String 标签值。 tag_type String 标签类型。 枚举类型：user、system 正常响应样例 { "tags": [{ "key": "keyName", "value": "keyValue", "tag_type": "user" }] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 tde_status String TDE开启状态。 枚举值： open：已开启 close：关闭中 正常响应样例 { "instance_id":"3d39c18788b54a919bab633874c159dfin04", "tde_status":"open" } 异常响应 请参见异常请求结果。

请求示例 开启实例TDE（不使用TDE轮转）。 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/tde {} 开启实例TDE（使用TDE轮转）。 { "rotate_day": 365, "secret_id":"d0964270-2716-405b-bc3a-12a942451716", "secret_name":"test", "secret_version":"v10" }

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

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

接口约束 如果您需要使用该功能，请联系客服提交开启修改数据库备注权限的申请。 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 更新备注的操作不受数据库是否存在影响。 若备注存在则更新，不存在则自动新建备注。 更新为空值备注将会被删除。 若新建备注过程中数据库被删除或不存在，则备注依旧会保存。 该方法只针对新版本的实例生效，必须大于等于指定的内核版本，如果不符合内核小版本要求，请参考升级内核小版本升级至最新。 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的数据库管理和账号管理功能。