华为云用户手册

URI URI格式 GET /v3/{project_id}/configurations/{config_id} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 config_id 是 参数模板ID。 当“config_id”为空（非空格）时，相当于获取参数模板列表的URL，具体请参见获取参数模板列表。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 description String 描述。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 configuration_parameters Array of objects 参数对象，用户基于默认参数模板自定义的参数配置。 详情请参见表3。 表3 configuration_parameters字段数据结构说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 restart_required Boolean 是否需要重启。 “false”表示否。 “true”表示是。 readonly Boolean 是否只读。 “false”表示否。 “true”表示是。 value_range String 参数值范围，如integer取值0-1、boolean取值true或者false等。 type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 description String 参数描述。 正常响应样例 { "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", "name": "default-mysql-5.7", "datastore_version_name": "5.7", "datastore_name": "mysql", "description": "Default parameter group for mysql 5.7", "created": "2017-05-05T04:40:51+0800", "updated": "2017-05-05T04:40:51+0800", "configuration_parameters": [ { "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": true, "value_range": "1-65535", "type": "integer", "description": "auto_increment_increment and auto_increment_offset are intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns." }, { "name": "autocommit", "value": "ON", "restart_required": false, "readonly": true, "value_range": "ON|OFF", "type": "boolean", "description": "The autocommit mode. If set to ON, all changes to a table take effect immediately. If set to OFF, you must use COMMIT to accept a transaction or ROLLBACK to cancel it. " } ] } 异常响应 请参见异常请求结果。

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

请求示例 创建数据库用户rds。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/db_user { "name": "rds", "password": "****", "comment":"comment" }

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库用户名称。 数据库用户名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。 password 是 String 数据库用户密码。 取值范围：非空，密码长度在8到32个字符之间，至少包含大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,三种字符的组合，不能包含数据库账号名称或名称的逆序。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。 comment 否 String 数据库账号备注。 取值范围：长度1~512个字符。

接口约束 如果您需要使用该功能，请联系客服提交开启修改数据库备注权限的申请。 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 更新备注的操作不受数据库是否存在影响。 若备注存在则更新，不存在则自动新建备注。 更新为空值备注将会被删除。 若新建备注过程中数据库被删除或不存在，则备注依旧会保存。 该方法只针对新版本的实例生效，必须大于等于指定的内核版本，如果不符合内核小版本要求，请参考升级内核小版本升级至最新。 RDS for MySQL 5.6：大于等于5.6.51.3。 RDS for MySQL 5.7：大于等于5.7.33.1。 RDS for MySQL 8.0：大于等于8.0.25.1。 除RDS界面和API以外的其他方式创建的数据库和账号，如果创建的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），例如包含中文或不支持的特殊字符，那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。 如果源库的数据库名和账号名不满足数据库命名规则（参见表2）和账号命名规则（参见表2），迁移到目标库RDS for MySQL后，该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。

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

请求示例 复制一个新的参数模板，名称为copy_by_v31 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/configurations/66251c9024774eeb9edd8663a4cbb0a1pr04/copy { "name" : "copy_by_v31", "description" : "copy" }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 description String 描述。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 create_time String 创建时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 update_time String 更新时间，格式为“yyyy-MM-ddTHH:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 正常响应样例 { "id" : "a73a272e50ba427397e90992fbb96f3cpr04", "name" : "copy_by_v31", "description" : "copy", "datastore_version_name" : "2017_EE", "datastore_name" : "sqlserver", "create_time" : "2022-10-31T08:24:06+0000", "update_time" : "2022-10-31T08:24:06+0000" } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 name String 参数名称。 value String 参数值。 restart_required Boolean 实例是否需要重启。 true，需要重启。 false，不需要重启。 value_range String 参数值范围，如Integer取值0~1、Boolean取值true或false等。 type String 参数类型，取值为“string”、“integer”、“boolean”、“list”或“float”之一。 description String 参数描述。 正常响应样例 { "name" : "shared_preload_libraries", "value" : "passwordcheck.so,pg_sql_history", "restart_required" : true, "value_range" : "passwordcheck.so,pg_stat_statements,pg_sql_history", "type" : "list", "description" : "Lists shared libraries to preload into server." } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/parameter/{name} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 name 是 参数名称。当前只支持查询shared_preload_libraries。

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

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库名称。 数据库名称长度可在1～64个字符之间，由字母、数字、中划线、下划线或$组成，中划线和$累计总长度小于等于10个字符，且不能包含其他特殊字符（MySQL 8.0不可包含$）。 character_set 是 String 数据库使用的字符集，例如utf8、gbk、ascii等RDS for MySQL支持的字符集。 comment 否 String 数据库备注。 长度可在0~512个字符之间。 说明： 如果您需要使用该功能，请联系客服提交权限的申请。 该参数只针对新版本的实例生效，必须大于等于指定的内核版本5.6.51.3、5.7.33.1、8.0.25.1，如果不符合内核小版本要求，请参考升级内核小版本升级至最新。

