Querying Historical Monitoring Data

Function

This API is used to query historical monitoring data.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/dms/metric-data

**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
from	Yes	String	Definition Start time. Constraints N/A Range N/A Default Value N/A
to	Yes	String	Definition End time. Constraints N/A Range N/A Default Value N/A
function	No	String	Definition Method for obtaining values. Constraints N/A Range N/A Default Value N/A
period	No	String	Definition Period for obtaining values. Constraints N/A Range N/A Default Value N/A
indicator_name	Yes	String	Definition Metric name. Constraints N/A Range N/A Default Value N/A
dim0	Yes	String	Definition First level. Constraints N/A Range N/A Default Value N/A
dim1	No	String	Definition Second level. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of TrendQueryDataResp objects	Definition Response to the historical monitoring data. Range N/A

**Table 4** TrendQueryDataResp
Parameter	Type	Description
query_time	Long	Definition Query time. Range N/A
indicator_name	String	Definition Metric name. Range N/A
object_id	String	Definition ID of a monitored object. Range N/A
unit	String	Definition Unit. Range N/A
sub_object_id	String	Definition ID of the cluster under secondary monitoring. Range N/A
data_points	Array of TrendQueryData objects	Definition Node data. Range N/A

**Table 5** TrendQueryData
Parameter	Type	Description
result	String	Definition Query result. Range N/A
timestamp	Long	Definition Timestamp. Range N/A

Example Requests

https://{Endpoint}/v1.0/05f2cff45100d5112f4bc00b794ea08e/dms/metric-data

Example Responses

Status code: 200

Historical monitoring data queried.

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

Status Codes

Status Code	Description
200	Historical monitoring data queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.