Help Center/ Data Warehouse Service/ API Reference/ API Description/ Cluster Management/ Querying Ring Node Information in the Cluster Topology
Updated on 2026-06-22 GMT+08:00

Querying Ring Node Information in the Cluster Topology

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/topo/rings

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

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

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Page offset, which starts from 0 (page number minus 1).

Constraints

N/A

Range

Greater than or equal to 0

Default Value

0

limit

No

Integer

Definition

Size of a single page.

Constraints

N/A

Range

Greater than 0

Default Value

10

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

cluster_rings

Array of TopoRingInfo objects

Definition

Cluster topology ring list.

Range

N/A

count

Integer

Definition

Number of cluster rings.

Range

N/A

Table 4 TopoRingInfo

Parameter

Type

Description

instance_info_lists

Array of TopoInstanceInfo objects

Definition

Cluster instance list.

Range

N/A

Table 5 TopoInstanceInfo

Parameter

Type

Description

id

String

Definition

Instance ID.

Range

N/A

name

String

Definition

Instance name.

Range

N/A

manage_ip

String

Definition

Instance management IP address.

Range

N/A

traffic_ip

String

Definition

Service IP address.

Range

N/A

internal_ip

String

Definition

Internal communication IP address.

Range

N/A

internal_mgnt_ip

String

Definition

Internal management IP address.

Range

N/A

eip

String

Definition

Public IP address information.

Range

N/A

elb

String

Definition

ELB address.

Range

N/A

status

String

Definition

Instance status.

Range

N/A

az_code

String

Definition

AZ code.

Range

N/A

Example Requests

Query ring node information in the cluster topology.

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

Example Responses

Status code: 200

Ring node information of the cluster topology 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 SDK 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 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");
        String projectId = "{project_id}";

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListTopoRingsRequest request = new ListTopoRingsRequest();
        request.withClusterId("{cluster_id}");
        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
32
# coding: utf-8

import os
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.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListTopoRingsRequest()
        request.cluster_id = "{cluster_id}"
        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
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")
    projectId := "{project_id}"

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

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListTopoRingsRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListTopoRings(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Ring node information of the cluster topology 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.