华为云用户手册

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

响应消息 正常响应要素说明 表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": "MySQLPostgreSQL", "version": "5.711" }, "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": "MySQLPostgreSQL", "version": "5.711" }, "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。

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

响应消息 正常响应要素说明 名称 说明 workflowId 任务ID。 instanceId 实例ID。 nodeId 节点ID。 正常响应样例 { "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a", "instanceId":"794c38e5309344818f4b33b86ebce9b4in03", "nodeId":"b94ba815747040f1b0d641cd13364a06no03" } 异常响应 请参见异常请求结果。

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

请求示例 创建数据库rds_test。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database { "name": "rds_test", "owner": "test", "template": "template0", "character_set": "UTF8", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8", "is_revoke_public_privilege": true, "comment":"comment" }

响应消息 正常响应要素说明 表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 MySQ L实例 指定时间点查询可恢复的库： { "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" : "" }

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

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/offsite-backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 备份列表。 详情请参见表3。 total_count Integer 总记录数。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 备份ID。 name String 备份名称。 type String 备份类型。 取值如下： auto：自动全量备份和手动备份。仅RDS for SQL Server支持跨区域备份的手动备份类型。 incremental：自动增量备份。 size Long 备份大小（单位：KB）。 status String 备份状态，取值如下： BUILDING: 备份中。 COMPLETED: 备份完成。 FAILED：备份失败。 DELETING：备份删除中。 databases Array of objects 用户自建库，仅RDS for SQL Server返回该字段。 详情请参见表4。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 备份结束时间。 全量备份类型下，指备份结束时间。 RDS for MySQL增量备份类型，指备份文件中最后一个事务的提交时间。 格式为“yyyy-mm-ddThh:mm:ssZ”，其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 datastore Object 数据库版本信息。 详情请参见表5。 instance_id String 备份所在实例ID。 associated_with_ddm Boolean 是否关联DDM标志。仅RDS for MySQL返回该字段。 表4 databases字段数据结构说明 名称 参数类型 说明 name String 用户自建数据库名。 表5 datastore字段数据结构说明 名称 参数类型 说明 type String 数据库引擎。 version String 数据库版本。 正常响应样例 MySQL： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } PostgreSQL： { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "9.6" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01" }], "total_count": 1 } SQL Server： { "backups": [ { "id": "d0ea632a5c32451dbdb157ef5c2ad3ecbr04", "name": "sqlserver-rds-1784-20221202062025775", "type": "auto", "size": 5956, "status": "COMPLETED", "begin_time": "2022-12-02T06:20:25+0000", "end_time": "2022-12-02T06:24:45+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" }, { "id": "07d6a8ab12304f9aa3f368a6cff21ac9br04", "name": "backup-81f1", "type": "auto", "size": 773, "status": "COMPLETED", "begin_time": "2022-12-02T06:12:22+0000", "end_time": "2022-12-02T06:16:37+0000", "datastore": { "type": "sqlserver", "version": "2019_SE" }, "instance_id": "ad4ee2b80adb430082d8336d7da2e14din04" } ], "total_count": 2 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/offsite-backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 backup_type 是 备份类型，取值如下： auto：自动全量备份和手动备份。仅RDS for SQL Server支持跨区域备份的手动备份类型。 incremental：自动增量备份。 backup_id 否 备份ID。 offset 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 begin_time 否 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： “begin_time”有值时，“end_time”必选。 end_time 否 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 说明： “end_time”有值时，“begin_time”必选。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 recovery_min_time String 参数解释： 恢复时间窗左边界（不包含）。 取值范围： 不涉及。 recovery_max_time String 参数解释： 恢复时间窗右边界（包含）。 取值范围： 不涉及。 正常响应样例 { "recovery_min_time" : "2024-08-17 19:17:35+10", "recovery_max_time" : "2024-08-20 22:53:28+10" } 异常响应 请参见异常请求结果。

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

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 total_count Integer 数据库总数。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 character_set String 数据库使用的字符集，例如utf8、gbk、ascii等。 comment String 数据库备注。 说明： 当创建数据库时备注为空，则无法查询到该参数。 正常响应样例 { "databases": [ { "name": "rds-test", "character_set": "utf8", "comment":"comment" }, { "name": "testdb1", "character_set": "utf8", "comment":"comment" }, { "name": "tt", "character_set": "utf8", "comment":"comment" } ], "total_count": 3 } 异常响应 请参见异常请求结果。

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" }

请求示例 DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e28979107ed04d3b8b2f1b819b8d2be3in03/hba-info [ { "type" : "host", "database" : "all", "user" : "all", "address" : "0.0.0.0/0", "mask" : "", "method" : "md5", "priority" : 0 } ]

请求消息 表2 请求参数 参数 是否必选 参数类型 描述 数组元素 否 Array of objects 参数解释： 修改参数。 详情请参见表3。 约束限制： 不涉及。 表3 参数说明 参数 是否必选 参数类型 描述 type 是 String 参数解释： 连接类型。 约束限制： 不涉及。 取值范围： 枚举值：host、hostssl、hostnossl。 默认取值： 不涉及。 database 是 String 参数解释： 数据库名。 约束限制： 不涉及。 取值范围： 除template0，template1的数据库名，多个以逗号隔开。 默认取值： 不涉及。 user 是 String 参数解释： 除内置用户（rdsAdmin, rdsMetric, rdsBackup, rdsRepl, rdsProxy）以外的用户名。 约束限制： 不涉及。 取值范围： 值为all：表示当前实例的所有数据库用户。 值为具体的用户名，多个以逗号隔开。 默认取值： 不涉及。 address 是 String 参数解释： 客户端IP地址。0.0.0.0/0表示允许用户从任意IP地址访问数据库。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 mask 否 String 参数解释： 掩码。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 空字符串。 method 是 String 参数解释： 认证方式。 约束限制： 不涉及。 取值范围： 枚举值：reject、md5、scram-sha-256。 默认取值： 不涉及。 priority 是 Integer 参数解释： 优先级，表示配置的先后。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 port 是 Integer 端口号。 RDS for MySQL端口号范围：大于等于1024，小于等于65535，不包含12017、33062和33071。 RDS for PostgreSQL端口号范围：2100～9500。 对于RDS for SQL Server 2022 EE、2022 SE、2022 Web版、2019 EE、2019 SE、2019 Web版、2017 EE、2017 SE、2017 Web版：端口设置范围为1433和2100~9500（其中5050、5353、5355、5985和5986不可设置）。 除此之外的其他版本：端口设置范围为1433和2100~9500（其中5355、5985和5986不可设置）。

请求示例 配置容灾实例灾备关系，主实例所在的区域为aaa。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/action { "build_slave_dr_relation": { "target_instance_id":"c39bd176fb0540929f6add80b91b212cin03", "target_project_id":"054b61972980d4552f0bc00ac8d3f5cd", "target_region":"aaa", "target_ip":"192.168.3.238" } }

接口约束 使用该功能前，必须要确保跨云或跨Region数据库实例之间VPC网段的网络打通，且配置安全组放通VPC网段间的数据库端口。仅打通网络未放通安全组也无法搭建容灾关系。 主实例配置容灾能力成功后才能配置灾备实例容灾能力，否则容灾关系会建立失败。 主实例和灾备实例状态正常，主实例和灾备实例在不同云或不同Region且灾备实例为单实例。 灾备实例的CPU和内存规格以及磁盘容量要大于或等于主实例的规格以及磁盘容量。 灾备实例的底层架构和数据库大版本要与主实例一致。 如果灾备实例与主实例的小版本不一致，则在灾备搭建完成后，会自动重置灾备实例小版本，并与主实例的小版本保持一致。 不支持跨大版本建立跨云或跨Region容灾关系。 调用配置灾备实例容灾接口后直至成功搭建容灾关系，不能进行规格变更、主备倒换操作。 RDS for PostgreSQL 12及以上版本支持建立跨云或跨Region容灾关系。 灾备实例搭建成功后，不能进行小版本升级。 主实例参数被修改后，灾备实例无法同步修改该参数，需结合业务自行修改灾备实例参数。 RDS for PostgreSQL灾备实例不支持PITR恢复和CBR快照备份功能，如需使用此功能，请在主实例上完成。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 build_slave_dr_relation 是 Object 配置容灾实例灾备关系所需要的主实例信息。 详情请参见表3。 表3 build_slave_dr_relation字段数据结构说明 名称 是否必选 参数类型 说明 target_instance_id 是 String 主实例的实例ID。 target_project_id 是 String 主实例所在租户的项目ID。 target_region 是 String 主实例所在的区域ID。 target_ip 是 String 主实例的数据虚拟IP（数据VIP）。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 instance_id String 实例ID。 dns_name String 实例 域名 。 dns_type String 实例域名类型：private ipv4_address String 实例域名绑定的vIP。 status String 域名状态。 正常响应样例 { "instance_id": "2de6315e7197418fbf2fdaed59d65da1in03", "dns_name": "2de6315e7197418fbf2fdaed59d65da1in03.internal.cn-xianhz-1.mysql.rds-dev.myhuaweicloud.com", "dns_type": "private", "ipv4_address": "192.168.6.105", "status": "normal" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 cert_info_list Array 证书列表。详情请参见表3。 表3 cert_info_list字段数据结构说明 名称 参数类型 说明 download_link String 下载链接。 category String 证书类型。枚举值： international national 正常响应样例 { "cert_info_list": [ { "category": "international", "download_link": "https://{region}.huaweicloud.com/rds/Certificate_Download.zip" } ] } 异常响应 请参见异常请求结果。

请求示例 给用户user1取消user3、user4角色。 DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in03/db-user-role { "user" : "user1", "roles" : [ "user3", "user4" ] }

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