华为云用户手册

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 批量实例ID。 start_time 是 String 任务开始时间。 upgrade_type 是 String 实例升级类型。区分大小写。 取值范围： hotfix：热补丁升级。 upgrade_action 是 String 实例升级操作，热补丁升级目前只包括升级自动提交。 upgradeAutoCommit：升级自动提交。 target_version 是 String 批量实例升级目标版本。

响应参数 表2 响应Body参数列表 名称 参数类型 说明 instance_id String 实例ID。 status String 流式容灾状态。 normal：该集群未参与容灾。 full_backup：主集群数据全量复制中。 archive：主集群日志流式复制中。 backup_fail：主集群数据全量复制失败。 archive_fail：主集群日志流式复制失败。 switchover：计划内主备倒换中。 restore：灾备集群数据全量恢复中。 restore_fail：灾备集群全备恢复失败。 recovery：灾备集群日志流式复制中。 recovery_fail：灾备集群日志流式复制失败。 promote：灾备集群升主中。 promote_fail：灾备集群升主失败。 rpo String 数据恢复点目标。 rto String 数据恢复时间目标。 rpo_threshold String RPO阈值。 rto_threshold String RTO阈值。 switchover_progress String 主备切换进度。该值为一个百分数。例如：40%。 failover_progress String 容灾升主进度。该值为一个百分数。例如：40%。

响应示例 { "rpo":"0", "rto":"0", "status":"archive", "instance_id":"b3692282395340c5b5421ecf3d7bd6adin14", "rto_threshold":"900", "rpo_threshold":"10", "failover_progress":"", "switchover_progress":"" }

