查询节点列表
功能介绍
查询节点列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/nodes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
cluster_id |
是 |
String |
参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
node_ids |
否 |
Array of strings |
参数解释: 节点ID列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
offset |
否 |
Integer |
参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 分页查询,每页显示的条目数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 100 |
filter_by |
否 |
String |
参数解释: 过滤字段。 约束限制: 不涉及。 取值范围: instCreateType:根据资源状态过滤 status:根据节点状态过滤 默认取值: null |
filter |
否 |
String |
参数解释: 过滤字段内容。 约束限制: 不涉及。 取值范围: 当根据资源状态过滤时,可选如下值:
当根据节点状态过滤时,可选如下值: 默认取值: null |
order_by |
否 |
String |
参数解释: 排序字段。默认无序返回。 约束限制: 不涉及。 取值范围: name:根据名称过滤 默认取值: null |
order |
否 |
String |
参数解释: 排序:升序/降序。 约束限制: 不涉及。 取值范围: asc:升序 desc:降序 默认取值: null |
deleted |
否 |
String |
参数解释: 是否被删除,字段已废弃。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: null |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
node_list |
Array of ClusterNodeInfo objects |
参数解释: 集群节点列表。 取值范围: 不涉及。 |
count |
Integer |
参数解释: 集群节点总数。 取值范围: 大于0的整数。 |
failed_count |
Integer |
参数解释: 逻辑集群节点失败总数。一般为0。 取值范围: 大于等于0的整数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 节点ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 节点名称。 取值范围: 不涉及。 |
status |
String |
参数解释: 节点状态。 取值范围: 不涉及。 |
sub_status |
String |
参数解释: 节点子状态。 取值范围: 不涉及。 |
spec |
String |
参数解释: 节点规格。 取值范围: 不涉及。 |
inst_create_type |
String |
参数解释: 实例创建类型。 取值范围:
|
alias_name |
String |
参数解释: 节点别名。 取值范围: 不涉及。 |
az_code |
String |
参数解释: 可用区编码。 取值范围: 不涉及。 |
请求示例
-
查询节点列表。
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes
-
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes?deleted=false&node_ids&offset=0&limit=10&filter_by=instCreateType&filter=INST
-
GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes?deleted=true&node_ids=0000b3c5-384a-4fa7-ab86-2c44dd97660a&offset=0&limit=10
响应示例
状态码:200
查询集群节点信息成功。
{ "node_list" : [ { "id" : "16413746-258e-4a3c-bea9-8496fdbefde3", "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-2-1", "status" : "ACTIVE", "sub_status" : "CREATED", "spec" : "dws2.kc1.2xlarge", "inst_create_type" : null, "alias_name" : null, "az_code" : "cn-north-4c" }, { "id" : "46d8754b-3ed3-4b92-85b5-7479ef5b10ac", "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-1-1", "status" : "ACTIVE", "sub_status" : "CREATED", "spec" : "dws2.kc1.2xlarge", "inst_create_type" : null, "alias_name" : null, "az_code" : "cn-north-4c" } ], "count" : 2, "failed_count" : 0 }
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 48 |
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 ListClusterNodesSolution { 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("<YOUR REGION>")) .build(); ListClusterNodesRequest request = new ListClusterNodesRequest(); request.withClusterId("{cluster_id}"); try { ListClusterNodesResponse response = client.listClusterNodes(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 32 |
# 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("<YOUR REGION>")) \ .build() try: request = ListClusterNodesRequest() request.cluster_id = "{cluster_id}" response = client.list_cluster_nodes(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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListClusterNodesRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListClusterNodes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询集群节点信息成功。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |