Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Cluster Management/ Querying Information About Ring Nodes in a Cluster Topology
Updated on 2024-04-18 GMT+08:00

Querying Information About Ring Nodes in a Cluster Topology

Function

This API is used to query ring node information in a cluster topology.

Call Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/topo/rings
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.

cluster_id

Yes

String

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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset for the pagination query

limit

No

Integer

Number of records displayed on each page of the pagination query

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

cluster_rings

Array of TopoRingInfo objects

List of rings in the cluster topology

count

Integer

Number of cluster rings

Table 4 TopoRingInfo

Parameter

Type

Description

instance_info_lists

Array of TopoInstanceInfo objects

List of cluster instances

Table 5 TopoInstanceInfo

Parameter

Type

Description

id

String

Instance ID

name

String

Instance name

manage_ip

String

Instance management IP address

traffic_ip

String

Service IP address

internal_ip

String

Internal communication IP address

internal_mgnt_ip

String

Internal management IP address

eip

String

EIP

elb

String

ELB address.

status

String

Instance status. Valid values are as follows:

  • 100: Creating.
  • 200: Available.
  • 300: Unavailable
  • 303: Creation failed
  • 304: Deleting
  • 302: Deletion failed.
  • 400: Deleted
  • 910: being stopped.
  • 900: stopped.
  • 920: indicates that a graph is being started.
  • 800: indicates that a graph is frozen.

az_code

String

AZ code

Example Request

GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/logical-clusters/rings

Example Response

Status code: 200

The ring node information of the cluster topology is queried.

{
  "cluster_rings" : [ {
    "instance_info_lists" : [ {
      "id" : "a57e49db-c04b-45c7-9863-f7b6f3eed1b8",
      "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-1-1",
      "manage_ip" : "172.16.26.233",
      "traffic_ip" : "192.168.0.217",
      "internal_ip" : "172.16.66.153",
      "internal_mgnt_ip" : null,
      "eip" : null,
      "elb" : null,
      "status" : 200,
      "az_code" : "cn-north-4c"
    }, {
      "id" : "3a37f794-be37-42d1-a299-a3eb94888ccb",
      "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-2-1",
      "manage_ip" : "172.16.34.21",
      "traffic_ip" : "192.168.0.80",
      "internal_ip" : "172.16.65.89",
      "internal_mgnt_ip" : null,
      "eip" : null,
      "elb" : null,
      "status" : 200,
      "az_code" : "cn-north-4c"
    }, {
      "id" : "8763cbf1-5851-44a5-9e71-cbae35201f27",
      "name" : "ty-default--BGy6PUIN-K-dws-dn-1-1",
      "manage_ip" : "172.16.9.16",
      "traffic_ip" : "192.168.0.88",
      "internal_ip" : "172.16.67.64",
      "internal_mgnt_ip" : null,
      "eip" : null,
      "elb" : null,
      "status" : 200,
      "az_code" : "cn-north-4c"
    } ]
  } ],
  "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
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 ListTopoRingsSolution {

    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("<YOUR REGION>"))
                .build();
        ListTopoRingsRequest request = new ListTopoRingsRequest();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        try {
            ListTopoRingsResponse response = client.listTopoRings(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
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ListTopoRingsRequest()
        request.offset = <offset>
        request.limit = <limit>
        response = client.list_topo_rings(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
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("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTopoRingsRequest{}
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ListTopoRings(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 ring node information of the cluster topology is queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.