Querying a Host List

Function

This API is used to query a host list of a specified cluster.

Constraints

None

Debugging

You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.

URI

Format
GET /v1.1/{project_id}/clusters/{cluster_id}/hosts

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Value range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default value N/A
cluster_id	Yes	String	Explanation Cluster ID If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details about how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
pageSize	No	Integer	Explanation Maximum number of clusters displayed on a page. Constraints N/A Value range 1-2147483646 Default value 10
currentPage	No	Integer	Explanation Current page number. Constraints N/A Value range N/A Default value N/A

Request Parameters

None

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Explanation Host parameters. Constraints N/A Value range N/A Default value N/A
hosts	Array of HostModel objects	Explanation Host parameters For details, see Table 4. Constraints N/A Value range N/A Default value N/A

**Table 4** HostModel
Parameter	Type	Description
id	String	Explanation VM ID. Constraints N/A Value range N/A Default value N/A
ip	String	Explanation VM IP address. Constraints N/A Value range N/A Default value N/A
availability_zone_id	String	Explanation Availability zone. Constraints N/A Value range N/A Default value N/A
tags	Array of TagPlain objects	Explanation The tag list. For details, see Table 5. Constraints N/A Value range N/A Default value N/A
flavor	String	Explanation VM specification ID. Constraints N/A Value range N/A Default value N/A
type	String	Explanation VM type. The value can be MasterNode, CoreNode, or TaskNode. Constraints N/A Value range N/A Default value N/A
name	String	Explanation VM name. Constraints N/A Value range N/A Default value N/A
status	String	Explanation Current VM state. Constraints N/A Value range N/A Default value N/A
resource_id	String	Explanation Node resource ID. Constraints N/A Value range N/A Default value N/A
mem	String	Explanation Memory. Constraints N/A Value range N/A Default value N/A
cpu	String	Explanation Number of CPU cores. Constraints N/A Value range N/A Default value N/A
root_volume_size	String	Explanation OS disk capacity. Constraints N/A Value range N/A Default value N/A
data_volume_type	String	Explanation Data disk type. Constraints N/A Value range N/A Default value N/A
data_volume_size	Integer	Explanation Data disk capacity. Constraints N/A Value range N/A Default value N/A
data_volume_count	Integer	Explanation Number of data disks. Constraints N/A Value range N/A Default value N/A
node_group_name	String	Explanation Node group name. Constraints N/A Value range N/A Default value N/A

**Table 5** TagPlain parameters
Parameter	Type	Description
key	String	Explanation Tag key. Constraints N/A Value range A tag key can contain letters, digits, spaces, and special characters _.:=+-@, but cannot start or end with a space or start with _sys_. Default value N/A
value	String	Explanation Tag value. Constraints N/A Value range The value can contain letters, digits, spaces, and special characters _.:=+-@, but cannot start or end with a space or start with _sys_. Default value N/A

Example Request

GET /v1.1/{project_id}/clusters/{cluster_id}/hosts

Example Response

Status code: 200

Querying the host list is successful.

{
  "total" : "5",
  "hosts" : [ {
    "id" : "063d1d47-ae91-4a48-840c-b3cfe4efbcf0",
    "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_IQhiC",
    "ip" : "192.168.0.169",
    "availability_zone_id" : null,
    "tags" : null,
    "status" : "ACTIVE",
    "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7",
    "flavor" : "c2.2xlarge.linux.mrs",
    "type" : "Core",
    "mem" : "16384",
    "cpu" : "8",
    "root_volume_size" : "480",
    "data_volume_type" : "SATA",
    "data_volume_size" : "600",
    "data_volume_count" : "1",
    "node_group_name" : "node_group_1"
  }, {
    "id" : "dc5c6208-faa2-4727-a65a-2b1ce235d350",
    "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_master1_ASzkl",
    "ip" : "192.168.0.156",
    "availability_zone_id" : null,
    "tags" : null,
    "status" : "ACTIVE",
    "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7",
    "flavor" : "c2.4xlarge.linux.mrs",
    "type" : "Master",
    "mem" : "32768",
    "cpu" : "16",
    "root_volume_size" : "480",
    "data_volume_type" : "SATA",
    "data_volume_size" : "600",
    "data_volume_count" : "1",
    "node_group_name" : "master_node_default_group"
  }, {
    "id" : "c0ce793d-848b-448a-835b-ea0cac534b09",
    "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_ANnRN",
    "ip" : "192.168.0.243",
    "availability_zone_id" : null,
    "tags" : null,
    "status" : "ACTIVE",
    "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7",
    "flavor" : "c2.2xlarge.linux.mrs",
    "type" : "Core",
    "mem" : "16384",
    "cpu" : "8",
    "root_volume_size" : "480",
    "data_volume_type" : "SATA",
    "data_volume_size" : "600",
    "data_volume_count" : "1",
    "node_group_name" : "node_group_1"
  }, {
    "id" : "95c23e43-ef6e-4732-b6ed-a5f1c7779fae",
    "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_core_uRRiA",
    "ip" : "192.168.0.126",
    "availability_zone_id" : null,
    "tags" : null,
    "status" : "ACTIVE",
    "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7",
    "flavor" : "c2.2xlarge.linux.mrs",
    "type" : "Core",
    "mem" : "16384",
    "cpu" : "8",
    "root_volume_size" : "480",
    "data_volume_type" : "SATA",
    "data_volume_size" : "600",
    "data_volume_count" : "1",
    "node_group_name" : "node_group_1"
  }, {
    "id" : "63bdbf75-1133-4a94-8c27-1fa12c8b9e70",
    "name" : "a78e161c-d14f-4b68-8c2d-0219920ce844_node_master2_StqFu",
    "ip" : "192.168.0.22",
    "availability_zone_id" : null,
    "tags" : null,
    "status" : "ACTIVE",
    "resource_id" : "95c1eabc-ed1d-4037-97d1-62f0587790c7",
    "flavor" : "c2.4xlarge.linux.mrs",
    "type" : "Master",
    "mem" : "32768",
    "cpu" : "16",
    "root_volume_size" : "480",
    "data_volume_type" : "SATA",
    "data_volume_size" : "600",
    "data_volume_count" : "1",
    "node_group_name" : "master_node_default_group"
  } ]
}