Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Host Monitoring/ Querying Historical Monitoring Data
Updated on 2024-04-18 GMT+08:00

Querying Historical Monitoring Data

Function

This API is used to query historical monitoring data.

Call Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/metric-data
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

from

Yes

String

Start time

to

Yes

String

End time

function

No

String

Method to obtain values.

period

No

String

Period for obtaining values.

indicator_name

Yes

String

Monitoring metric name

dim0

Yes

String

First level

dim1

No

String

Second level

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

[Array]

Array of TrendQueryDataResponseBody objects

List of historical monitoring data.

Table 4 TrendQueryDataResponseBody

Parameter

Type

Description

query_time

Long

Query time

indicator_name

String

Monitoring metric name

object_id

String

ID of the monitored object

unit

String

Unit

sub_object_id

String

ID of the cluster under secondary monitoring

data_points

Array of TrendQueryData objects

Node data

Table 5 TrendQueryData

Parameter

Type

Description

result

String

Query result.

timestamp

Long

Timestamp

Example Request

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/metric-data?from=1671058114000&to=1671058144000&indicator_name=cluster.cpu_usage&dim0=cluster_id,fe658e95-5284-4adf-b6aa-7729b563dxxx

Example Response

Status code: 200

[ {
  "query_time" : 1671160536504,
  "indicator_name" : "cluster cpu_usage",
  "object_id" : "fe658e95-5284-4adf-b6aa-7729b563dcb7",
  "unit" : "percentage",
  "data_points" : [ {
    "result" : "10.20",
    "timestamp" : 1671058114000
  }, {
    "result" : "10.20",
    "timestamp" : 1671058144000
  } ]
}, {
  "query_time" : 1671160536504,
  "indicator_name" : "cluster cpu_mem",
  "object_id" : "fe658e95-5284-4adf-b6aa-7729b563dcb7",
  "unit" : "percentage",
  "data_points" : [ {
    "result" : "10.20",
    "timestamp" : 1671058114000
  }, {
    "result" : "10.20",
    "timestamp" : 1671058144000
  } ]
} ]

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
50
51
52
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 ListMonitorIndicatorDataSolution {

    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();
        ListMonitorIndicatorDataRequest request = new ListMonitorIndicatorDataRequest();
        request.withFrom("<from>");
        request.withTo("<to>");
        request.withFunction("<function>");
        request.withPeriod("<period>");
        request.withIndicatorName("<indicator_name>");
        request.withDim0("<dim0>");
        request.withDim1("<dim1>");
        try {
            ListMonitorIndicatorDataResponse response = client.listMonitorIndicatorData(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
34
35
36
# 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 = ListMonitorIndicatorDataRequest()
        request._from = "<from>"
        request.to = "<to>"
        request.function = "<function>"
        request.period = "<period>"
        request.indicator_name = "<indicator_name>"
        request.dim0 = "<dim0>"
        request.dim1 = "<dim1>"
        response = client.list_monitor_indicator_data(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
42
43
44
45
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.ListMonitorIndicatorDataRequest{}
	request.From = "<from>"
	request.To = "<to>"
	functionRequest:= "<function>"
	request.Function = &functionRequest
	periodRequest:= "<period>"
	request.Period = &periodRequest
	request.IndicatorName = "<indicator_name>"
	request.Dim0 = "<dim0>"
	dim1Request:= "<dim1>"
	request.Dim1 = &dim1Request
	response, err := client.ListMonitorIndicatorData(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 historical monitoring data is queried successfully.

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.