Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Snapshot Management/ Querying All Cross-Region Snapshot Configurations
Updated on 2024-04-18 GMT+08:00

Querying All Cross-Region Snapshot Configurations

Function

This API is used to query all cross-region snapshot configurations.

Call Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/snapshots/cross-region-policies
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

cluster_id

No

String

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

offset

No

Integer

Pagination offset.

limit

No

Integer

Number of records displayed on each page.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

cross_region_configs

Array of CrossRegionSnapshotConfig objects

Cross-region configuration information.

count

Integer

Total number

Table 4 CrossRegionSnapshotConfig

Parameter

Type

Description

cluster_id

String

Cluster ID

cluster_name

String

Cluster name

source_region

String

Source region

source_project_id

String

Source project ID

destination_region

String

Destination region

destination_project_id

String

Destination project ID

status

Boolean

Status:

  • true: Enable
  • false: Disable

back_keep_day

Integer

Backup data storage period

total_size

Long

Total size

Example Request

GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/snapshots/cross-region-policies

Example Response

Status code: 200

The configurations of all cross-region snapshot are queried successfully.

{
  "cross_region_configs" : [ {
    "cluster_id" : "4aed8622-e99c-4b60-bd35-1ccde7c26ad0",
    "cluster_name" : "dwstest-821-100",
    "source_region" : null,
    "source_project_id" : null,
    "destination_region" : null,
    "destination_project_id" : null,
    "status" : null,
    "back_keep_day" : 3,
    "total_size" : null
  } ],
  "count" : 1
}

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

    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();
        ListSnapshotCrossRegionPolicyRequest request = new ListSnapshotCrossRegionPolicyRequest();
        request.withClusterId("<cluster_id>");
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        try {
            ListSnapshotCrossRegionPolicyResponse response = client.listSnapshotCrossRegionPolicy(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
# 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 = ListSnapshotCrossRegionPolicyRequest()
        request.cluster_id = "<cluster_id>"
        request.offset = <offset>
        request.limit = <limit>
        response = client.list_snapshot_cross_region_policy(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
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.ListSnapshotCrossRegionPolicyRequest{}
	clusterIdRequest:= "<cluster_id>"
	request.ClusterId = &clusterIdRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ListSnapshotCrossRegionPolicy(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 configurations of all cross-region snapshot are queried successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

500

Internal server error.

503

The service was unavailable.