查询主机概览
功能介绍
该接口用于查询主机监控概览信息。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/dms/host-overview
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法,请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cluster_id |
否 |
String |
集群ID。获取方法,请参见获取集群ID。 |
instance_name |
否 |
String |
实例名称。 |
limit |
是 |
Integer |
数据条目数。取值范围为1~2147483647。 |
offset |
是 |
Integer |
数据偏移量。取值范围为0~2147483646。 |
请求参数
无
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
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)。 |
请求示例
https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/host-overview?limit=1&offset=0
响应示例
状态码:200
查询主机概览成功。
[ { "instance_name": "d30035376-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 } ]
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class ListHostOverviewSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); ListHostOverviewRequest request = new ListHostOverviewRequest(); request.withClusterId("<cluster_id>"); request.withInstanceName("<instance_name>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListHostOverviewResponse response = client.listHostOverview(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListHostOverviewRequest() request.cluster_id = "<cluster_id>" request.instance_name = "<instance_name>" request.limit = <limit> request.offset = <offset> response = client.list_host_overview(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dws.NewDwsClient( dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListHostOverviewRequest{} clusterIdRequest:= "<cluster_id>" request.ClusterId = &clusterIdRequest instanceNameRequest:= "<instance_name>" request.InstanceName = &instanceNameRequest request.Limit = int32(<limit>) request.Offset = int32(<offset>) response, err := client.ListHostOverview(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询主机概览成功。 |
204 |
处理成功,但没有返回任何内容。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |