华为云用户手册

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 数据库账号信息列表。 详情请参见表3。 total_count Integer 数据库账号个数。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 comment String 账号备注。目前仅支持MySQL 8.0.25及以上版本。 databases Array of objects 账号已授权的数据库。 详情请参见表4。 hosts Array of strings 账号配置的host信息。 表4 databases元素结构说明 参数 参数类型 描述 name String 数据库名称。 readonly Boolean 授权模式，是否只读。 正常响应样例 { "users": [ { "name": "aaa", "comment": "user comment", "databases": [ { "name": "db1", "readonly": false } ], "hosts": [ "10.%" ] } ], "total_count": 1 }

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 要素说明 名称 参数类型 说明 instance_dr_relations Array of objects 容灾实例信息列表。 详情请参见表3。 表3 instance_dr_relations字段数据结构说明 名称 参数类型 说明 instance_id String 当前区域实例ID。 master_instance Object 主实例信息。 详情请参见表4。 slave_instances Array of objects 容灾实例信息列表。 详情请参见表5。 表4 master_instance字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 region String 区域。 project_id String 项目ID。 project_name String 项目名称。 表5 slave_instances字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 region String 区域。 project_id String 项目ID。 project_name String 项目名称。 正常响应样例 { "instance_dr_relations": [ { "instance_id": "b5e2c7fcef8b4c2f8fd8d80d73344756in03", "master_instance": { "instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03", "region": "aRegion", "project_id": "08fd4e669e00d57d2ffec01352c7cb77", "project_name": "masterProjectName" } }, { "instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03", "slave_instances": [ { "instance_id": "b5e2c7fcef8b4c2f8fd8d80d73344756in03", "region": "bRegion", "project_id": "054b61972980d4552f0bc00ac8d3f5cd", "project_name": "slaveProjectName" } ] } ] } 异常响应 请参见异常请求结果。

接口约束 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 除RDS界面和API以外的其他方式创建的数据库和账号，如果创建的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），例如包含中文或不支持的特殊字符，那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。 如果源库的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），迁移到目标库RDS for MySQL后，该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 users 是 Array of objects 每个元素都是与数据库相关联的账号。单次请求最多支持50个元素。 每个元素结构请参见表3。 表3 users列表元素数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到32个字符之间，由字母、数字、中划线或下划线组成，不能包含其他特殊字符。 若数据库版本为MySQL5.6，账号长度为1～16个字符。 若数据库版本为MySQL5.7和8.0，账号长度为1～32个字符。 readonly 是 Boolean 是否为只读权限： “true”表示只读。 “false”表示可读写。

请求示例 授权rds账号可读可写、rds001账号只读。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_privilege { "db_name": "rds-test", "users": [ { "name": "rds", "readonly": false }, { "name": "rds001", "readonly": true } ] }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 recycle_policy 是 Object 参数解释： 每个元素都是与回收站相关信息。 每个元素结构请参见表3。 约束限制： 不涉及。 表3 recycle_policy元素说明 名称 是否必选 参数类型 说明 retention_period_in_days 否 String 参数解释： 保留时间，设置已删除实例保留天数。 约束限制： 不涉及。 取值范围： 支持整数，可设置范围为1~7天。 默认取值： 当“retention_period_in_days”为空，保留时间默认是7天。

请求示例 创建数据库用户rds。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_user { "name": "rds", "password": "************", "comment": "mysql", "hosts": [ "%" ], "databases" : [ { "name" : "***", "readonly" : false } ] }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到32个字符之间，由字母、数字、中划线或下划线组成，不能包含其他特殊字符。 若数据库版本为MySQL5.6，账号长度为1～16个字符。 若数据库版本为MySQL5.7和8.0，账号长度为1～32个字符。 password 是 String 数据库账号密码。 取值范围： 非空，长度8~32个字符，至少包含大写字母、小写字母、数字、特殊字符~!@#$%^*-_=+?,()&三种字符的组合，不能和账号名或账号名的逆序相同。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 comment 否 String 数据库账号备注。 取值范围：长度1~512个字符。目前仅支持MySQL 8.0.25及以上版本。 hosts 否 Array of strings 授权用户登录数据库的IP列表。 若IP地址为%，表示允许所有地址访问MySQ L实例 。 若IP地址为“10.10.10.%”，表示10.10.10.X的IP地址都可以访问MySQL实例。 支持添加多个IP地址。 databases 否 Array of objects 授权用户登录的数据库，详情请参见表3。 表3 databases元素结构说明 名称 是否必选 参数类型 说明 name 是 String 授权已有数据库名称。 readonly 否 Boolean 是否为只读权限。 true表示只读。 false表示可读写。

