华为云用户手册

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 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），即数据在灾备上回放的延迟时间。 正常响应样例 { "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" } 异常响应 请参见异常请求结果。

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 hosts 否 Array of objects 参数解释： 主机信息。 每个元素结构请参见表3。 表3 hosts列表元素数据结构说明 名称 是否必选 参数类型 说明 host_name 是 String 参数解释： 主机名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 ip 是 String 参数解释： 主机IP。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

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

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

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 list Array of objects 慢日志文件信息。详情请参见表3。 total_count Integer 文件总数。 表3 SlowLogFile字段数据结构说明 参数 参数类型 描述 file_name String 文件名。 file_size String 文件大小（单位：Byte）。 正常响应样例 { "total_count" : 1, "list" : [ { "file_name" : "SQLTrace.trc", "file_size" : "1024" } ] } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/slowlog-files 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 查询的实例ID。 offset 否 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 每页多少条记录，取值范围是1~100，不填时默认为10。

请求示例 使用备份文件将数据恢复到实例。 POST https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/recovery { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 使用SQL Server备份文件将所有数据库恢复到实例。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "backup", "backup_id": "b021670e69ba4538b7b2ed07257306aebr04", "restore_all_database":true }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } } 将实例的数据恢复到指定时间点。 { "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } } 将SQL Server实例的部分数据库恢复到指定时间点。 { "source": { "instance_id": "61879e6085bc44d1831b0ce62d988fd9in04", "type": "timestamp", "restore_time": 1532001446987, "database_name": { "db1": "dbtest1,dbtest2", "db2": "db2,db02", "db3": "" } }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04" } }

