华为云用户手册

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

请求示例 创建RDS for MySQL实例的手动备份mybackup POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "name": "mybackup", "description": "manual backup" } 创建RDS for PostgreSQL实例的手动备份mybackup { "instance_id": "a8a5fc65b1a04ceb9d72212891ad73f8in03", "name": "mybackup", "description": "manual backup" } 创建RDS for SQL Server实例的手动备份mybackup { "instance_id": "34029da944074135a3bc24c75b3bb3edin04", "name": "mybackup", "description": "manual backup", "databases": [{ "name": "db1" }, { "name": "db2" }] }

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

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

请求示例 POST https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database/update { "name": "rds", "comment": "this is a comment" }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 configuration_id String 参数模板ID。 configuration_name String 参数模板名称 success Boolean 参数模板是否都应用成功。 “true”表示参数模板都应用成功。 “false”表示存在应用失败的参数模板。 job_id String 任务流ID。 正常响应样例 { "configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01", "configuration_name": "paramsGroup-bcf9", "job_id":"e4942c94-9d66-458e-beb7-90601664641e", "success":true } 异常响应 请参见异常请求结果。

请求示例 将参数模板应用到多个实例 PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply { "instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"] }

请求示例 创建数据库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 响应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://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/fast-restore { "restore_time" : "2023-06-25T11:35:40+0800", "instance_ids" : [ "14fc6c06d7e842829ee91d11c6b88b3ain01" ] }

响应消息 正常响应要素说明 表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 数据库引擎，当前仅支持MySQL引擎和SQL Server引擎。 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下的project 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”必选。

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

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

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

响应消息 正常响应要素说明 表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格式 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 page 是 分页页码，从1开始。 limit 是 每页数据条数。取值范围[1, 100]。

请求示例 DELETE https://rds.cn-north-1.myhuaweicloud.com/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 参数说明 名称 是否必选 参数类型 说明 recycle_policy 是 Object 每个元素都是与回收站相关信息。 每个元素结构请参见表3。 表3 recycle_policy元素说明 名称 是否必选 参数类型 说明 retention_period_in_days 否 String 保留时间，设置已删除实例保留天数，支持整数，可设置范围为1~7天。 当“retention_period_in_days”为空，保留时间默认是7天。

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

接口约束 该接口仅支持MySQL和PostgreSQL引擎。 RDS for MySQL 5.6、5.7、8.0版本的主备实例支持备机可用区迁移功能。其中，RDS for MySQL 5.6和5.7版本的本地盘实例备机可用区迁移，以及8.0版本的备机可用区迁移功能需要联系客服人员申请权限。 仅支持HA实例。 实例在创建、重启、数据库升级、变更规格、修改端口、创建用户、删除用户状态下，不能进行此操作。

响应消息 正常响应要素说明 表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 优先级，表示配置的先后。 正常响应样例 [ { "type" : "host", "database" : "all", "user" : "all", "address" : "0.0.0.0/0", "mask" : "", "method" : "md5", "priority" : 0 } ]

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 repairStrategy 是 String 可用性策略，可选择如下方式： reliability：可靠性优先，数据库应该尽可能保障数据的可靠性，即数据丢失量最少。对于数据一致性要求较高的业务，建议选择该策略。 availability：可用性优先，数据库应该可快恢复服务，即可用时间最长。对于数据库在线时间要求较高的业务，建议选择该策略。

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

请求示例 扩容数据库实例的磁盘空间到400GB POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "enlarge_volume": { "size": 400, "is_auto_pay": true } }

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 enlarge_volume 是 Object 所需扩容到的磁盘容量大小。 详情请参见表3。 表3 enlarge_volume字段数据结构说明 名称 是否必选 参数类型 说明 size 是 Integer 每次扩容最小容量为10GB，实例所选容量大小必须为10的整数倍，取值范围：40GB~4000GB。 RDS for PostgreSQL部分用户支持40GB~15000GB，如果您想开通该功能，请联系客服。 is_auto_pay 否 Boolean 扩容包周期实例的磁盘空间时可指定，表示是否自动从客户的账户中支付。 true，为自动支付。 false，为手动支付，默认该方式。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 dataStores Array of objects 数据库版本信息列表。 详情请参见表3。 表3 dataStores字段数据结构说明 名称 参数类型 说明 id String 数据库版本ID，该字段不会有重复。 name String 数据库版本号。 对于MySQL引擎可以返回小版本号，例如MySQL 5.6.51版本，将返回5.6.51。 对于PostgreSQL和SQL Server引擎，只返回两位数的大版本号，例如PostgreSQL 9.6.X版本，仅返回9.6。 正常响应样例 { "dataStores": [{ "id": "87620726-6802-46c0-9028-a8785e1f1921", "name": "8.0.21" }, { "id": "87620726-6802-46c0-9028-a8785e1f1922", "name": "5.7.33" }, { "id": "e8a8b8cc-63f8-4fb5-8d4a-24c502317a62", "name": "5.6.51" }] } 异常响应 请参见异常请求结果。

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