接口约束 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 同一实例多次调用此接口需串行。 除RDS界面和API以外的其他方式创建的数据库和账号，如果创建的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），例如包含中文或不支持的特殊字符，那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。 如果源库的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），迁移到目标库RDS for MySQL后，该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

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

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

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 password 是 String 数据库账号密码。 取值范围： 非空，长度8~32个字符，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊符号~!@#$%^*-_=+?,()&组成，不能和账号名或账号名的逆序相同。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

接口约束 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 除RDS界面和API以外的其他方式创建的数据库和账号，如果创建的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），例如包含中文或不支持的特殊字符，那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。 如果源库的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），迁移到目标库RDS for MySQL后，该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

接口约束 该接口仅支持MySQL、PostgreSQL引擎。 RDS for PostgreSQL实例中存在异常节点，无法升级小版本。 对于RDS for PostgreSQL 11版本，如果内核小版本小于11.2，则不支持小版本升级。 RDS for PostgreSQL只支持立即升级，不支持可维护时间段内升级小版本。 RDS for PostgreSQL升级内核小版本后，有可能导致主备节点倒换。

响应消息 正常响应要素说明 表2 参数说明 名称 参数类型 说明 total_count Integer 总记录数。 inspection_reports Array of objects 检查报告信息。 详情请参见表3。 表3 inspection_report字段数据结构说明 名称 参数类型 说明 id String 检查报告ID。 check_time String 检查时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 expiration_time String 到期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 target_version String 目标版本。 result String 检查结果。 success：表示成功。 failed：表示失败。 running：表示检查中。 detail String 检查报告详情。 正常响应样例 { "total_count": 1, "inspection_reports": [ { "id": "289903e1-3006-19e9-e054-5fb7fe376552", "check_time": "2023-03-06T02:33:49+0800", "expiration_time": "2023-03-07T02:33:49+0800", "target_version": "14.4", "result": "success", "detail": "2023-03-06 18:33:26 --- pg_upgrade check task begin\n2023-03-06 18:34:40 --- pg_upgrade check on master: [user_check_report]User check success" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/major-version/inspection-histories?offset={offset}&limit={limit}&order={order}&sort_field={sort_field}&target_version={target_version}&is_available={is_available} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id String 是 实例ID。 offset Integer 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit Integer 否 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。 order String 否 排序方式。 DESC：降序。 ASC：升序。 默认为降序。 sort_field String 否 排序字段。 check_time：检查时间。 expiration_time：过期时间。 默认为检查时间。 target_version String 否 目标版本。 is_available Boolean 否 是否有效。 true：表示有效。 false：表示无效。

URI URI格式 GET /v3/{project_id}/datastores/{database_name} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 database_name 是 参数解释： 数据库引擎。 约束限制： 不涉及。 取值范围： 支持的引擎如下，不区分大小写： MySQL PostgreSQL SQLServer 默认取值： 不涉及。

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

请求示例 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/disaster-recovery-infos { "status": "normal", "order": "ASC", "sort_field": "time", "offset": 0, "limit": 10 }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 total_count Integer 总记录数。 instance_dr_infos Array of objects 容灾信息列表。 详情请参见表4。 表4 instance_dr_infos字段说明 名称 参数类型 说明 id String 容灾关系ID。 status String 容灾搭建状态。 failed_message String 失败消息。 replica_state String 同步状态。取值范围是0或-1，0表示正常，-1表示异常。 wal_write_receive_delay_in_mb String 发送延迟大小（MB），即主实例当前wal日志写入位点与灾备实例当前接收wal日志位点的差值。 wal_write_replay_delay_in_mb String 端到端延迟大小（MB），即主实例当前wal日志写入位点与灾备实例当前回放wal日志位点的差值。 wal_receive_replay_delay_in_ms String 回放延迟时间（ms），即数据在灾备上回放的延迟时间。 master_instance_id String 主实例ID。 master_region String 主实例所在Region。 slave_instance_id String 灾备实例ID。 slave_region String 灾备实例所在Region。 build_process String 搭建流程。 master，表示配置主实例容灾能力流程。 slave，表示配置灾备实例容灾能力流程。 time Long 灾备搭建时间。 正常响应样例 { "total_count": 1, "instance_dr_infos": [ { "id": "57160f82-e6bb-44bc-80db-0d950d4f3b40", "status": "failed", "failed_message": "the network is disconnected", "replica_state": "0", "wal_write_receive_delay_in_mb": "10.0", "wal_write_replay_delay_in_mb": "10.0", "wal_receive_replay_delay_in_ms": "0", "master_instance_id": "fab4e3df67c24aa0a5b41bc2bcb41918in03", "master_region": "region-A", "slave_instance_id": "df50adb922ef42a495943b304f8aa551in03", "slave_region": " region-B", "time": 1702551254685 } ] } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 id 否 String 容灾关系ID。 status 否 String 容灾搭建状态。 master_instance_id 否 String 主实例ID。 master_region 否 String 主实例Region。 slave_instance_id 否 String 灾备实例ID。 slave_region 否 String 灾备实例Region。 create_at_start 否 Long 创建起始时间。 create_at_end 否 Long 创建结束时间。 order 否 String 排序方式。 DESC，降序。 ASC，升序。 默认降序。 sort_field 否 String 排序字段。 status 容灾搭建状态。 time 容灾搭建时间。 master_region 主实例region。 slave_region 灾备实例region 默认容灾搭建时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 node_id String 参数解释： 实例的节点ID。 取值范围： 不涉及。 used String 参数解释： 磁盘空间使用量（单位GB）。 取值范围： 不涉及。 正常响应样例 { "node_id" : "0314958daf6904c478d17c642ac209abbin01", "used" : "14.21" } 异常响应 请参见异常请求结果。

请求示例 修改MySQL实例的参数值。 PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations { "values" : { "div_precision_increment": "6", "connect_timeout": "20", "binlog_checksum" : "CRC32", "innodb_purge_threads" : "4" } } 修改PostgreSQL实例的参数值。 { "values" : { "autovacuum" : "on", "bytea_output" : "escape", "client_encoding" : "UTF8", "cpu_tuple_cost" : "0.01" } } 修改SQL Server实例的参数值。 { "values":{ "max server memory (MB)":"26317", "max degree of parallelism":"4" } }

接口约束 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库RDS用户指南》中“修改RDS for MySQL实例参数”的内容。 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。

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

响应消息 正常响应要素说明 表3 要素说明 参数 参数类型 描述 job_id String 参数解释： 任务ID。 取值范围： 不涉及。 restart_required Boolean 参数解释： 实例是否需要重启。 取值范围： true：需要重启。 false：不需要重启。 正常响应样例 { "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94", "restart_required" : false } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 versions Object 参数解释： API版本详细信息列表。 详情请参见表3。 version Object 参数解释： API版本详细信息列表。 详情请参见表3。 表3 versions字段数据结构说明 名称 参数类型 说明 id String 参数解释： API版本号。 取值范围： 不涉及。 links Array 参数解释： 对应该API版本的链接信息，该字段为空。 详情请参见表4。 status String 参数解释： 版本状态。 取值范围： 不涉及。 updated String 参数解释： 版本更新时间。 取值范围： 格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 表4 links字段数据结构说明 名称 参数类型 说明 href String 参数解释： 对应该API的URL。 取值范围： 该字段为""。 rel String 参数解释： URL类型。 取值范围： 取值为“self”，表示href为本地链接。 正常响应样例 { "version": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" }, "versions": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } } 异常响应 请参见异常请求结果。

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