Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Disaster Recovery/ Querying Regions Where a Active-Active Relationship Can Be Created
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Querying Regions Where a Active-Active Relationship Can Be Created

Function

This API is used to query the regions where a dual-active relationship can be created.

Constraints

This API can be used on GeminiDB Cassandra instances.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:list

    Read

    -

    -

    nosql:backup:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/disaster-recovery/regions

Table 1 URI 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

region_codes

Array of strings

Region where a dual-active relationship can be created between two instances.

The creation of a dual-active instance is contingent on network configurations and necessary conditions. A dual-active relationship is not necessarily created between two instances even though there are available regions as such.

Example Request

URI example

GET https://{Endpoint}/v3/2900b7b8d03e4619b8db8d43bc6234ee/instances/3149aee486d748f68db1ee81e95b9f56in06/disaster-recovery/regions

Example Response

Status code: 200

Successful request

{ 
  "region_codes" : [ "cn-north-4" ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Disaster Recovery