URI GET https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/monitor?disaster_type={disaster_type} 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID。 disaster_type 是 String 容灾类型： stream：流式容灾。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/switchover { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/switchover 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 disaster_type 是 String 容灾类型。 枚举值： stream：流式容灾。 post_process_config 否 String 是否支持倒换失败自愈，为空时默认不自愈。 枚举值： AUTO：容灾切换失败故障自愈。 MANUAL：容灾切换失败不自愈。 该字段仅支持数据库引擎版本大于等于V2.0-8.200的Quorum流式容灾，其他场景的容灾主备切换不提供自愈功能。

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/simulation-stop 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/simulation-stop { "disaster_type" : "stream" }

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/keep-log-stop { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/keep-log-stop 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

URI DELETE https://{Endpoint}/v3/{project_id}/instances/schedule-task/{task_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 task_id 是 String 任务ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/9089bbf7377442daa55bc28d514c08bdin14/disaster-recovery/construct { "disaster_type" : "stream", "dr_ip" : "127.0.0.1", "dr_user_name" : "root", "dr_user_password" : "password", "dr_task_name": "dr-task-123" }

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 disaster_type 是 String 容灾类型。 枚举值： stream：流式容灾。 dr_ip 是 String 对端实例数据IP。可通过查询查询数据库实例列表接口获取。 集中式版：对端实例任意节点数据IP（非仲裁节点、非日志节点）。 分布式版：对端实例CN节点的数据IP。 dr_user_name 是 String 对端实例账户名称。 dr_user_password 是 String 对端实例账户密码。 dr_task_name 否 String 容灾任务名称。

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/construct 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/restore { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/restore 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/keep-log-start { "xlog_keep_ratio":50, "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/keep-log-start 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/records?offset=0&limit=100&entity_id=643a0dd1-ae7b-47c9-bac4-29590a67b679&entity_type=dr

响应参数 表2 响应Body参数列表 名称 参数类型 说明 records Array of objects 操作记录列表。 详情请参见表3。 表3 records字段数据结构说明 参数 参数类型 描述 id String 主键ID。 action String 容灾的操作动作。 dr_stream_switchover_to_postcheck：流式容灾主备切换后置检查。 dr_stream_switchover_auto_recovery：流式容灾主备切换后置处理。 dr_stream_switchover_auto_recovery_result：流式容灾主备切换后置处理结果。 dr_stream_switchover：流式主备切换开始。 dr_stream_switchover_result：流式主备切换完成。 dr_stream_failover：流式升主开始。 dr_stream_failover_result：流式升主完成。 dr_stream_restore：流式回切开始。 dr_stream_restore_result：流式回切完成。 status String 操作状态。 success：操作成功。 failed：操作失败。 query：查询。 message String 记录信息。 entity_id String 实体ID（容灾场景下为：容灾关系唯一ID）。 entity_type String 实体类型。 dr：容灾。 job_id String 工作流ID。 instance_id String 实例ID。 created_at String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated_at String 更新时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 extended_info Object 扩展信息。

响应示例 { "records": [ { "id": "f34bf1d7-03f9-4f33-aac5-033457ca86f6", "action": "dr_stream_failover_result", "status": "success", "message": "", "entity_id": "210c7c5c-618d-4ec9-917a-c2681426df85", "entity_type": "dr", "job_id": "b4670be1-3372-4f44-b049-9c145abbb5d9", "instance_id": "083e6e04bc534727954f9d07ac90ab03in14", "created_at": "2024-11-19T11:29:25Z", "updated_at": "2024-11-19T11:29:25Z", "extended_info": { "allExtras": {}, "extraKeys": [], "extra": {} } }, { "id": "0074ead8-a50c-429f-b602-9d70f4a6dc36", "action": "dr_stream_failover", "status": "success", "message": "", "entity_id": "210c7c5c-618d-4ec9-917a-c2681426df85", "entity_type": "dr", "job_id": "b4670be1-3372-4f44-b049-9c145abbb5d9", "instance_id": "083e6e04bc534727954f9d07ac90ab03in14", "created_at": "2024-11-19T11:28:49Z", "updated_at": "2024-11-19T11:28:49Z", "extended_info": { "allExtras": {}, "extraKeys": [], "extra": {} } } ] }

URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disaster-recovery/records 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID。 entity_id 是 String 实体ID（容灾场景下为容灾关系唯一ID。见表3中容灾关系唯一ID字段）。 entity_type 是 String 实体类型。 dr：容灾。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1-10条数据。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/release { "disaster_type" : "stream" }

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/release 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

响应参数 表2 要素说明 名称 参数类型 说明 tasks Array of objects 任务列表。 详情请参见表3 tasks字段数据结构说明。 total_count Integer 任务数量。 表3 tasks字段数据结构说明 名称 参数类型 说明 task_id String 任务ID。 task_name String 任务名称。 status String 任务状态。 create_time String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 start_time String 设置开始执行时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 instance_id String 实例ID。 instance_name String 实例名称。 task_content Object 任务信息。

响应示例 查询任务列表成功。 { "tasks": [ { "status": "Completed", "task_id": "dea835aa-5ceb-4209-be57-ecd7992ed6af", "task_name": "HOTFIX_VERSION_UPGRADE", "create_time": "2024-12-16T06:54:39Z", "start_time": "2024-12-16T06:55:32Z", "instance_id": "54bef6617fab4a88ab52967218c34527in14", "instance_name": "gauss-ba81", "task_content": "3.208.0.6" }, { "status": "Completed", "task_id": "8d93aa3a-20c2-4c53-a3cf-933bde3ba002", "task_name": "HOTFIX_VERSION_UPGRADE", "create_time": "2024-12-16T06:54:39Z", "start_time": "2024-12-16T06:55:32Z", "instance_id": "096d0720b5604eca93b8a216a15d4778in14", "instance_name": "gauss-5185", "task_content": "3.208.0.6" }, { "status": "Completed", "task_id": "5111a1e3-0030-4766-8dd8-7ab73a2e89c4", "task_name": "HOTFIX_VERSION_UPGRADE", "create_time": "2024-12-16T08:51:11Z", "start_time": "2024-12-16T08:53:01Z", "instance_id": "b6ac63d384854e76ba7afd0e10aa9c29in14", "instance_name": "gauss-7fa8", "task_content": "3.208.0.7" } ], "total_count": 3 }

URI GET https://{Endpoint}/v3/{project_id}/instances/schedule-tasks 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 否 String 实例节点ID。 status 否 String 任务状态。 Running：运行中 Completed：完成 Failed：失败 Pending：待执行 Canceled：已取消 name 否 String 任务名称。 HOTFIX_VERSION_UPGRADE ：热补丁版本升级。 start_time 否 String 开始时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time 否 String 结束时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应参数 表2 响应Body参数列表 名称 参数类型 说明 total Integer 总记录数。 relations Array of Objects 容灾关系详情。详情请参见表3。 表3 relations字段数据结构说明 名称 参数类型 说明 disaster_type String 容灾类型。 枚举值: stream：流式容灾。 name String 容灾任务名称。 disaster_role String 容灾角色。 枚举值: master：主实例。 disaster：灾备实例。 created String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 updated String 更新时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 slave_region_instance_info Object 备Region实例信息。详情请参见表4。 master_region_instance_info Object 主Region实例信息。详情请参见表5。 synchronization_id String 容灾关系唯一ID。 id String 容灾记录ID。 instance_id String 当前Region实例ID。 instance_name String 当前Region实例名称。 instance_status String 当前Region实例状态。 precheck_failed_reason String 预校验失败原因。 status String 容灾记录状态。 取值范围如下： pending：任务处理中。 normal：容灾关系正常。 failed：容灾搭建失败。 completed：容灾关系已解除。 failover：容灾已升主。 simulation：演练中。 dr_log_keep：日志保持中。 pre_checking：容灾预检查。 pre_check_failed：容灾预检查失败。 actions Array of Strings 实例当前正在执行的Action列表。 表4 slave_region_instance_info字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 project_id String 实例项目ID。 project_name String 实例项目名称。 region_code String regionCode编码。 ip_address String 数据IP地址列表，使用英文逗号分割。 表5 master_region_instance_info字段数据结构说明 名称 参数类型 说明 instance_id String 实例ID。 project_id String 实例项目ID。 project_name String 实例项目名称。 region_code String regionCode编码。 ip_address String 数据IP地址列表，使用英文逗号分割。

响应示例 { "total" : 1, "relations" : [ { "name" : "DR-task-0962", "created" : "2022-06-16 09:39:51", "updated" : "2022-06-16 09:44:55", "id" : "30b74120-4b50-495d-8174-7eeddf7feac5", "synchronization_id" : "9446f822-ccd2-43dc-929c-0b78ba7fdf64", "status" : "normal", "precheck_failed_reason" : "", "disaster_type" : "stream", "disaster_role" : "disaster", "slave_region_instance_info" : { "region_code" : "sa-fb-1", "instance_id" : "d1060faf0d3743dd8830b39e7423bc9ain14", "project_id" : "4a52a8a8f63d4c6d966dff0e20b69738", "project_name" : "sa-fb-1_ GaussDB ", "ip_address" : "172.166.1.192,172.166.0.6,172.166.1.135" }, "master_region_instance_info" : { "region_code" : "sa-fb-1", "instance_id" : "54d4b9fb131745fcba32cb90a05cabb8in14", "project_id" : "4a52a8a8f63d4c6d966dff0e20b69738", "project_name" : "sa-fb-1_GaussDB", "ip_address" : "172.167.1.86,172.167.0.89,172.167.1.229" }, "instance_id" : "d1060faf0d3743dd8830b39e7423bc9ain14", "instance_name" : "hly-0609-02", "instance_status" : "normal", "actions" : [ "STREAM_DISASTER_RELATION_MASTER_TAG" ] } ] }