查询主机概览
功能介绍
查询主机概览。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/dms/host-overview
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cluster_id |
否 |
String |
参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
instance_name |
否 |
String |
参数解释: 实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
limit |
是 |
Integer |
参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 不限制。 |
offset |
是 |
Integer |
参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of HostOverviewResponse objects |
参数解释: 查询主机概览响应。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
instance_name |
String |
参数解释: 实例名称。 取值范围: 不涉及。 |
host_name |
String |
参数解释: 主机名称。 取值范围: 不涉及。 |
host_stat |
String |
参数解释: 主机状态。 取值范围: 不涉及。 |
work_ip |
String |
参数解释: IP地址。 取值范围: 不涉及。 |
mem_free |
Double |
参数解释: 系统中未使用的内存(GB)。 取值范围: 不涉及。 |
mem_total |
Double |
参数解释: 总内存(GB)。 取值范围: 不涉及。 |
mem_usage |
Double |
参数解释: 内存使用率(GB)。 取值范围: 不涉及。 |
mem_cached |
Double |
参数解释: 缓存内存(GB)。 取值范围: 不涉及。 |
mem_buffer |
Double |
参数解释: 缓冲内存(MB)。 取值范围: 不涉及。 |
swap_free |
Double |
参数解释: ram暂存在swap中的大小(GB)。 取值范围: 不涉及。 |
swap_total |
Double |
参数解释: 交换空间总和(GB)。 取值范围: 不涉及。 |
cpu_usage |
Double |
参数解释: CPU使用率(%)。 取值范围: 不涉及。 |
cpu_usage_sys |
Double |
参数解释: 系统CPU占用率(%)。 取值范围: 不涉及。 |
cpu_usage_usr |
Double |
参数解释: 用户CPU占用率(%)。 取值范围: 不涉及。 |
cpu_idle |
Double |
参数解释: 空闲CPU占用率(%)。 取值范围: 不涉及。 |
cpu_iowait |
Double |
参数解释: IO等待(%)。 取值范围: 不涉及。 |
disk_usage_avg |
Double |
参数解释: 磁盘平均使用率(%)。 取值范围: 不涉及。 |
disk_total |
Double |
参数解释: 磁盘总容量(GB)。 取值范围: 不涉及。 |
disk_used |
Double |
参数解释: 磁盘使用容量(GB)。 取值范围: 不涉及。 |
disk_available |
Double |
参数解释: 磁盘可用容量(GB)。 取值范围: 不涉及。 |
disk_io |
Double |
参数解释: 磁盘IO(KB/s)。 取值范围: 不涉及。 |
disk_io_read |
Double |
参数解释: 磁盘读速率(KB/s)。 取值范围: 不涉及。 |
disk_io_write |
Double |
参数解释: 磁盘写速率(KB/s)。 取值范围: 不涉及。 |
tcp_resend_rate |
Double |
参数解释: TCP协议栈重传率(%)。 取值范围: 不涉及。 |
net_io |
Double |
参数解释: 网络IO(KB/s)。 取值范围: 不涉及。 |
状态码:204
查询结果为空。
请求示例
https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/host-overview?limit=1&offset=0
响应示例
状态码:200
查询主机概览成功。
[ { "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 } ]
状态码
状态码 |
描述 |
---|---|
200 |
查询主机概览成功。 |
204 |
查询结果为空。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |