Querying the Host Overview
Function
This API is used to query the host monitoring overview.
Call Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/dms/host-overview
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the ID, see Obtaining Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cluster_id |
No |
String |
Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID. |
instance_name |
No |
String |
Instance name. |
limit |
Yes |
Integer |
Number of data records. The value ranges from 1 to 2147483647. |
offset |
Yes |
Integer |
Data offset. Value range: 0 to 2147483646. |
Request Parameters
None
Response Parameters
Parameter |
Type |
Description |
---|---|---|
[Array] |
Array of HostOverviewResponse objects |
Host overview list |
Parameter |
Type |
Description |
---|---|---|
instance_name |
String |
Instance name |
host_name |
String |
Host name. |
host_stat |
String |
Host status. The options are as follows:
|
work_ip |
String |
IP address |
mem_free |
double |
Unused memory in the system, in GB. |
mem_total |
double |
Total memory(GB) |
mem_usage |
double |
Memory usage (GB) |
mem_cached |
double |
Cache memory (GB) |
mem_buffer |
double |
Buffer memory (MB) |
swap_free |
double |
RAM temporary storage in the swap space, in GB |
swap_total |
double |
Total swap space (GB) |
cpu_usage |
double |
CPU usage (%) |
cpu_usage_sys |
double |
System CPU usage (%) |
cpu_usage_usr |
double |
User CPU usage (%) |
cpu_idle |
double |
Idle CPU usage (%) |
cpu_iowait |
double |
I/O wait (%) |
disk_usage_avg |
double |
Average disk usage (%) |
disk_total |
double |
Total disk capacity (GB) |
disk_used |
double |
Used disk capacity (GB). |
disk_available |
double |
Available disk capacity (GB) |
disk_io |
double |
Disk I/O (KB/s) |
disk_io_read |
double |
Disk read rate (KB/s) |
disk_io_write |
double |
Disk write rate (KB/s) |
tcp_resend_rate |
double |
TCP protocol stack retransmission rate (%) |
net_io |
double |
Network I/O (KB/s) |
Example Request
https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/host-overview?limit=1&offset=0
Example Response
Status code: 200
The host overview is queried successfully.
[ { "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 Sample Code
The sample code is as follows:
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) } } |
For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.
Status Code
Status Code |
Description |
---|---|
200 |
The host overview is queried successfully. |
204 |
The processing is successful, but no content is returned. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
The service was unavailable. |
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