文档首页> 数据仓库服务 GaussDB(DWS)> API参考> API说明> 集群管理> 查询集群拓扑ring环节点信息
更新时间:2024-03-26 GMT+08:00
分享

查询集群拓扑ring环节点信息

功能介绍

该接口用于查询集群拓扑ring环节点信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/clusters/{cluster_id}/topo/rings
表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法,请参见获取项目ID

cluster_id

String

集群ID。获取方法,请参见获取集群ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页查询,偏移。

limit

Integer

分页查询,每页显示的条目数量。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

cluster_rings

Array of TopoRingInfo objects

集群拓扑环列表信息。

count

Integer

集群环数量。

表4 TopoRingInfo

参数

参数类型

描述

instance_info_lists

Array of TopoInstanceInfo objects

集群实例列表信息。

表5 TopoInstanceInfo

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

manage_ip

String

实例管理IP。

traffic_ip

String

业务IP。

internal_ip

String

内部通信IP。

internal_mgnt_ip

String

内部管理IP。

eip

String

EIP。

elb

String

ELB地址。

status

String

实例状态,有效值包括:

  • 100:创建中。
  • 200:可用 。
  • 300:不可用 。
  • 303:创建失败 。
  • 304:删除中 。
  • 302:删除失败 。
  • 400:已删除 。
  • 910:停止中 。
  • 900:已停止 。
  • 920:启动中 。
  • 800:已冻结。

az_code

String

可用区编码。

请求示例

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

响应示例

状态码: 200

查询集群拓扑ring环节点信息成功。

{
  "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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询集群拓扑ring环节点信息成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

分享:

    相关文档

    相关产品