华为云用户手册

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

请求示例 批量添加标签key1和key2 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action { "action": "create", "tags": [{ "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }] }

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 action 是 String 操作标识（区分大小写）：创建时为“create”。 tags 是 Array of objects 标签列表。单个实例总标签数上限20个。 详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 标签键。长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 value 是 String 标签值。最大长度255个unicode字符，可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。

请求示例 获取慢日志文件“Database_slowlog_name”的下载链接 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog-download { "file_name":"Database_slowlog_name" }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 list List 慢日志下载链接列表，详见表4。 status String 慢日志下载链接生成状态。 FINISH，表示下载链接已经生成完成。 CREATING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。 count Integer 慢日志链接数量。 表4 linkInfo字段数据结构说明 名称 参数类型 说明 workflow_id String 任务ID。MySQL引擎该字段值固定为""。 file_name String 生成的下载文件名。 status String 当前链接的生成状态。 EXPORTING，下载链接正在生成中。 SUCCESS，下载链接生成成功。 FAILED，下载链接生成失败。 file_size String 文件大小。单位：KB。 file_link String 下载链接。链接有效时间为5分钟。 create_at Long 生成时间。 update_at Long 更新时间。 正常响应样例 { "list": [ { "workflow_id": "44fb1d85-2fcc-4d63-ad3b-c3d1ecd7000e", "file_name": "054bc9c1f680d55c1f36c006e5a9f67b_slowlog_download_20200515080614589", "status": "SUCCESS", "file_size": "0", "file_link": "https://rdsbucket.xxxr.obs.cn-xianhz-1.myhuaweicloud.com:443/054bc9c1f680d55c1f36c006e5a9f67b_slowlog_download_20200515080614589?AWSAccessKeyId=1BQ38TBCQHAVQXBUMUTC&Expires=1589530200&response-cache-control=no-cache%2Cno-store&Signature=Fgi4%2BLOJ9frAXyOkz5hRoW5O%2BUM%3D", "create_at": 1589529991385, "update_at": 1589529991385 } ], "status": "finish", "count": 1 } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 total_count Integer 数据库总数。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 character_set String 数据库使用的字符集，例如Chinese_PRC_CI_AS等。 state String 数据库状态。取值如下： Creating：表示创建中。 Running：表示使用中。 Deleting：表示删除中。 NotExists：表示不存在。 正常响应样例 { "databases": [ { "name": "master", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "msdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "model", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "tempdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rdsadmin", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rds-test", "character_set": "Chinese_PRC_CI_AS", "state": "Running" } ], "total_count": 6 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit}&db-name={db-name}&recover_model={recover_model} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 page 是 分页页码，从1开始。 limit 是 每页数据条数。取值范围[1, 100]。 db-name 否 数据库名。当指定该参数时，page和limit参数需要传入但不生效。 recover_model 否 数据库恢复健康模式。取值： FULL：完整模式。 SIMPLE：简单模式。 BULK_LOGGED：大容量日志恢复模式。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 start_time 是 String 开始时间，UTC时间。 end_time 是 String 结束时间，UTC时间。 说明： RDS for MySQL和RDS for PostgreSQL数据库的结束时间和开始时间必须为整点时间，相隔一至四个小时。 RDS for SQL Server数据库的结束时间和开始时间必须相隔四个小时。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 数据库名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和RDS for PostgreSQL模板库重名。 RDS for PostgreSQL模板库包括postgres， template0 ，template1。 schemas 是 Array of objects 每个元素都是与数据库相关联的schmea信息。单次请求最多支持20个元素。 每个元素结构请参见表3。 表3 schemas列表元素数据结构说明 名称 是否必选 参数类型 说明 schema_name 是 String schema名称。 schema名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和RDS for PostgreSQL模板库和已存在的schema重名。 RDS for PostgreSQL模板库包括postgres， template0 ，template1，。 已存在的schema包括public，information_schema。 owner 是 String 数据库属主用户。 数据库属主名称在1到63个字符之间，不能以“pg”和数字开头，不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。

请求示例 创建数据库schema POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/schema { "db_name": "rds_test", "schemas": [ { "schema_name": "teste123", "owner": "teste123" } ] }

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 total_count Integer 数据库总数。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 readonly Boolean 是否为只读权限： true表示只读。 false表示可读写。 正常响应样例 { "databases": [ { "name": "rds-test", "readonly": false }, { "name": "testdb1", "readonly": true }, { "name": "tt", "readonly": false } ], "total_count": 3 } 异常响应 请参见异常请求结果。

URI URI格式 PUT /v3/{project_id}/instances/{instance_id}/db-users/{user_name}/comment 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 user_name 是 数据库用户名。

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

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

请求消息 参数说明 表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 恢复后表名。

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

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

响应消息 正常响应要素说明 表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}/storage-type/{database_name}?version_name={version_name}&ha_mode={ha_mode} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 database_name 是 数据库引擎名。支持如下数据库引擎，不区分大小写： MySQL PostgreSQL SQLServer version_name 是 数据库版本号，获取方法请参见查询数据库引擎的版本。 ha_mode 否 主备模式，取值如下： single：单机模式。 ha：主备模式。 replica：只读模式。

响应消息 正常响应要素说明 表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样例 查询实例跨区域备份的所有可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/offsite-restore-time 根据指定日期查询实例跨区域备份的可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/offsite-restore-time?date=2020-12-26

响应消息 正常响应要素说明 表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下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 date 否 所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

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

响应消息 正常响应要素说明 表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 参数说明 名称 参数类型 说明 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。