华为云用户手册

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 cur_delay_time_mills int 参数解释： 当前配置的延迟时间，单位ms。 取值范围： 延迟时间由实例参数“recovery_min_apply_delay”控制，可通过修改该参数设置实例wal日志回放延迟时间。修改实例参数请参考修改指定实例的参数。 delay_time_value_range String 参数解释： 延迟时间参数取值范围。 取值范围： 不涉及。 real_delay_time_mills int 参数解释： 真实延迟时间，单位ms。 取值范围： 不涉及。 cur_log_replay_paused boolean 参数解释： 当前日志回放状态。 取值范围： true表示回放暂停。 false表示回放正常。 latest_receive_log String 参数解释： 最新接收的日志。 取值范围： 不涉及。 latest_replay_log String 参数解释： 最新回放的日志位点。 取值范围： 不涉及。 正常响应样例 { "cur_delay_time_mills" : 0, "delay_time_value_range" : "0-2147483647", "real_delay_time_mills" : 0, "cur_log_replay_paused" : true, "latest_receive_log" : "0/8000060", "latest_replay_log" : "0/8000060" } 异常响应 请参见异常请求结果。

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 total_count Integer 参数解释： host总数。 取值范围： 不涉及。 hosts Array of objects 参数解释： host列表。 详情请参见表3。 表3 hosts元素结构说明 名称 参数类型 说明 id String 参数解释： host ID。 取值范围： 不涉及。 host String 参数解释： host地址。 取值范围： 不涉及。 host_name String 参数解释： host名称。 取值范围： 不涉及。 正常响应样例 { "total_count" : 1, "hosts" : [ { "id" : "527dd9ca-cc2c-4bac-8707-f9b4f55343f4", "host" : "192.168.0.90", "host_name" : "MSSQL-00E5FB7A" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/msdtc/hosts?offset={offset}&limit={limit} 参数说明 表1 参数说明 参数 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 offset 否 Integer 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 不涉及。 取值范围： 必须为数字，不能为负数。 默认取值： 默认为0，偏移0条数据，表示从第一条数据开始查询。 limit 否 Integer 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： 1~100 默认取值： 10

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

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

请求示例 修改参数模板的参数值。 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" } }

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

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

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

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

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

请求示例 开启SQL限流。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/ 49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit/switch { "db_name" : "postgres", "id" : "1", "action" : "open" }

请求消息 表2 参数说明 参数 是否必选 参数类型 描述 db_name 是 String 参数解释： 数据库名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id 是 String 参数解释： SQL限流ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 action 是 String 参数解释： SQL限流动作标志。 约束限制： 不涉及。 取值范围： open：表示开启当前SQL限流。 close：表示关闭当前SQL限流。 disable_all：表示禁用所有SQL限流。 默认取值： 不涉及。

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

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

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 要素说明 名称 参数类型 说明 databases Array of objects 参数解释： 列表中每个元素表示一个数据库。 详情请参见表3。 total_count Integer 参数解释： 数据库总数。 取值范围： 不涉及。 表3 databases元素结构说明 名称 参数类型 说明 name String 参数解释： 数据库名称。 取值范围： 不涉及。 character_set String 参数解释： 数据库使用的字符集。 取值范围： SQL Server支持的字符集列表，请参见表2。 取值示例：Chinese_PRC_CI_AS。 state String 参数解释： 数据库状态。 取值范围： Creating：表示创建中。 Running：表示使用中。 Deleting：表示删除中。 NotExists：表示不存在。 正常响应样例 { "databases": [ { "name": "master", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "msdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "model", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "tempdb", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rdsadmin", "character_set": "Chinese_PRC_CI_AS", "state": "Running" }, { "name": "rds-test", "character_set": "Chinese_PRC_CI_AS", "state": "Running" } ], "total_count": 6 } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit}&db-name={db-name}&recover_model={recover_model} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 page 是 参数解释： 分页页码。 约束限制： 不涉及。 取值范围： 从1开始的正整数。 默认取值： 不涉及。 limit 是 参数解释： 每页数据条数。 约束限制： 不涉及。 取值范围： [1, 100]区间内正整数。 默认取值： 不涉及。 db-name 否 参数解释： 数据库名。 约束限制： 当指定该参数时，page和limit参数需要传入但不生效。 取值范围： 不涉及。 默认取值： 不涉及。 recover_model 否 参数解释： 数据库恢复健康模式。 约束限制： 不涉及。 取值范围： FULL：完整模式。 SIMPLE：简单模式。 BULK_ LOG GED：大容量日志恢复模式。 默认取值： 不涉及。

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

请求示例 修改SQL限流。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/sql-limit/update { "db_name" : "postgres", "id" : "1", "max_concurrency" : 10, "max_waiting" : 10 }

请求消息 表2 参数说明 参数 是否必选 参数类型 描述 db_name 是 String 参数解释： 数据库名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id 是 String 参数解释： SQL限流ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 max_concurrency 是 Integer 参数解释： 同时执行的SQL数量。 约束限制： 不涉及。 取值范围： -1~50000。小于等于0表示不限制。 默认取值： 0 max_waiting 是 Integer 参数解释： 最大等待时间，单位为秒。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 extensions Array of objects 参数解释： 插件列表信息。 详情请参见表3。 total_count Integer 参数解释： 总插件数。 取值范围： 不涉及。 表3 extensions元素结构说明 名称 参数类型 说明 name String 参数解释： 插件名称。 取值范围： 不涉及。 database_name String 参数解释： 数据库名称。 取值范围： 不涉及。 version String 参数解释： 插件版本。 取值范围： 不涉及。 version_update String 参数解释： 可更新的插件版本。如果和version字段值不一致，说明插件可更新。 取值范围： 不涉及。 shared_preload_libraries String 参数解释： 依赖预加载库。 取值范围： 不涉及。 created Boolean 参数解释： 插件是否已创建。 取值范围： 不涉及。 description String 参数解释： 插件描述。 取值范围： 不涉及。 正常响应样例 { "extensions" : [ { "name" : "pg_cron", "database_name" : "db1", "version" : "1.0", "version_update" : "1.0", "shared_preload_libraries" : "pg_cron", "created" : false, "description" : "pg_cron access method - signature file based index" }, { "name" : "dblink", "database_name" : "db1", "version" : "1.2", "version_update" : "1.2", "shared_preload_libraries" : "", "created" : false, "description" : "connect to other PostgreSQL databases from within a database" } ], "total_count" : 2 } 异常响应 请参见异常请求结果。

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

请求示例 设置读写分离路由模式。 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/ba0fd7c13cca4655820e0f858d5d467bin01/proxy/4e2a0c70f70f4807940db73a30b5b522po01/route-mode { "master_weight" : 0, "readonly_instances" : [ { "instance_id" : "2edc88e921bb4129bb4d9b76be66811dno07", "weight" : 1 } ], "route_mode" : 2 }

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

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 master_weight 是 Integer 参数解释： 数据库主实例读权重。 约束限制： 不涉及。 取值范围： 当route_mode选择0（权重负载）时，该字段取值范围为0~1000。 当route_mode取值非0（权重负载）时，该字段不生效。 默认取值： 不涉及。 readonly_instances 是 Array of objects 参数解释： 数据库节点的读权重设置。请参见表3。 约束限制： 只能为只读实例选择权重。 该列表可以为空列表。 route_mode 是 Integer 参数解释： 数据库代理路由模式。 约束限制： 不涉及。 取值范围： 0：表示权重负载模式。 1：表示负载均衡模式（数据库主实例不接受读请求）。 2：表示负载均衡模式（数据库主实例接受读请求）。 默认取值： 不涉及。 表3 readonly_instances字段数据结构说明 参数 是否必选 参数类型 描述 instance_id 是 String 参数解释： 数据库实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 weight 是 Integer 参数解释： 数据库代理读权重。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 开启数据库代理。 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/920ec36cef814a8b830a5bed50d9a088in01/proxy/open { "flavor_ref": "rds.proxy.xlarge.2", "node_num": 2, "proxy_name": "proxy-test", "nodes_read_weight": [ { "instance_id": "917c67424dd54af3addf537a069e5b20in01", "weight": 1 } ] }

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