Querying Instance Nodes in Batches
Function
This API is used to query the node information, number of valid instances, and number of nodes of all instances in a specified project.
No node information will be returned when the instance is being created.
Available for Redis 4.0 and later instances.
Constraints
Available for Redis 4.0 and later instances.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/instances-logical-nodes
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: N/A. Value range: N/A. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Parameter description: Offset where the query starts. Constraints: N/A. Value range: ≥ 0 Default value: 0 |
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A. Value range: 1–100 Default value: 10 |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Parameter description: Total number of instances in the query result. Value range: N/A. |
instances |
Array of InstanceNodesInfoResp objects |
Parameter description: Instance list. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
instance_id |
String |
Parameter description: Instance ID. Value range: N/A. |
node_count |
Integer |
Parameter description: Total number of nodes of the current instance. Value range: N/A. |
nodes |
Array of NodesInfoResp objects |
Parameter description: Node details. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
logical_node_id |
String |
Parameter description: Logical node ID. Value range: N/A. |
name |
String |
Parameter description: Node name. Value range: N/A. |
status |
String |
Parameter description: Node status. Value range:
|
az_code |
String |
Parameter description: AZ code. Value range: N/A. |
node_role |
String |
Parameter description: Node role. Value range:
|
node_type |
String |
Parameter description: Node master/standby role. Value range:
|
node_ip |
String |
Parameter description: Node IP. Value range: N/A. |
node_port |
String |
Parameter description: Node port. Value range: N/A. |
node_id |
String |
Parameter description: Node ID. Value range: N/A. |
priority_weight |
Integer |
Parameter description: Replica promotion priority. Value range: Priority ranges from 0 to 100 in descending order. 0 indicates that the replica will never be automatically promoted, 1 indicates the highest priority, and 100 indicates the lowest priority. |
is_access |
Boolean |
Parameter description: Whether the IP address of the node can be directly accessed. Value range:
|
group_id |
String |
Parameter description: Instance shard ID. Value range: N/A. |
group_name |
String |
Parameter description: Instance shard name. Value range: N/A. |
is_remove_ip |
Boolean |
Parameter description: Whether the IP address is removed from the read-only domain name. Value range:
|
replication_id |
String |
Parameter description: Instance replica ID. Value range: N/A. |
dimensions |
Array of InstanceReplicationDimensionsInfo objects |
Parameter description: Monitoring metric dimension of the replica used to call the Cloud Eye API for querying monitoring metrics.
Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Parameter description: Monitoring dimension name. Value range:
|
value |
String |
Parameter description: Dimension value. Value range: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A. |
error_code |
String |
Parameter description: Error code. Value range: For details, see Error Codes. |
error_ext_msg |
String |
Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
GET https://{dcs_endpoint}/v2/{project_id}/instances-logical-nodes?offset={offset}&limit={limit}
Example Responses
Status code: 200
Node information queried successfully.
{ "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" } ] } ] } ] }
Status code: 500
Internal service error.
{ "error_code" : "DCS.5000", "error_msg" : "Internal service error." }
Status code: 400
Invalid request.
{ "error_code" : "DCS.4800", "error_msg" : "Invalid offset in the request." }
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 |
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("<YOUR REGION>")) .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()); } } } |
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 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("<YOUR REGION>")) \ .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) |
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchShowNodesInformationRequest{} response, err := client.BatchShowNodesInformation(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 |
Node information queried successfully. |
500 |
Internal service error. |
400 |
Invalid request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot