# 查询集群实例拓扑关系图 - ShowInstanceTopology #### 功能介绍 查询集群实例拓扑关系图。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:get | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v2/{project_id}/instances/{instance_id}/nodes 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释**： 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start | 否 | Integer | **参数解释**： 偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 每页显示条数。 **约束限制**： 不涉及。 **取值范围**： 1\~1000 **默认取值**： 10 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | redis_server | Array of [TopologyInfo] objects | **参数解释**： 集群角色：redis-server实例拓扑图。 | | cluster_lvs | Array of [TopologyInfo] objects | **参数解释**： 集群角色：lvs实例拓扑图（当前已下线），只适用于Redis 3.0版本实例。 | | cluster_admin | Array of [TopologyInfo] objects | **参数解释**： 集群角色：admin实例拓扑图（当前已下线），只适用于Redis 3.0版本实例。 | | cluster_proxy | Array of [TopologyInfo] objects | **参数解释**： 集群角色：proxy实例拓扑图。 | | master | Array of [TopologyInfo] objects | **参数解释**： Redis的角色master实例拓扑图，只适用于Redis 3.0版本实例。 | | vpcendpoint | Array of [TopologyInfo] objects | **参数解释**： 集群角色：VPC Endpoint服务实例拓扑图，适用于4.0及以上版本实例。 | | elb | Array of [TopologyInfo] objects | **参数解释**： 集群角色：ELB服务实例拓扑图，适用于Redis 4.0及以上版本实例。 | 表4TopologyInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_id | String | **参数解释**： 节点ID。 **取值范围**： 不涉及。 | | node_name | String | **参数解释**： 节点名称。 **取值范围**： 不涉及。 | | ip | String | **参数解释**： 节点IP。 **取值范围**： 不涉及。 | | port | String | **参数解释**： 节点端口。 **取值范围**： 不涉及。 | | node_type | String | **参数解释**： 节点主从角色。 **取值范围**： master：主节点 slave：从节点 proxy：proxy节点 vpcendpoint：VPC Endpoint节点 elb：ELB节点 | | max_memory | String | **参数解释**： 总内存，单位：MB。 **取值范围**： 不涉及。 | | used_memory | String | **参数解释**： 已使用的内存，单位：MB。 **取值范围**： 不涉及。 | | qps | String | **参数解释**： 每秒查询率。 **取值范围**： 不涉及。 | | bandwidth | [BandWidth] object | **参数解释**： 带宽信息。 | | db_num | String | **参数解释**： 该实例的DB数量。 **取值范围**： 不涉及。 | | dbs | [KeySpace] object | **参数解释**： 键信息。 | | relation_ip | String | **参数解释**： 关联IP。 **取值范围**： 不涉及。 | | relation_port | String | **参数解释**： 关联端口。 **取值范围**： 不涉及。 | | group_id | String | **参数解释**： 分片ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 节点状态。 **取值范围**： 不涉及。 | | dims | [DimsInfo] object | **参数解释**： description: CES监控维护信息。 | 表5BandWidth | 参数 | 参数类型 | 描述 | |:---|:---|:---| | input | String | **参数解释**： 上行带宽，单位kbit/s。 **取值范围**： 不涉及。 | | output | String | **参数解释**： 下行带宽，单位kbit/s。 **取值范围**： 不涉及。 | 表6KeySpace | 参数 | 参数类型 | 描述 | |:---|:---|:---| | db_idx | String | **参数解释**： db索引值。 **取值范围**： 不涉及。 | | keys | String | **参数解释**： 节点键数量。 **取值范围**： 不涉及。 | | expires | String | **参数解释**： 节点过期键数量。 **取值范围**： 不涉及。 | | avg_ttl | String | **参数解释**： 节点键的平均过期时间。 **取值范围**： 不涉及。 | 表7DimsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dim_k | String | **参数解释**： CES监控维度路由。 **取值范围**： 不涉及。 | | dim_v | String | **参数解释**： CES监控维度ID。 **取值范围**： 不涉及。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | #### 请求示例 ``` GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/nodes ``` #### 响应示例 **状态码：200** 查询实例拓扑成功。 ``` { "cluster_proxy" : [ { "node_id" : "ff80808188b4aeb60188b4b234ea0144", "node_name" : "dcs-bare-vm-x86-cn-north-7c-1657002433-0", "ip" : "192.168.60.32", "port" : "2892", "node_type" : "proxy", "max_memory" : null, "used_memory" : null, "qps" : null, "bandwidth" : null, "db_num" : null, "dbs" : null, "relation_ip" : null, "relation_port" : null, "group_id" : null, "status" : "Active", "dims" : { "dim_k" : "dcs_instance_id", "dim_v" : "3b76eb20-70cd-4083-be96-266a29de6e52" } }, { "node_id" : "ff80808188b4aeb60188b4b234ea0143", "node_name" : "dcs-bare-vm-x86-cn-north-7c-1684760402-1", "ip" : "192.168.5.105", "port" : "3048", "node_type" : "proxy", "max_memory" : null, "used_memory" : null, "qps" : null, "bandwidth" : null, "db_num" : null, "dbs" : null, "relation_ip" : null, "relation_port" : null, "group_id" : null, "status" : "Active", "dims" : { "dim_k" : "dcs_instance_id", "dim_v" : "3b76eb20-70cd-4083-be96-266a29de6e52" } }, { "node_id" : "ff80808188b4aeb60188b4b234ea0145", "node_name" : "dcs-bare-vm-x86-cn-north-7c-1660116188-2", "ip" : "192.168.53.35", "port" : "3834", "node_type" : "proxy", "max_memory" : null, "used_memory" : null, "qps" : null, "bandwidth" : null, "db_num" : null, "dbs" : null, "relation_ip" : null, "relation_port" : null, "group_id" : null, "status" : "Active", "dims" : { "dim_k" : "dcs_instance_id", "dim_v" : "3b76eb20-70cd-4083-be96-266a29de6e52" } } ], "vpcendpoint" : [ { "node_id" : "e50c0fda-1870-4bbc-ba4c-ace69504e305", "node_name" : "", "ip" : "192.168.74.33", "port" : "6379", "node_type" : "vpcendpoint", "max_memory" : null, "used_memory" : null, "qps" : null, "bandwidth" : null, "db_num" : null, "dbs" : null, "relation_ip" : null, "relation_port" : null, "group_id" : null, "status" : "Active", "dims" : null } ], "elb" : [ { "node_id" : "af04b606-241e-4099-8ae2-194e2b61ef63", "node_name" : "", "ip" : "192.168.20.137", "port" : "6379", "node_type" : "elb", "max_memory" : null, "used_memory" : null, "qps" : null, "bandwidth" : null, "db_num" : null, "dbs" : null, "relation_ip" : null, "relation_port" : null, "group_id" : null, "status" : "Active", "dims" : null } ], "redis_server" : [ { "node_id" : "ff80808188b4aeb60188b4b234e4013d", "node_name" : "dcs-bare-vm-x86-cn-north-7c-1684823334-0", "ip" : "192.168.22.138", "port" : "2076", "node_type" : "master", "max_memory" : "1365", "used_memory" : "3", "qps" : "4", "bandwidth" : { "input" : "0.10", "output" : "0.30" }, "db_num" : "0", "dbs" : { "db_idx" : "0", "keys" : "0", "expires" : "0", "avg_ttl" : "0" }, "relation_ip" : "192.168.60.32", "relation_port" : "2984", "group_id" : null, "status" : "Active", "dims" : { "dim_k" : "dcs_instance_id", "dim_v" : "3b76eb20-70cd-4083-be96-266a29de6e52" } }, { "node_id" : "ff80808188b4aeb60188b4b234ea0141", "node_name" : "dcs-bare-vm-x86-cn-north-7c-1657800431-0", "ip" : "192.168.33.181", "port" : "3694", "node_type" : "master", "max_memory" : "1365", "used_memory" : "3", "qps" : "8", "bandwidth" : { "input" : "0.20", "output" : "3.31" }, "db_num" : "0", "dbs" : { "db_idx" : "0", "keys" : "0", "expires" : "0", "avg_ttl" : "0" }, "relation_ip" : "192.168.46.161", "relation_port" : "3600", "group_id" : null, "status" : "Active", "dims" : { "dim_k" : "dcs_instance_id", "dim_v" : "3b76eb20-70cd-4083-be96-266a29de6e52" } }, { "node_id" : "ff80808188b4aeb60188b4b234ea013f", "node_name" : "dcs-bare-vm-x86-cn-north-7c-1657002433-0", "ip" : "192.168.60.32", "port" : "2476", "node_type" : "master", "max_memory" : "1365", "used_memory" : "3", "qps" : "3", "bandwidth" : { "input" : "0.12", "output" : "2.30" }, "db_num" : "0", "dbs" : { "db_idx" : "0", "keys" : "0", "expires" : "0", "avg_ttl" : "0" }, "relation_ip" : "192.168.53.35", "relation_port" : "3704", "group_id" : null, "status" : "Active", "dims" : { "dim_k" : "dcs_instance_id", "dim_v" : "3b76eb20-70cd-4083-be96-266a29de6e52" } } ] } ``` **状态码：400** 非法请求。 ``` { "error_code" : "111400063", "error_msg" : "Invalid {0} parameter in the request." } ``` #### 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.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; public class ShowInstanceTopologySolution { 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); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("")) .build(); ShowInstanceTopologyRequest request = new ShowInstanceTopologyRequest(); request.withInstanceId("{instance_id}"); try { ShowInstanceTopologyResponse response = client.showInstanceTopology(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 huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.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 = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("")) \ .build() try: request = ShowInstanceTopologyRequest() request.instance_id = "{instance_id}" response = client.show_instance_topology(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" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/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 := dcs.DcsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dcs.NewDcsClient(hcClient) request := &model.ShowInstanceTopologyRequest{} request.InstanceId = "{instance_id}" response, err := client.ShowInstanceTopology(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DCS/sdk?api=ShowInstanceTopology&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询实例拓扑成功。 | | 400 | 非法请求。 | | 401 | 认证信息非法。 | | 403 | 请求被拒绝访问。 | | 404 | 所请求的资源不存在。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。