华为云用户手册

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

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

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 backup_policy 是 Object 备份策略对象，包括备份保留的天数和备份开始时间。 详情请参见表3。 reserve_backups 否 Boolean 仅关闭备份策略时有效，默认为true。 true：表示保留自动备份和差异备份。 false：表示关闭备份策略的同时，删除已有的自动备份和差异备份。 表3 backup_policy字段数据结构说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～732。取0值，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。 须知： 关闭备份策略后，备份任务将立即停止，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。 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 period 否 String 备份周期配置。自动备份将在每星期指定的天进行。除关闭自动备份策略外，必选。 取值范围：格式为逗号隔开的数字，数字代表星期。 取值示例：1,2,3,4则表示备份周期配置为星期一、星期二、星期三和星期四。

请求示例 设置周一和周二19:00~20:00内进行自动备份，备份文件保留7天。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/policy { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2" } } 关闭自动备份策略。 { "backup_policy": { "keep_days": 0 }, "reserve_backups": false }

请求示例 修改rdsuser用户的密码。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/161e33e453954e21acfff65bfa3dbfebin04/db_user/resetpwd { "name": "rdsuser", "password": "Test@12345678" }

请求示例 添加MSDTC相关主机地址。 POST https://{endpoint}/v3/054b93101a00d3a02fe3c01fb31462ac/instances/463a6520abc345888850ea5bfb245e4fin04/msdtc/host { "hosts" : [ { "host_name" : "pc1", "ip" : "127.0.0.1" } ] }

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 total_count Integer host总数。 hosts Array of objects host列表。 详情请参见表3。 表3 hosts元素结构说明 名称 参数类型 说明 id String host ID。 host String host地址。 host_name String host名称。 正常响应样例 { "total_count" : 1, "hosts" : [ { "id" : "527dd9ca-cc2c-4bac-8707-f9b4f55343f4", "host" : "192.168.0.90", "host_name" : "MSSQL-00E5FB7A" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/msdtc/hosts?offset={offset}&limit={limit} 参数说明 表1 参数说明 参数 是否必选 参数类型 说明 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 offset 否 Integer 分页参数最小为0。 缺省值：0 limit 否 Integer 分页参数取值范围1~100。 缺省值：10

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 db-name 是 数据库名。 page 是 分页页码，从1开始。 limit 是 每页数据条数。取值范围[1, 100]。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 列表中每个元素表示一个数据库账号。 详情请参见表3。 total_count Integer 数据库用户总数。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 正常响应样例 { "users": [ { "name": "rds" }, { "name": "rds001" } ], "total_count": 3 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 page 是 分页页码，从1开始。 limit 是 每页数据条数。取值范围[1, 100]。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 列表中每个元素表示一个数据库账号。 详情请参见表3。 total_count Integer 数据库用户总数。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 state String 数据库用户状态。 “unavailable”表示不可用。 “available”表示可用。 正常响应样例 { "users": [ { "name": "rdsuser", "state": "available" }, { "name": "login001", "state": "available" } ], "total_count": 2 } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 users 是 Array of objects 每个元素是与数据库相关联的账号。单次请求最多支持50个元素。 每个元素结构请参见表3。 表3 users列表元素数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到128个字符之间，不能和系统用户名称相同。 系统用户包括：rdsadmin, rdsuser, rdsbackup, rdsmirror。

请求示例 DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a8abe84a41364097be7c233c39275087in04/db_privilege { "db_name": "rds-test", "users": [ { "name": "rds" }, { "name": "rds001" } ] }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 users 是 Array of objects 每个元素都是与数据库相关联的账号。单次请求最多支持50个元素。 每个元素结构请参见表3。 表3 users列表元素数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。目前不支持对不带登录名的SQL用户进行授权。 数据库账号名称在1到128个字符之间，不能和系统用户名称相同。 系统用户包括：rdsadmin, rdsuser, rdsbackup, rdsmirror。 readonly 否 Boolean 是否为只读权限，默认值为false。 “true”表示只读。 “false”表示可读写。

请求示例 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/a8abe84a41364097be7c233c39275087in04/db_privilege { "db_name": "rds-test", "users": [ { "name": "rds", "readonly": true }, { "name": "rds001", "readonly": false } ] }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到128个字符之间，不能和系统用户名称相同。 系统用户包括：rdsadmin, rdsuser, rdsbackup, rdsmirror。 password 是 String 数据库账号密码。 取值范围：非空，密码长度在8到32个字符之间，至少包含大写字母、小写字母、数字、特殊字符~!@#$%^*-_+?,三种字符的组合，不能与账号名或倒序的账号名相同。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库名称。 数据库名称长度可在1～64个字符之间，由字母、数字、中划线、下划线或英文句点组成，不能包含其他特殊字符，且不能以RDS for SQL Server系统库开头或结尾。 RDS for SQL Server系统库包括master，msdb，model，tempdb，resource以及rdsadmin。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 start_time 是 开始时间，格式为UTC时间戳。 end_time 否 结束时间，格式为UTC时间戳。

响应消息 正常响应要素说明 表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

响应消息 正常响应要素说明 表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

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

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