*View monitoring data for a specified expression over a period of time
Requests
HTTP request
GET /v2/metrics/{cluster}/prometheus/query_range
Execute PromQL query from prometheus
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| cluster | string | True | Cluster name |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | True | PromQL query expression |
| start | integer | True | Start timestamp |
| end | integer | True | End timestamp |
| step | integer | True | Query resolution step width in duration format or float number of seconds |
| timeout | integer | False | Evaluation timeout for prometheus |
Responses
Content-Type
application/json
Status code: 200
OK
Sample response
Query result from prometheus.
{
"data": {
"result": [
{
"metric": {
"__name__": "up",
"endpoint": "https-metrics",
"instance": "192.168.130.193:10250",
"job": "kubelet",
"namespace": "kube-system",
"node": "192.168.130.193",
"service": "kubelet"
},
"values": [
[
1640671200,
"1"
],
[
1640671800,
"1"
],
[
1640672400,
"1"
],
[
1640673000,
"1"
],
[
1640673600,
"1"
],
[
1640674200,
"1"
],
[
1640674800,
"1"
]
]
}
],
"resultType": "matrix"
},
"status": "success"
}Parameters
| Name | Type | Description |
|---|---|---|
| data | object |
Query result get from prometheus.
Path: data |
| data.result | array |
Query result from prometheus.
Path: data.result |
| data.resultType | string |
Query result type from prometheus.
Path: data.resultType |
| data.result[] | object |
Query result data from prometheus.
Path: data.result[] |
| status | string |
API status to access prometheus.
Path: status |