# 查询集群拓扑ring环节点信息 - ListTopoRings #### 功能介绍 查询集群拓扑ring环节点信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dws/dws_02_0062.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dws/dws_02_0056.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dws:cluster:listRing | List | cluster \* | - g:ResourceTag/\ - g:EnterpriseProjectId | dws:ring:list | - | #### URI GET /v2/{project_id}/clusters/{cluster_id}/topo/rings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dws/dws_02_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | cluster_id | 是 | String | **参数解释**： 集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-dws/dws_02_00068.html)。 **约束限制**： 必须是有效的dws集群ID。 **取值范围**： 36位UUID。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 分页偏移量，从0开始，页数减1。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 分页单页大小。 **约束限制**： 不涉及。 **取值范围**： 大于0。 **默认取值**： 10 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cluster_rings | Array of [TopoRingInfo] objects | **参数解释**： 集群拓扑环列表信息。 **取值范围**： 不涉及。 | | count | Integer | **参数解释**： 集群环数量。 **取值范围**： 不涉及。 | 表4TopoRingInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_info_lists | Array of [TopoInstanceInfo] objects | **参数解释**： 集群实例列表信息。 **取值范围**： 不涉及。 | 表5TopoInstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 实例名称。 **取值范围**： 不涉及。 | | manage_ip | String | **参数解释**： 实例管理IP。 **取值范围**： 不涉及。 | | traffic_ip | String | **参数解释**： 业务IP。 **取值范围**： 不涉及。 | | internal_ip | String | **参数解释**： 内部通信IP。 **取值范围**： 不涉及。 | | internal_mgnt_ip | String | **参数解释**： 内部管理IP。 **取值范围**： 不涉及。 | | eip | String | **参数解释**： 公网IP信息。 **取值范围**： 不涉及。 | | elb | String | **参数解释**： elb地址。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 节点状态。 **取值范围**： - 100：创建中 - 200：可用 - 300：不可用 - 400：已删除 - 303：创建失败 | | az_code | String | **参数解释**： 可用区编码。 **取值范围**： 不涉及。 | #### 请求示例 查询集群拓扑ring环节点信息。 ``` GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/topo/rings ``` #### 响应示例 **状态码：200** ``` { "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代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dws.DwsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ListTopoRingsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListTopoRings(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ListTopoRings)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询集群拓扑环节点信息成功。 | | 400 | 请求错误。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 500 | 服务内部错误。 | | 503 | 服务不可用。 |