Updated on 2024-04-18 GMT+08:00

Querying DR Details

Function

This API is used to query DR details.

Call Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/disaster-recovery/{disaster_recovery_id}
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.

disaster_recovery_id

Yes

String

DR ID

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

disaster_recovery

DisasterRecoveryQueryResp object

Response body for querying DR information.

Table 3 DisasterRecoveryQueryResp

Parameter

Type

Description

id

String

DR ID

name

String

DR name

dr_type

String

DR type

status

String

DR status

  • creating: The VPC peering connection is being created.
  • **create_failed**: Creating the execution failed.
  • unstart: The process is not started.
  • starting: The cluster is being started.
  • start_failed: The startup fails.
  • running: The event is running.
  • stopped: The VM is being stopped.
  • stop_failed: The service fails to be stopped.
  • stopped: The task has been stopped.
  • switchovering: The DR switchover is in progress.
  • abnormal
  • deleting: The VPC peering connection is being deleted.

primary_cluster

DisasterRecoveryCluster object

Primary cluster

standby_cluster

DisasterRecoveryCluster object

Standby cluster

dr_sync_period

String

DR synchronization period

start_time

String

DR start time

create_time

String

DR creation time

Table 4 DisasterRecoveryCluster

Parameter

Type

Description

id

String

ID of the DR cluster

name

String

Name of the DR cluster

cluster_az

String

AZ of the DR cluster

role

String

Role of the DR cluster

region

String

Region where the DR cluster is located

status

String

Status of the DR cluster

  • restoring: DCS instance restoration is in progress.
  • stopped: The task has been stopped.
  • waiting: The task is being executed in the next period.
  • abnormal

progress

String

DR progress

last_success_time

String

Last DR time

obs_bucket_name

String

OBS bucket name

Example Request

https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/disaster-recovery/b303b78d-438c-41dd-aaf6-c98eea1fc2a6

Example Response

Status code: 200

The DR information is queried successfully.

 {  
   "disaster_recovery": {   
     "id": "b303b78d-438c-41dd-aaf6-c98eea1fc2a6",   
     "name": "dws-it-02",   
     "status": "running",   
     "dr_type": "region",  
     "primary_cluster": {    
        "id": "3de21046-e65e-4fcf-86bf-583115b39c27",   
        "name": "dws-203-primary",    
        "cluster_az": "cn-north-7c",    
        "role": "primary",    
        "region": "cn-north-7",     
        "status": "waiting",    
        "progress": "100",     
        "last_success_time": "2023-04-29T06:39:56",    
        "obs_bucket_name": null  
      },   
     "standby_cluster": {    
        "id": "5d946c51-9ffa-49e3-9129-2bea4d23d3fd",     
        "name": "dws-205-standby",     
        "cluster_az": null,    
        "role": "standby",    
        "region": "cn-north-208",    
        "status": "waiting",   
        "progress": "100",    
        "last_success_time": "2023-04-29T06:39:56",   
        "obs_bucket_name": null  
     },  
    "dr_sync_period": "3H",  
    "start_time": "2023-04-28T09:23:38",  
    "create_time": "2023-04-28T08:51:54" 
   }
 }

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
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 ShowDisasterDetailSolution {

    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();
        ShowDisasterDetailRequest request = new ShowDisasterDetailRequest();
        try {
            ShowDisasterDetailResponse response = client.showDisasterDetail(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
# 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 = ShowDisasterDetailRequest()
        response = client.show_disaster_detail(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
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.ShowDisasterDetailRequest{}
	response, err := client.ShowDisasterDetail(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

The DR information is queried successfully.

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.