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
- Parameter description
Table 1 URI parameters Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
cluster_id
Yes
String
Cluster ID For details about how to obtain the value, see Obtaining the MRS Cluster Information.
Table 2 Query parameters Parameter
Mandatory
Type
Description
pageSize
No
Integer
Maximum number of clusters displayed on a page
Value range: [1–2147483646]. The default value is 10.
currentPage
No
Integer
Current page number The default value is 1.
Request Parameters
None
Response Parameters
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of hosts in a list |
hosts |
Array of HostModel objects |
Host parameters For details, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
VM ID |
ip |
String |
VM IP address |
availability_zone_id |
String |
The AZ. |
tags |
Array of TagPlain objects |
The tag list. For details, see Table 5. |
flavor |
String |
VM flavor ID |
type |
String |
VM type Currently, MasterNode, CoreNode, and TaskNode are supported. |
name |
String |
VM name |
status |
String |
Current VM state |
resource_id |
String |
Node resource ID |
mem |
String |
Memory |
cpu |
String |
Number of CPU cores |
root_volume_size |
String |
OS disk capacity |
data_volume_type |
String |
Data disk type |
data_volume_size |
Integer |
Data disk capacity |
data_volume_count |
Integer |
Number of data disks |
Parameter |
Type |
Description |
---|---|---|
key |
String |
The tag key. A tag key cannot contain special characters (=*<>\,|/) or start or end with spaces. |
value |
String |
The value. A tag value cannot contain special characters (=*<>\,|/) or start or end with spaces. |
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" }, { "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" }, { "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" }, { "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" }, { "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" } ] }
Status Codes
Table 6 describes the status code.
See Status Codes.
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