华为云用户手册

请求示例 创建数据库db1的插件pg_stat_statements POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/extensions { "database_name" : "db1", "extension_name" : "pg_stat_statements" }

请求示例 创建数据库用户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地址为%，表示允许所有地址访问MySQL实例。 若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的数据库管理和账号管理功能。

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

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

响应消息 正常响应要素说明 表2 要素说明 参数 参数类型 描述 total_count Integer 历史记录总数。 histories Array of objects 参数修改历史。 详情请参见表3。 表3 histories字段数据结构说明 名称 参数类型 说明 parameter_name String 参数名称。 old_value String 旧参数值。 new_value String 新参数值。 update_result String 更新结果。 SUC CES S：成功。 FAILED：失败。 applied Boolean 是否已应用。 true：已应用。 false：未应用。 update_time String 参数修改时间。 apply_time String 参数应用时间。 正常响应样例 { "total_count" : 3, "histories" : [ { "parameter_name" : "fill factor (%)", "old_value" : "0", "new_value" : "2", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:39:21+0000", "apply_time" : "2022-10-31T01:46:29+0000" }, { "parameter_name" : "remote login timeout (s)", "old_value" : "10", "new_value" : "20", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:38:36+0000", "apply_time" : "2022-10-29T09:38:36+0000" }, { "parameter_name" : "remote query timeout (s)", "old_value" : "600", "new_value" : "601", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:40:30+0000", "apply_time" : "2022-10-29T09:40:30+0000" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/configuration-histories?offset={offset}&limit={limit}&start_time={start_time}&end_time={end_time}¶m_name={param_name} 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 offset 否 Integer 分页参数。 缺省值：0 limit 否 Integer 分页参数。 缺省值：10 start_time 否 String 开始时间默认为当前时间的前7天，格式：2020-09-01T18:50:20Z end_time 否 String 结束时间默认为当前时间，格式：2020-09-01T18:50:20Z param_name 否 String 参数名称。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 datastore_version_name String 数据库版本名称。 datastore_name 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 参数描述。 正常响应样例 { "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2018-10-11 11:40:44", "updated": "2018-10-11 11:40:44", "configuration_parameters": [{ "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": false, "value_range": "1-65535", "type": "integer", "description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制，并可以用来控制AUTO_INCREMENT列的操作。" }] } 异常响应 请参见异常请求结果。

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 users 是 Array of objects 每个元素是与数据库相关联的账号。单次请求最多支持50个元素。 每个元素结构请参见表3。 表3 users列表元素数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到32个字符之间，由字母、数字、中划线或下划线组成，不能包含其他特殊字符。 若数据库版本为RDS for MySQL 5.6，账号长度为1～16个字符。 若数据库版本为RDS for MySQL 5.7和8.0，账号长度为1～32个字符。

请求示例 DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/db_privilege { "db_name": "rds-test", "users": [ { "name": "rds" }, { "name": "rds001" } ] }

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

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 数据库名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，且不能和RDS for PostgreSQL模板库重名。 RDS for PostgreSQL模板库包括postgres， template0 ，template1。 users 是 Array of objects 每个元素都是与数据库相关联的账号。单次请求最多支持50个元素。 每个元素结构请参见表3。 表3 users列表元素数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，不能和系统用户名称相同且账号名称必须存在。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。 readonly 是 Boolean 数据库账号权限。 true：只读。 false：可读可写。 schema_name 是 String schema名称。 schema名称在1到63个字符之间，由字母、数字、或下划线组成，不能包含其他特殊字符，不能以“pg”和数字开头，不能和RDS for PostgreSQL模板库重名，且schema名称必须存在。 RDS for PostgreSQL模板库包括postgres， template0 ，template1。

请求示例 授权数据库账号读写权限，rds账号可读可写、rds001账号只读、rds002账号可读可写 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/db_privilege {"db_name": "rds_test", "users": [ { "name": "rds", "readonly": false, "schema_name": "teste123" }, { "name": "rds001", "readonly": true, "schema_name": "teste123" }, { "name": "rds002", "readonly": false, "schema_name": "teste123" } ] }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 列表中每个元素表示一个数据库账号。 详情请参见表3。 total_count Integer 数据库用户总数。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 state String 数据库用户状态。 “unavailable”表示不可用。 “available”表示可用。 正常响应样例 { "users": [ { "name": "rdsuser", "state": "available" }, { "name": "login001", "state": "available" } ], "total_count": 2 } 异常响应 请参见异常请求结果。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 错误码列表： 表1 v3错误码说明 状态码 错误码 说明 500 DBS.108000 服务器错误。 500 DBS.108002 服务器错误。 500 DBS.108005 服务器错误。 400 DBS.200001 参数错误。 404 DBS.200002 RDS实例不存在。 400 DBS.200004 参数错误。 500 DBS.200005 服务器错误。 400 DBS.200006 请求为空，请输入请求参数。 404 DBS.200008 请检查数据库，确认实例的虚拟机信息，找不到该实例的虚拟机信息。 403 DBS.200010 实例ID和用户ID可能为空，或者操作越权。 409 DBS.200011 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 404 DBS.200013 源实例不存在。 409 DBS.200019 该实例正在进行其他操作或该实例故障，无法执行该操作，请稍后重试。 400 DBS.200021 实例名非法。 409 DBS.200022 实例名称已存在。 400 DBS.200023 卷大小超出允许范围。 400 DBS.200024 Region非法。 400 DBS.200025 可用区取值非法。 400 DBS.200026 卷类型非法。 400 DBS.200027 卷大小不是10的整数倍。 400 DBS.200037 实例引擎版本不一致。 400 DBS.200038 当前实例数据库主备同步关系异常，无法执行该操作。 400 DBS.200039 当前实例主备同步延时大于5分钟，不允许此操作。 400 DBS.200040 不支持的数据库类型或版本。 400 DBS.200041 数据库版本非法。 400 DBS.200042 Datastore不存在。 400 DBS.200043 HA同步模式非法。 403 DBS.200044 访问资源不存在，或者无访问权限。 404 DBS.200045 RDS实例不存在。 413 DBS.200046 实例数量达到配额。 409 DBS.200047 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 400 DBS.200048 VPC id非法。 400 DBS.200049 子网的网络id非法。 404 DBS.200050 安全组不存在，或不属于该VPC。 400 DBS.200051 不合法的ha模式 400 DBS.200052 数据库root密码非法。 400 DBS.200053 所选规格不存在。 400 DBS.200054 所选规格非法。 400 DBS.200055 replica_of_id非法。 400 DBS.200056 节点个数达到最大值。 400 DBS.200062 数据库用户名非法。 400 DBS.200063 集群模式非法。 400 DBS.200076 实例或节点非正常状态。 400 DBS.200080 主备节点正在进行数据同步，请稍后重试。 400 DBS.200086 实例状态不允许做该操作。 400 DBS.200087 单个实例标签数量达到最大配额。 400 DBS.200098 该资源标签已存在。 400 DBS.200121 请选择不同于备机的可用区做迁移。 400 DBS.200203 查询实例失败。 500 DBS.200208 服务器错误。 400 DBS.200302 磁盘大小不是10的整数倍。 400 DBS.200303 扩容次数达到最大限制。 400 DBS.200306 扩容参数不合法。 400 DBS.200308 备机扩容后的大小不能超过主机。 400 DBS.200311 节点状态异常, 不允许扩容, 请联系技术服务处理。 409 DBS.200316 当前实例状态为存储空间满，不能进行该操作 409 DBS.200402 操作不合法。 400 DBS.200405 参数错误。 404 DBS.200408 节点信息填写错误。 400 DBS.200461 参数值超出范围。 404 DBS.200470 Region或可用区不存在。 404 DBS.200501 子网不存在，或不属于该VPC。 404 DBS.200503 VPC不存在，或不属于该用户。 400 DBS.200504 数据库版本非法。 400 DBS.200506 KMS非法。 400 DBS.200507 密钥失效或已删除。 400 DBS.200543 任务不存在。 404 DBS.200602 该实例不存在。 403 DBS.200604 实例ID和用户ID可能为空，或者操作越权。 403 DBS.200810 不能在只读实例中创建数据库。 403 DBS.200819 不能在只读实例中删除数据库用户。 500 DBS.200821 修改数据库用户权限失败 400 DBS.200823 数据库不存在 400 DBS.200824 数据库账号不存在 400 DBS.200825 不能在只读实例上修改权限操作。 409 DBS.200826 数据库名称已存在 409 DBS.200827 账号名称已存在。 409 DBS.200828 数据库内置账号，用户不可创建。 500 DBS.200835 删除数据库失败，数据库锁等待超时。 500 DBS.200811 创建数据库失败。 403 DBS.201003 访问资源不存在，或者无访问权限。 400 DBS.201006 参数错误。 404 DBS.201010 备份信息不存在。 400 DBS.201014 实例状态不允许做该操作。 404 DBS.201028 实例不存在或已删除。 400 DBS.201035 输入的数据库名重复或者输入的数据库名与目标库上的重复。 400 DBS.201041 带有外键的表不允许该操作 400 DBS.201101 备份周期非法。 400 DBS.201103 备份开始时间非法。 400 DBS.201106 保留天数非法。 409 DBS.201201 对象已存在。 409 DBS.201202 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试 400 DBS.201203 备份文件不存在。 409 DBS.201205 正在备份中，请稍等。 400 DBS.201207 不支持该数据库引擎或版本。 400 DBS.201208 备份状态不允许该操作。 404 DBS.212001 参数组不存在。 400 DBS.212002 参数组配额错误。 400 DBS.212003 不支持此操作。 400 DBS.212004 参数组更新错误。 400 DBS.212005 节点不属于组。 409 DBS.212006 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 400 DBS.212007 引擎不存在。 400 DBS.212008 不支持的引擎。 400 DBS.212009 任务处理失败。 400 DBS.212010 绑定正在执行。 400 DBS.212011 绑定失败。 400 DBS.212012 参数不存在。 404 DBS.212013 对象不存在。 400 DBS.212014 节点没有默认参数组。 400 DBS.212015 部分成功。 400 DBS.212016 参数更新失败。 400 DBS.212017 参数错误。 422 DBS.212019 请求中的参数或对象不能被正确识别。 400 DBS.212025 更新失败。 400 DBS.212030 参数错误。 400 DBS.212032 已被应用。 400 DBS.212037 参数设置不正确。 500 DBS.213002 请求处理失败。 500 DBS.213004 请求处理失败。 400 DBS.216028 内部资源配额不足。 400 DBS.280001 参数错误。 409 DBS.280011 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 403 DBS.280015 访问资源不存在，或者无访问权限。 403 DBS.280020 账户受限。 401 DBS.280058 当前用户没有操作权限，请通过IAM检查账户权限。 403 DBS.280056 Token非法。 404 DBS.280110 所选实例不存在。 400 DBS.280127 备份描述非法。 400 DBS.280128 数据库名不存在。 400 DBS.280204 输入参数不合法。 400 DBS.280214 备份不存在。 400 DBS.280216 备份开始时间非法。 400 DBS.280235 数据库类型非法 400 DBS.280237 Datastore为空。 400 DBS.280238 不支持的数据库类型或版本。 400 DBS.280239 所选规格非法。 400 DBS.280241 卷类型非法。 400 DBS.280242 卷大小超出允许范围。 400 DBS.280246 数据库root密码非法 400 DBS.280250 备份保留期非法。 400 DBS.280251 备份周期不合法。 400 DBS.280253 备份开始时间非法。 400 DBS.280262 Ha同步模式非法。 400 DBS.280270 参数不存在。 400 DBS.280271 参数值超出范围。 400 DBS.280272 新增tag存在重复的key。 404 DBS.280275 源实例不存在。 400 DBS.280277 备份名称非法。 400 DBS.280285 可用区取值非法 400 DBS.280288 规格非法 400 DBS.280311 存储空间大小非法 400 DBS.280325 硬盘信息不合法 400 DBS.280328 当前实例类型不支持此操作。 400 DBS.280342 集群模式非法 400 DBS.280364 数据库端口号无效 400 DBS.280402 Ha模式非法。 400 DBS.280404 实例ID非法。 409 DBS.280406 实例类型或状态受限，操作不允许。 400 DBS.280434 所选规格码非法。 400 DBS.280448 当前卷类型已售罄。 400 DBS.280449 不能对冻结的对象执行该操作。 400 DBS.280450 当前规格已售罄。 400 DBS.280457 协调节点数量非法。 400 DBS.280458 分片数量非法 400 DBS.280461 扩容分片数非法 400 DBS.280489 实例已关联DDM组件，请先在DDM界面删除。 400 DBS.280490 备份已关联DDM组件，请先在DDM界面删除。 400 DBS.280649 实例名长度非法。 400 DBS.280810 设置数据库用户读写权限失败，用户可能不存在，请检查配置。 400 DBS.280812 实例已处于该状态，请勿重复点击。 400 DBS.280813 当前实例存在大事务或DDL等场景，不能进行该操作。 400 DBS.280816 当前实例处于DRS迁移任务中，请稍后重试。 400 DBS.290000 参数错误。 400 DBS.290001 参数错误。 404 DBS.290002 所选规格不存在。 413 DBS.290003 实例数量达到配额。 404 DBS.290005 该实例不存在。 500 DBS.290006 请求处理失败。 404 DBS.290011 RDS实例不存在。 404 DBS.290013 未找到资源。 500 DBS.290015 请求处理失败。 400 DBS.301132 实例已经是停止状态。 400 DBS.301133 实例已经是开启状态。 父主题： 附录

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 configurations Array of objects 参数模板列表。 详情请参见表3。 表3 configurations字段数据结构说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 description String 参数模板描述。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 created String 创建时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 user_defined Boolean 是否是用户自定义参数模板： false，表示为系统默认参数模板。 true，表示为用户自定义参数模板。 正常响应样例 { "configurations": [{ "id": "887ea0d1bb0843c49e8d8e5a09a95652pr01", "name": "configuration_test", "description": "configuration_test", "datastore_version_name": "8.0", "datastore_name": "mysql", "created": "2019-05-15T11:53:34+0000", "updated": "2019-05-15T11:53:34+0000", "user_defined": true }, { "id": "3bc1e9cc0d34404b9225ed7a58fb284epr01", "name": "Default-MySQL-5.7", "description": "Default parameter group for MySQL 5.7", "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2019-05-27T03:38:51+0000", "updated": "2019-05-27T03:38:51+0000", "user_defined": false } ] } 异常响应 请参见异常请求结果。

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

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 job_id String 任务ID。 restart_required Boolean 实例是否需要重启。 true，需要重启。 false，不需要重启。 正常响应样例 { "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94", "restart_required" : true } 异常响应 请参见异常请求结果。

请求示例 修改实例shared_preload_libraries参数的值 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries { "value" : "passwordcheck.so,pg_stat_statements,pg_sql_history" }

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

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

接口约束 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 除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个字符，至少包含以下字符中的三种：大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,组成。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

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