# 批量查询实例节点信息 - BatchShowNodesInformation #### 功能介绍 批量查询指定项目所有实例的节点信息、有效实例个数及节点个数。 创建中实例不返回节点信息。 支持Redis4.0及以上版本实例查询。 #### 接口约束 支持Redis4.0及以上版本实例查询。 #### 调用方法 请参见[如何调用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:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/instances-logical-nodes 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | **参数解释**： 偏移量，表示生成的列表从此偏移量开始显示，例如偏移量为3时，生成的列表从第4条开始。 **约束限制**： 不涉及。 **取值范围**： 大于等于0。 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 每页显示的条目数量。 **约束限制**： 不涉及。 **取值范围**： 1-100 **默认取值**： 10 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | **参数解释**： 查询结果的实例总数。 **取值范围**： 不涉及。 | | instances | Array of [InstanceNodesInfoResp] objects | **参数解释**： 实例列表。 **取值范围**： 不涉及。 | 表4InstanceNodesInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instance_id | String | **参数解释**： 实例ID。 **取值范围**： 不涉及。 | | node_count | Integer | **参数解释**： 当前实例节点总数。 **取值范围**： 不涉及。 | | nodes | Array of [NodesInfoResp] objects | **参数解释**： 节点详情。 **取值范围**： 不涉及。 | 表5NodesInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | logical_node_id | String | **参数解释**： 逻辑节点ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 节点名称。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 节点状态。 **取值范围**： - Creating：创建中。 - Active：运行中。 - Inactive：故障。 - Deleting：删除中。 - AddSharding：添加分片中。 | | az_code | String | **参数解释**： 可用区code。 **取值范围**： 不涉及。 | | node_role | String | **参数解释**： 节点角色。 **取值范围**： - redis-server：Redis server节点。 - redis-proxy：proxy节点。 | | node_type | String | **参数解释**： 节点主从角色。 **取值范围**： - master：主节点。 - slave：从节点。 - proxy：proxy实例节点角色为"proxy"。 | | node_ip | String | **参数解释**： 节点的IP。 **取值范围**： 不涉及。 | | node_port | String | **参数解释**： 节点的端口。 **取值范围**： 不涉及。 | | node_id | String | **参数解释**： 节点ID。 **取值范围**： 不涉及。 | | priority_weight | Integer | **参数解释**： 节点主备切换优先级权重。 **取值范围**： 0-100（1-100优先级逐步降低，1为最高，100为最低，0为禁止倒换）。 | | is_access | Boolean | **参数解释**： 节点的IP是否可直接访问。 **取值范围**： - true - false | | group_id | String | **参数解释**： 实例分片ID。 **取值范围**： 不涉及。 | | group_name | String | **参数解释**： 实例分片名称。 **取值范围**： 不涉及。 | | is_remove_ip | Boolean | **参数解释**： 是否从只读域名中摘除IP。 **取值范围**： - true - false | | replication_id | String | **参数解释**： 实例副本ID。 **取值范围**： 不涉及。 | | dimensions | Array of [InstanceReplicationDimensionsInfo] objects | **参数解释**： 副本对应的监控指标维度信息。可用于调用云监控服务的查询监控数据指标相关接口。 - 副本的监控维度为多维度，返回数组中包含两个维度信息。从云监控查询监控数据时，要按多维度传递指标维度参数，才能查询到监控指标值。 - 第一个维度为副本父维度信息。 维度名称为dcs_instance_id，维度值对应副本所在的实例ID。 - 第二个维度，维度名称为dcs_cluster_redis_node，维度值为副本的监控对象ID，与副本ID和节点ID不同。 **取值范围**： 不涉及。 | 表6InstanceReplicationDimensionsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 监控维度名称。 **取值范围**： - dcs_instance_id： 实例维度。 - dcs_cluster_redis_node：数据节点维度。 | | value | String | **参数解释**： 维度取值。 **取值范围**： 不涉及。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。 | | error_ext_msg | String | **参数解释**： 扩展错误信息（暂未使用，不返回）。 **取值范围**： 不涉及。 | **状态码：400** 表8响应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-logical-nodes?offset={offset}&limit={limit} ``` #### 响应示例 **状态码：200** 查询节点信息成功。 ``` { "count" : 1, "instances" : [ { "instance_id" : "b4468cb1-4f75-4866-a49d-86959acc0c9c", "node_count" : 2, "nodes" : [ { "logical_node_id" : "8f997eb512a92834bf5914be52ca8919", "name" : "(replica)192.168.0.178", "status" : "Active", "az_code" : "region01", "node_role" : "redis-server", "node_type" : "slave", "node_ip" : "192.168.0.178", "node_port" : "6379", "node_id" : "8a2c26c17f4d6516017f4d7b77940030", "is_access" : true, "group_id" : "ace962d1-7841-4e50-9313-c239fd75dee3", "group_name" : "group-0", "priority_weight" : 100, "is_remove_ip" : false, "replication_id" : "e40aa09e-03c2-4319-86eb-5ef4ca637544", "dimensions" : [ { "name" : "dcs_instance_id", "value" : "caf2d19f-7783-44b0-be46-8c9da3ef1e94" }, { "name" : "dcs_cluster_redis_node", "value" : "8263dc69629c5b2d840e9816fa9c6200" } ] } ] } ] } ``` **状态码：500** 内部服务错误。 ``` { "error_code" : "DCS.5000", "error_msg" : "Internal service error." } ``` **状态码：400** 非法请求。 ``` { "error_code" : "DCS.4800", "error_msg" : "Invalid offset 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 BatchShowNodesInformationSolution { 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(); BatchShowNodesInformationRequest request = new BatchShowNodesInformationRequest(); try { BatchShowNodesInformationResponse response = client.batchShowNodesInformation(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 = BatchShowNodesInformationRequest() response = client.batch_show_nodes_information(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.BatchShowNodesInformationRequest{} response, err := client.BatchShowNodesInformation(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=BatchShowNodesInformation&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询节点信息成功。 | | 500 | 内部服务错误。 | | 400 | 非法请求。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。