文档首页> 云数据库 GeminiDB> API参考> API v3（推荐）> 容灾管理> 校验实例是否可以与指定实例建立/解除容灾关系
更新时间：2023-11-21 GMT+08:00
查看PDF

校验实例是否可以与指定实例建立/解除容灾关系

功能介绍

校验实例是否可以与指定实例建立/解除容灾关系。若接口返回成功，表示可以与指定实例建立/解除容灾关系。

该接口需要对建立/解除容灾关系的两个实例各调用一次，2次调用都响应成功才能进行容灾关系的搭建/解除。

接口约束

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

operation

是

String

指定预校验的具体容灾操作。

  • 取值construction，表示搭建实例的容灾关系。
  • 取值deconstruction，表示解除实例的容灾关系。

disaster_recovery_instance

否

object

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

说明：
  • operation取值construction时该字段必须下发。
  • operation取值deconstruction时该字段无需下发。
表4 TargetDisasterRecoveryInstance

参数

是否必选

参数类型

描述

node_ips

是

Array of strings

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

spec_code

是

String

与当前实例建立容灾关系实例的规格码。

vpc_cidr

是

String

与当前实例建立容灾关系实例的vpc网段。

响应参数

状态码：204

无响应参数。

请求示例

  • URI样例
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/disaster-recovery/precheck
  • 校验实例是否可以与特定实例建立容灾关系
    {
    "operation" : "construction",
    "disaster_recovery_instance" :{
      "node_ips" : [ "10.0.1.2", "10.0.1.3", "10.0.1.4" ],
      "spec_code" : "geminidb.redis.xlarge.4",
      "vpc_cidr" : "10.0.0.0/16"
    } 
}
  • 校验实例是否可以与特定实例解除容灾关系
    {
    "operation" : "deconstruction"
}

响应示例

无。

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 容灾管理