doc-exports/docs/dws/api-ref/ListClusterNodes.html

Querying the Node List

Function

This API is used to query the node list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/nodes

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
node_ids	No	Array of strings	Definition Node ID list. Constraints N/A Range N/A Default Value null
offset	No	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0
limit	No	Integer	Definition Number of items displayed on each page. Constraints N/A Range N/A Default Value 100
filter_by	No	String	Definition Search criteria. Constraints N/A Range instCreateType: The content is filtered by resource status. status: The content is filtered by node status. Default Value null
filter	No	String	Definition Content to be searched. Constraints N/A Range When the resource status is used as the search criteria, the values are as follows: ALL INST NODE ALL CREATING FREE ACTIVE FAILED UNKNOWN CREATE_FAILED DELETING DELETE_FAILED When the node status is used as the search criteria, the values are as follows: Default Value null
order_by	No	String	Definition Sorting field. By default, the results are not sorted. Constraints N/A Range name: filter by name Default Value null
order	No	String	Definition Sorting order (ascending or descending) Constraints N/A Range asc desc Default Value null
deleted	No	String	Definition Whether the node is deleted. This field has been deprecated. Constraints N/A Range N/A Default Value null

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter	Type	Description
node_list	Array of ClusterNodeInfo objects	Definition Cluster node list. Range N/A
count	Integer	Definition Total number of nodes in a cluster. Range An integer greater than 0
failed_count	Integer	Definition Total number of failed nodes in a logical cluster. Generally, the value is 0. Range An integer greater than or equal to 0

Table 4 ClusterNodeInfo

Parameter	Type	Description
id	String	Definition Node ID. Range N/A
name	String	Definition Node name. Range N/A
status	String	Definition Node status. Range N/A
sub_status	String	Definition Node sub-status. Range N/A
spec	String	Definition Node flavor. Range N/A
inst_create_type	String	Definition Instance creation type. Range INST: node in use NODE: idle node
alias_name	String	Definition Node alias. Range N/A
az_code	String	Definition AZ code. Range N/A

Example Requests

• Query the node list.

  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

Example Responses

Status code: 200

Cluster node information queried.

{
  "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" : "eu-de-01c"
  }, {
    "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" : "eu-de-01c"
  } ],
  "count" : 2,
  "failed_count" : 0
}

Status Codes

Status Code	Description
200	Cluster node information queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.

Parent topic: Node Change