请求示例 创建数据库rds-test POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/database { "name": "rds-test", "character_set": "utf8", "comment":"comment" }

请求示例 创建参数模板configuration_test POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations { "name": "configuration_test", "description": "configuration_test", "values": { "div_precision_increment": "6", "connect_timeout": "20" }, "datastore": { "type": "mysql", "version": "5.7" } }

响应消息 正常响应要素说明 表4 要素说明 名称 参数类型 说明 configuration Object 参数模板信息。 详情请参见表5。 表5 configuration字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 description String 描述。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 正常响应样例 { "configuration": { "id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9", "name": "configuration_test", "datastore_version_name": "5.7", "datastore_name": "mysql", "description": "configuration_test", "created": "2017-04-09T08:27:56+0800", "updated": "2017-04-09T08:27:56+0800" } } 异常响应 请参见异常请求结果。

请求示例 DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/extensions { "database_name" : "db1", "extension_name" : "pg_stat_statements" }

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM 项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。

请求示例 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 数据库账号名称。 数据库账号名称在1到128个字符之间，不能和系统用户名称相同。 系统用户包括：rdsadmin, rdsuser, rdsbackup, rdsmirror。

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

请求示例 查询慢日志的统计数据，每页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" }

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project 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 账号名。 readonly Boolean 是否为只读权限： true表示只读。 false表示可读写。 正常响应样例 { "users": [ { "name": "rds", "readonly": false }, { "name": "rds001", "readonly": false } ], "total_count": 2 } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 configuration Object 参数模板信息。详情请参见表4。 表4 configuration字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 ignored_params List 请求参数“values”中被忽略掉，没有生效的参数名称列表。 当参数不存在时，参数修改不会下发，并通过此参数返回所有被忽略的参数名称。 正常响应样例 { "configuration": { "id": "463b4b58-d0e8-4e2b-9560-5dea4552fde9", "name": "configuration_test", "ignored_params": {} } } 异常响应 请参见异常请求结果。

请求示例 修改参数模板的参数值 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9 { "name": "configuration_test", "description": "configuration_test", "values": { "div_precision_increment": "6", "connect_timeout": "20" } }

接口约束 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。 修改参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复，默认参数模板不允许修改。 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《云数据库 RDS用户指南》中“修改实例参数”的内容。 敏感参数，例如：“lower_case_table_names”，修改存在风险，详情请参见《云数据库RDS用户指南》中“RDS for MySQL参数调优建议”的内容。 要修改的参数信息，不可全部为空。

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 列表中每个元素表示一个数据库账号。 详情请参见表3。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 databases Array of objects 列表中每个元素表示一个与该账号关联的数据库。 详情请参见表4。 表4 databases元素结构说明 名称 参数类型 说明 name String 数据库名。 readonly Boolean 是否为只读权限： “true”表示只读。 “false”表示可读写。 正常响应样例 { "users": [ { "name": "rds", "comment": "user comment", "databases": [ { "name": "rds-test", "readonly": false } ] }, { "name": "rds001", "comment": "user comment", "databases": null } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/extensions?database_name={database_name}&offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 database_name 是 数据库名称。 offset 否 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。