文档首页> 云数据库 GeminiDB> API参考> API v3(推荐)> 容灾管理> 搭建实例与特定实例的容灾关系
更新时间:2023-11-21 GMT+08:00
分享

搭建实例与特定实例的容灾关系

功能介绍

该接口用于搭建实例与特定实例的容灾关系。

该接口需要对搭建容灾关系的两个实例分别各调用一次,2次接口都调用成功才能成功搭建容灾关系。

接口约束

该接口支持GeminiDB Redis数据库实例。

搭建容灾实例的VPC CIDR非192网段,非172网段。

搭建容灾实例的端口必须是8635。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disaster-recovery/construction

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

id

String

容灾ID。

对容灾角色为主的实例下发搭建容灾接口时不传该参数,接口成功响应后返回生成的容灾ID。

对容灾角色为备的实例下发搭建容灾接口时必传该参数,且必须与上述生成的容灾ID保持一致。

alias

String

搭建容灾关系的别名。

password

String

建立容灾关系所需要的容灾密码,搭建同一容灾关系的两次调用容灾密码必须保持一致。容灾密码为容灾集群内部数据通信所用,不能用于客户端连接使用。

instance_role

String

指定当前实例的容灾角色。取值为master或slave,表示在容灾关系中实例的容灾角色为主或备。

disaster_recovery_instance

object

与当前实例建立容灾关系的容灾实例信息。详情请参考表4

表4 DisasterRecoveryInstance

参数

是否必选

参数类型

描述

id

String

容灾实例的ID。

region_code

String

容灾实例所在Region的code。

subnet_cidrs

Array of strings

与当前实例建立容灾关系实例所在子网的CIDR列表。

node_ips

Array of strings

与当前实例建立容灾关系实例的所有节点的IP列表。

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

job_id

String

搭建容灾关系的工作ID。

disaster_recovery_id

String

容灾ID。

请求示例

  • URI样例
    POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/disaster-recovery/construction
  • 搭建实例与特定实例的容灾关系,容灾关系别名为"视频业务容灾",密码为"*****",当前实例的容灾角色为"master"
    {
        "alias" : "视频业务容灾",
        "password" : "*****",
        "instance_role" : "master",
        "disaster_recovery_instance" : {
          "region_code" : "cn-north-4",
         
         
          "id" : "430e7468a309459eb83c5981001415dein12",
          "subnet_cidrs" : [ "10.0.1.0/24" ],
          "node_ips" : [ "10.0.1.2", "10.0.1.3", "10.0.1.4" ]
        }
    }

响应示例

状态码: 202

Accepted

{
  "job_id" : "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
  "disaster_recovery_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品