Help Center/ GaussDB(DWS)/ API Reference/ API Description/ DR Management/ Querying the List of Available DR Clusters
Updated on 2024-04-18 GMT+08:00

Querying the List of Available DR Clusters

Function

This API is used to query the list of available DR clusters.

Call Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/disaster-recovery-clusters
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

primary_cluster_id

Yes

String

ID of the primary cluster

primary_spec_id

No

String

ID of the primary cluster.

primary_cluster_dn_num

No

String

Number of DNs in the primary cluster.

standby_region

No

String

Region where the standby cluster is located.

standby_project_id

No

String

Project ID of the standby cluster

standby_az_code

Yes

String

AZ where the standby cluster is located.

dr_type

No

String

DR type.

datastore_type

No

String

Data warehouse type.

datastore_version

No

String

Data warehouse version.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

disaster_recovery_clusters

Array of DisasterRecoveryClusterVo objects

List of available DR clusters.

Table 4 DisasterRecoveryClusterVo

Parameter

Type

Description

id

String

Cluster ID

name

String

Cluster name

Example Request

https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/disaster-recovery-clusters?primary_cluster_id=3de21046-e65e-4fcf-86bf-583115b39c27&standby_az_code=cn-north-7a&standby_region=&dr_type=&standby_project_id=

Example Response

Status code: 200

Request succeeded.

{
  "disaster_recovery_clusters" : [ ]
}

SDK Sample Code

The sample code is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListAvailableDisasterClustersSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        ListAvailableDisasterClustersRequest request = new ListAvailableDisasterClustersRequest();
        request.withPrimaryClusterId("<primary_cluster_id>");
        request.withPrimarySpecId("<primary_spec_id>");
        request.withPrimaryClusterDnNum("<primary_cluster_dn_num>");
        request.withStandbyRegion("<standby_region>");
        request.withStandbyProjectId("<standby_project_id>");
        request.withStandbyAzCode("<standby_az_code>");
        request.withDrType("<dr_type>");
        request.withDatastoreType("<datastore_type>");
        request.withDatastoreVersion("<datastore_version>");
        try {
            ListAvailableDisasterClustersResponse response = client.listAvailableDisasterClusters(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListAvailableDisasterClustersRequest()
        request.primary_cluster_id = "<primary_cluster_id>"
        request.primary_spec_id = "<primary_spec_id>"
        request.primary_cluster_dn_num = "<primary_cluster_dn_num>"
        request.standby_region = "<standby_region>"
        request.standby_project_id = "<standby_project_id>"
        request.standby_az_code = "<standby_az_code>"
        request.dr_type = "<dr_type>"
        request.datastore_type = "<datastore_type>"
        request.datastore_version = "<datastore_version>"
        response = client.list_available_disaster_clusters(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListAvailableDisasterClustersRequest{}
	request.PrimaryClusterId = "<primary_cluster_id>"
	primarySpecIdRequest:= "<primary_spec_id>"
	request.PrimarySpecId = &primarySpecIdRequest
	primaryClusterDnNumRequest:= "<primary_cluster_dn_num>"
	request.PrimaryClusterDnNum = &primaryClusterDnNumRequest
	standbyRegionRequest:= "<standby_region>"
	request.StandbyRegion = &standbyRegionRequest
	standbyProjectIdRequest:= "<standby_project_id>"
	request.StandbyProjectId = &standbyProjectIdRequest
	request.StandbyAzCode = "<standby_az_code>"
	drTypeRequest:= "<dr_type>"
	request.DrType = &drTypeRequest
	datastoreTypeRequest:= "<datastore_type>"
	request.DatastoreType = &datastoreTypeRequest
	datastoreVersionRequest:= "<datastore_version>"
	request.DatastoreVersion = &datastoreVersionRequest
	response, err := client.ListAvailableDisasterClusters(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

Request succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.