- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Evaluate a PromQL query with [start, end] time range.
HTTP request
GET https://monitoring.googleapis.com/v1/{name}/location/{location}/prometheus/api/v1/query_range
Path parameters
Parameters | |
---|---|
name |
Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/[PROJECT_ID_OR_NUMBER]. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. |
location |
Location of the resource information. Has to be "global" now. |
Query parameters
Parameters | |
---|---|
query |
A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/. |
start |
The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
end |
The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. |
step |
The resolution of query result. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. |
timeout |
An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. |
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/monitoring
https://www.googleapis.com/auth/monitoring.read
For more information, see the Authentication Overview.