Querying the Host Overview

Function

This API is used to query the host overview.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/host-overview

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cluster_id	No	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
instance_name	No	String	Definition Instance name. Constraints N/A Range N/A Default Value N/A
limit	Yes	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value No limit.
offset	Yes	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

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of HostOverviewResponse objects	Definition Response for querying the host overview. Range N/A

**Table 4** HostOverviewResponse
Parameter	Type	Description
instance_name	String	Definition Instance name. Range N/A
host_name	String	Definition Host name. Range N/A
host_stat	String	Definition Host status. Range N/A
work_ip	String	Definition IP address. Range N/A
mem_free	Double	Definition Unused memory in the system, in GB. Range N/A
mem_total	Double	Definition Total memory, in GB. Range N/A
mem_usage	Double	Definition Memory usage, in GB. Range N/A
mem_cached	Double	Definition Cache memory, in GB. Range N/A
mem_buffer	Double	Definition Buffer memory, in MB. Range N/A
swap_free	Double	Definition Size of the RAM memory temporarily stored in the swap file, in GB. Range N/A
swap_total	Double	Definition Total swap space, in GB. Range N/A
cpu_usage	Double	Definition CPU usage (%). Range N/A
cpu_usage_sys	Double	Definition System CPU usage (%). Range N/A
cpu_usage_usr	Double	Definition User CPU usage (%). Range N/A
cpu_idle	Double	Definition Idle CPU usage (%). Range N/A
cpu_iowait	Double	Definition I/O wait (%). Range N/A
disk_usage_avg	Double	Definition Average disk usage (%). Range N/A
disk_total	Double	Definition Total disk capacity, in GB. Range N/A
disk_used	Double	Definition Used disk capacity (GB). Range N/A
disk_available	Double	Definition Available disk capacity, in GB. Range N/A
disk_io	Double	Definition Disk I/O (KB/s). Range N/A
disk_io_read	Double	Definition Disk read rate (KB/s). Range N/A
disk_io_write	Double	Definition Disk write rate (KB/s). Range N/A
tcp_resend_rate	Double	Definition TCP protocol stack retransmission rate (%). Range N/A
net_io	Double	Definition Network I/O, in KB/s. Range N/A

Status code: 204

Empty query result.

Example Requests

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/host-overview?limit=1&offset=0

Example Responses

Status code: 200

Host overview queried.

[ {
  "instance_name" : "dms-test07-dws-cn-cn-1-1",
  "host_name" : "host-172-16-11-62",
  "host_stat" : "ONLINE",
  "work_ip" : "172.16.106.168",
  "mem_free" : 1.45,
  "mem_total" : 14.89,
  "mem_usage" : 26.4,
  "mem_cached" : 9.26,
  "mem_buffer" : 249.34,
  "swap_free" : 0,
  "swap_total" : 0,
  "cpu_usage" : 8.93,
  "cpu_usage_sys" : 3.37,
  "cpu_usage_usr" : 5.56,
  "cpu_idle" : 90.57,
  "cpu_iowait" : 0.12,
  "disk_usage_avg" : 4.44,
  "disk_total" : 548.76,
  "disk_used" : 24.38,
  "disk_available" : 522,
  "disk_io" : 19.75,
  "disk_io_read" : 0,
  "disk_io_write" : 19.75,
  "tcp_resend_rate" : 0,
  "net_io" : 0
} ]

Status Codes

Status Code	Description
200	Host overview queried.
204	Empty query result.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.