Querying Monitoring Data
Function
This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query.
URI
POST /v1/{project_id}/ams/metricdata
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fillValue |
No |
String |
Value filled for breakpoints in monitoring data. Default value: –1. –1: Breakpoints are filled with –1. 0: Breakpoints are filled with 0. null: Breakpoints are filled with null. average: Breakpoints are filled with the average value of the adjacent valid data. If there is no valid data, breakpoints are filled with null. Default: -1 Enumeration values:
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. |
Content-Type |
Yes |
String |
Content type, which is application/json. Enumeration values:
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
metrics |
Yes |
Array of MetricQueryMeritcParam objects |
Metric list. A JSON array can contain up to 20 objects. |
period |
Yes |
Integer |
Granularity for monitoring data, which is an enumerated value. Values: 60: The data monitoring granularity is 1 minute. 300: The data monitoring granularity is 5 minutes. 900: The data monitoring granularity is 15 minutes. 3600: The data monitoring granularity is 1 hour. |
statistics |
Yes |
Array of strings |
Statistic. Values: maximum, minimum, sum, average, and sampleCount. |
timerange |
Yes |
String |
Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period. Example:
Format: startTimeInMillis.endTimeInMillis.durationInMinutes Parameter description:
Constraint: In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1440 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dimensions |
Yes |
Array of Dimension objects |
List of metric dimensions. Neither the array nor the name or value of any dimension in the array can be left blank. |
metricName |
Yes |
String |
Metric name. Length: 1 to 255 characters. Value range: cpuUsage, cpuCoreUsed, and other basic metrics provided by AOM. cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom metrics. |
namespace |
Yes |
String |
Metric namespace. Values: PAAS.CONTAINER: namespace of component, instance, process, and container metrics. PAAS.NODE: namespace of host, network, disk, and file system metrics. PAAS.SLA: namespace of SLA metrics. PAAS.AGGR: namespace of cluster metrics. CUSTOMMETRICS: default namespace of custom metrics. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
errorCode |
String |
Response code. |
errorMessage |
String |
Response message. |
metrics |
Array of MetricDataValue objects |
Metric list. |
Parameter |
Type |
Description |
---|---|---|
dataPoints |
Array of MetricDataPoints objects |
Key metric. |
metric |
MetricQueryMeritcParam object |
Query parameters. |
Parameter |
Type |
Description |
---|---|---|
statistics |
Array of StatisticValue objects |
Statistic. |
timestamp |
Long |
Timestamp. |
unit |
String |
Time series unit. |
Parameter |
Type |
Description |
---|---|---|
statistic |
String |
Statistic. |
value |
Double |
Statistical result. |
Parameter |
Type |
Description |
---|---|---|
dimensions |
Array of Dimension objects |
List of metric dimensions. Neither the array nor the name or value of any dimension in the array can be left blank. |
metricName |
String |
Metric name. Length: 1 to 255 characters. Value range: cpuUsage, cpuCoreUsed, and other basic metrics provided by AOM. cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom metrics. |
namespace |
String |
Metric namespace. Values: PAAS.CONTAINER: namespace of component, instance, process, and container metrics. PAAS.NODE: namespace of host, network, disk, and file system metrics. PAAS.SLA: namespace of SLA metrics. PAAS.AGGR: namespace of cluster metrics. CUSTOMMETRICS: default namespace of custom metrics. |
Example Requests
Query the monitoring data of aom_process_cpu_usage in the PAAS.CONTAINER namespace in the last five minutes.
https://{Endpoint}/v1/{project_id}/ams/metricdata { "metrics" : [ { "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ], "metricName" : "aom_process_cpu_usage", "namespace" : "PAAS.CONTAINER" } ], "period" : 60, "statistics" : [ "maximum", "minimum", "sum" ], "timerange" : "-1.-1.5" }
Example Responses
Status code: 200
OK: The request is successful.
{ "errorCode" : "SVCSTG.AMS.2000", "errorMessage" : "success", "metrics" : [ { "metric" : { "namespace" : "PAAS.CONTAINER", "metricName" : "aom_process_cpu_usage", "dimensions" : [ { "name" : "appName", "value" : "aomApp" } ] }, "dataPoints" : [ { "timestamp" : "1467892800000", "unit" : "Percent", "statistics" : [ { "statistic" : "maximum", "value" : "23" } ] } ] } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
400 |
Bad Request: The request is invalid. The client should not repeat the request without modifications. |
401 |
Unauthorized: The authentication information is incorrect or invalid. |
403 |
Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications. |
500 |
Internal Server Error: The server is able to receive the request but unable to understand the request. |
503 |
Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.