Help Center> GeminiDB> API Reference> APIs v3 (Recommended)> Disaster Recovery> Obtaining Role Information of a DR Instance
Updated on 2023-11-21 GMT+08:00
View PDF

Obtaining Role Information of a DR Instance

Function

This API is used to obtain role information of a DR instance for role switchover.

Constraints

This API supports GeminiDB Redis instances.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

role

String

Instance role. Option master indicates that the role of the DR instance is primary, and option slave indicates that the role of the DR instance is standby.

Example Requests

  • Obtaining the primary instance
    • URI example
      GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/341f3291813f4fb6a523a8448aa86570in12/instance-role
  • Obtaining the standby instance
    • URI example
      GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/419bdeb827c8419e88bb37f50e36c2e1in12/instance-role

Example Responses

Status code: 200

Success

Primary instance

{
  "role" : "master" 
}

Standby instance

{
  "role" : "slave"  
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Disaster Recovery