请求示例 更新实例的跨区域自动全量备份策略。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/backups/offsite-policy { "policy_para": { "backup_type": "auto", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 关闭实例的跨区域自动全量备份策略。 { "policy_para": { "backup_type": "auto", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 更新SQL Server实例的跨区域备份策略。 { "policy_para": { "backup_type": "all", "keep_days": 7, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } } 关闭SQL Server实例的跨区域备份策略。 { "policy_para": { "backup_type": "all", "keep_days": 0, "destination_region": "aaa", "destination_project_id": "ba1f7fc8-3307-42a7-aa6f-42c8b9b8f85c" } }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 policy_para 是 Object 备份策略对象，包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。 表3 policy_para字段数据结构说明 名称 是否必选 参数类型 说明 backup_type 是 String 指定备份的类型。 RDS for SQL Server仅支持设置为“all”。 取值如下： auto：自动全量备份。 incremental：自动增量备份。 all：同时设置所有备份类型。 RDS for MySQL：同时设置自动全量和自动增量备份。 RDS for PostgreSQL：同时设置自动全量和自动增量备份。 RDS for SQL Server：同时设置自动全量、自动增量备份和手动备份。 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～1825。 保存天数设置为0时，表示关闭跨区域备份策略。 须知： 关闭备份策略后，备份任务将立即停止，如果有增量备份，所有增量备份任务将立即删除，使用增量备份的相关操作可能失败，相关操作不限于下载、复制、恢复、重建等，请谨慎操作。 destination_region 是 String 设置跨区域备份策略的目标区域ID。 destination_project_id 是 String 设置跨区域备份策略的目标project ID。

接口约束 如果实例已开启跨区域备份策略，调用接口设置跨区域备份策略，仅会更改保留天数，其他参数设置无效。 RDS for PostgreSQL自动全量备份和自动增量备份保留天数必须保持一致。 RDS for PostgreSQL自动增量备份必须在开启自动全量备份后才能开启。 RDS for PostgreSQL自动全量备份和自动增量备份都开启后，关闭时请按顺序依次关闭自动增量备份、自动全量备份。 RDS for PostgreSQL选择卷快照备份方式的实例不支持跨区域备份。

请求示例 解除实例容灾关系。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/42d4b4fc17d144bbb3ba64a306e68c72in03/delete-disaster-recovery { "target_instance_id" : "8c08eda627cc4344aca26832c87ff16cin03", "target_project_id" : "0ddd1dbcb3494d3dbdb614b39104760b", "target_region" : "cn-southwest-244", "target_ip" : "192.168.2.70", "is_master" : true }

请求消息 表1 参数说明 名称 是否必选 参数类型 说明 target_instance_id 是 String 解除目标的实例ID。 target_project_id 是 String 解除目标的项目 ID。 target_region 是 String 解除目标的region。 target_ip 是 String 解除目标的数据浮动IP。 is_master 是 Boolean 当前操作对象是否是主实例。 值为“true”，表示当前是主实例。 值为“false”，表示当前是灾备实例。

请求示例 https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/proxy/weight { "master_weight":"0", "readonly_instances":[ { "id":"83251d1398594b9fbfc8f1ab8b8228b2in03", "weight":100 } ] }

请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 master_weight 是 String 主实例权重，取值范围为0~1000。 readonly_instances 是 Array of objects 只读实例信息。 详情请参见表3。 表3 readonly_instances字段数据结构说明 名称 是否必选 参数类型 说明 id 是 String 只读实例ID。 weight 是 Integer 只读实例权重，取值范围为0~1000。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目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 } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表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。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 生成审计日志下载链接。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-links { "ids": ["fa163e9970a3t11e9d834e122fdceb1d6br01", "fa163ea0e2bet11e9d8364943103c94c5br01"] }

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 links Array of strings 审计日志下载链接列表，有效时间5分钟。 正常响应样例 { "links": ["https://obs.domainname.com/rdsbucket.username.1/xxxxxx", "https://obs.domainname.com/rdsbucket.username.2/xxxxxx"] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 error_log_list Array of objects 参数解释： 具体信息。 详情请参见表3 errorLogList字段数据结构说明。 total_record Integer 参数解释： 总记录数。 取值范围： 不涉及。 表3 error_log_list字段数据结构说明 名称 参数类型 说明 time String 参数解释： 日期时间UTC时间。 取值范围： 不涉及。 level String 参数解释： 日志级别。 取值范围： 不涉及。 content String 参数解释： 错误日志内容。 正常响应样例 { "error_log_list": [ { "time": "2022-08-23T22:59:17Z", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }, { "time": "2022-08-23T22:54:17Z", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." } ], "total_record": 2 } 异常响应 请参见异常请求结果。

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/errorlog?offset=1&limit=10&start_date=2022-08-23T07:41:50+0800&end_date=2022-08-24T07:41:50+0800&level=ALL

URI URI格式 GET /v3.1/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 start_date 是 参数解释： 开始时间。 约束限制： 不涉及。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 end_date 是 参数解释： 结束时间。 约束限制： 只能查询当前时间前一个月内的错误日志。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 offset 否 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 不涉及。 取值范围： 必须为数字，不能为负数。 默认取值： 默认为0。偏移0条数据，表示从第一条数据开始查询。 limit 否 参数解释： 每页多少条记录（查询结果）。 约束限制： 不涉及。 取值范围： 1~100 默认取值： 不填时默认为10。 level 否 参数解释： 日志级别。 约束限制： 不涉及。 取值范围： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE 默认取值： ALL

响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 records List 停止结果记录。 详情请参见表4。 表4 records字段说明 名称 参数类型 说明 instance_id String 实例ID。 job_id String 任务ID。 正常响应样例 { "records": [ { "instance_id": "5b409baece064984a1b3eef6addae50cin01", "job_id": "2b414788a6004883a02390e2eb0ea227" } ] } 异常响应 请参见异常请求结果。

接口约束 如需批量停止实例，请联系客服申请。 最多支持批量停止50个实例。 该接口仅支持MySQL引擎。 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例，专属云RDS不支持停止实例。 已停止的实例被删除后不会进入回收站。 停止主实例时，如果存在只读实例，会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域，主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域，主实例和只读实例均默认停止七天。 对于华东-上海一区域，实例默认停止十五天，如果您在十五天后未手动开启实例，数据库实例将于十五天后的下一个可维护时间段内自动启动。 对于除华东-上海一外的其他区域，实例默认停止七天，如果您在七天后未手动开启实例，数据库实例将于七天后的下一个可维护时间段内自动启动。 实例停止后，虚拟机（VM）停止收费，其余资源包括弹性公网IP（EIP）、存储资源、备份正常计费。 实例在以下状态不能执行停止实例： 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 要查询的实例ID。 start_date 是 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 只能查询当前时间前一个月内的错误日志。 offset 否 页数偏移量，如1、2、3、4等，不填时默认为1。 limit 否 每页多少条记录，取值范围是1~100，不填时默认为10。 level 否 日志级别，默认为ALL，可取值如下： ALL INFO LOG WARNING ERROR FATAL PANIC NOTE

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/errorlog?offset=1&limit=10&start_date=2018-08-06T10:41:14+0800&end_date=2018-08-07T10:41:14+0800&level=ALL

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 error_log_list Array of objects 具体信息。 详情请参见表3 errorLogList字段数据结构说明。 total_record Integer 总记录数。 表3 error_log_list字段数据结构说明 名称 参数类型 说明 time String 日期时间UTC时间。 level String 日志级别。 content String 错误日志内容。 正常响应样例 { "error_log_list": [{ "time": "2018-12-04T14:24:42", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }, { "time": "2018-12-04T14:24:42", "level": "WARNING", "content": "Occur error when reading bytes from a network handler. Client actively closes the connection." }], "total_record": 2 } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表1 要素说明 名称 参数类型 说明 versions Array of objects API版本详细信息列表。 详情请参见表2。 表2 versions字段数据结构说明 名称 参数类型 说明 id String API版本号。 各个版本号，对应如下： v1：API v1版本。 v3：API v3版本。 links Array of objects 对应API的链接信息，v1、v3版本该字段为空。 详情请参见表3。 status String 版本状态。 取值“CURRENT”，表示该版本为主推版本。 取值“DEPRECATED”，表示为废弃版本，存在后续删除的可能。 updated String 版本更新时间，格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 表3 links字段数据结构说明 名称 参数类型 说明 href String 对应该API的URL，该字段为""。 rel String 取值为“self”，表示href为本地链接。 正常响应样例 { "versions": [{ "id": "v3", "links": [], "status": "CURRENT", "updated": "2019-01-15T12:00:00Z" }, { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 database_schemas Array of objects 参数解释： 列表中每个元素表示一个数据库schema。 详情请参见表3。 total_count Integer 参数解释： 数据库schema总数。 取值范围： 不涉及。 表3 users元素结构说明 名称 参数类型 说明 schema_name String 参数解释： schema名称。 取值范围： 不涉及。 owner String 参数解释： schema所属用户。 取值范围： 不涉及。 正常响应样例 { "database_schemas": [{ "schema_name": "rds_user1", "owner": "root" }], "total_count": 1 }