Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Query & Overview
POSTMonitoringSince 1.0SynchronousAuth Required

ValidateMonitoringQuery

Validate a query definition without executing it against the metrics backend

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • metricStringRequired

    Metric name to validate the query against

    Example: cpu_usage_percent

  • filtersLinkedHashMapRequired

    Filter criteria to narrow down results

    Example: (nested object)

  • conditionStringRequired

    Filter condition expression to validate

    Example: resource_type='vm'

  • timeRangeStringRequired

    Time range for the query

    Example: 1h

  • aggregationStringRequired

    Aggregation function to validate

    Example: avg

Responses

200 OK

On success, this API returns an empty JSON object {}.

Endpoint

POST/api/v1/monitoring/query-builder/validate

/api/v1/monitoring/query-builder/validate

Operation ID

ValidateMonitoringQuery

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/query-builder/validate' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"metric":"cpu_usage_percent","filters":"(nested object)","condition":"resource_type='vm'","timeRange":"1h","aggregation":"avg","groupBy":"item1,item2"}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history