文档首页> 云数据库 GeminiDB> API参考> API v3(推荐)> 容灾管理> 获取容灾实例主/备角色信息
更新时间:2023-11-21 GMT+08:00
分享

获取容灾实例主/备角色信息

功能介绍

该接口用于获取容灾实例主/备角色信息,以便后续容灾实例备升主和容灾实例主降备接口调用。

接口约束

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

调试

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/instance-role

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

role

String

枚举类型(master、slave)代表实例是主实例还是备实例。

请求示例

  • 获取主实例
    • URI样例
      GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/341f3291813f4fb6a523a8448aa86570in12/instance-role
  • 获取备实例
    • URI样例
      GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/419bdeb827c8419e88bb37f50e36c2e1in12/instance-role

响应示例

状态码: 200

Success

实例为主实例:

{
  "role" : "master" 
}

实例为备实例:

{
  "role" : "slave"  
}

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品