GET Metric Query Data.

POST

/api/observability/synthetic_monitor/namespaces/{namespace}/metric-query

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/observability/synthetic_monitor/namespaces/example/metric-query \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "metrics": [ { "field": "example", "function": "MEAN", "measurement": "example", "tags": [ { "key": "example", "values": [ "example" ] } ] } ], "namespace": "example", "start_time": "example", "step_size": "example" }'

• F5 Distributed Cloud Console

Returns time series data of monitor metric query by region.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Request namespace.

Request Body^required

Media typeapplication/json

GetMetricQueryDataRequest

Request of metric query metric data.

object

end_time

end_time

End time for requested Metric Query metrics (default: current time)

string

<= 1024 characters

metrics

metrics

A list of metric query metric item objects.

Array<object>

MetricItem

Metric query metric object.

object

field

field

Metric field.

string

<= 1024 characters

function

string

default: MEAN

Allowed values: MEAN MIN MAX SUM DIFFERENCE

measurement

measurement

Metric measurement.

string

<= 1024 characters

tags

tags

Metric tags.

Array<object>

TagValuesItem

Metric query metric tag values object.

object

key

key

Tag key

string

>= 7 characters <= 1024 characters

values

values

Tag values.

Array<string>

namespace

namespace

Request namespace.

string

>= 6 characters <= 1024 characters

start_time

start_time

Start time for requested Metric Query metrics.

string

<= 1024 characters

step_size

step_size

Step size for time series aggregation.

string

<= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

GetMetricQueryDataResponse

Metric query metric data.

object

data

data

A list of metric query data.

Array<object>

MetricQueryData

Metric Query Data object.

object

message

message

Data messages.

string

<= 1024 characters

raw

raw

A list of metric query raw data.

Array<object>

RawData

Raw Data object.

object

timestamp

timestamp

Timestamp of a RawData item.

number format: double

value

value

Configuration parameter for value

number format: float

>= 3 characters <= 15 characters

Example^generated

{
  "data": [
    {
      "message": "example",
      "raw": [
        {
          "timestamp": 1,
          "value": 1
        }
      ]
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example