GET /analytics/anomaly/serviceengine
/analytics/anomaly/serviceengine
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
object name
Aggregate metrics for all the records for obj_id. When this is set obj_id is treated as a filter rather than a dimension. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - METRICS_ANOMALY_AGG_NONE, METRICS_ANOMALY_AGG_COUNT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
factor of aggregation window to the step. Eg. if requirement to is aggregate count ever 30 mins using 5 minute samples then value is 6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ability to reduce the information returned in header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Resolve uuid to references. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include anomalies from related objects. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Max number of metric samples. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
This is of the form l4_server. comma seperated values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Enum options - EXPONENTIAL_MOVING_AVG, EXPONENTIAL_WEIGHTED_MOVING_AVG, HOLTWINTERS_AT_AS, HOLTWINTERS_AT_MS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
object id like vip or server ip. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Positive means sort from start and Negative sign means sort from end. Only metric_timestamp is supported for now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
page id for the anomaly query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
size of each page of anomalies. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
High priority Anomaly. Enum options - ANZ_PRIORITY_HIGH, ANZ_PRIORITY_MEDIUM, ANZ_PRIORITY_LOW. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ID of the Node. Eg. if query is SE specific then it would have SE UUID. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
UUID of the Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Avi Tenant Header
Avi Tenant Header UUID
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller with reject requests.
OK
{
"count": 0,
"results": [
{
"metric_id": "string",
"series": [
{
"data": [
{
"anomaly_context": {
"ema_context": {
"average": "number",
"deviation": "number",
"max_std_dev": "number",
"normal_high": "number",
"normal_low": "number",
"prediction": "number",
"prediction_interval_high": "number",
"prediction_interval_low": "number",
"std_dev": "number"
},
"ewma_context": {
"average": "number",
"deviation": "number",
"max_std_dev": "number",
"normal_high": "number",
"normal_low": "number",
"prediction": "number",
"prediction_interval_high": "number",
"prediction_interval_low": "number",
"std_dev": "number"
},
"hw_at_as_context": {
"deviation": "number",
"level": "number",
"prediction": "number",
"prediction_interval_high": "number",
"prediction_interval_low": "number",
"trend": "number"
},
"hw_at_ms_context": {
"deviation": "number",
"level": "number",
"prediction": "number",
"prediction_interval_high": "number",
"prediction_interval_low": "number",
"trend": "number"
},
"prediction_interval_high": "number",
"prediction_interval_low": "number"
},
"anomaly_model": "string",
"entity_uuid": "string",
"obj_id": "string",
"obj_id_type": "string",
"pool_uuid": "string",
"priority": "string",
"timestamp": "string",
"value": "number"
}
],
"header": {
"derivation_data": {
"derivation_fn": "string",
"exclude_derived_metric": false,
"include_derivation_metrics": false,
"join_tables": "string",
"metric_ids": "string",
"result_has_additional_fields": false,
"second_order_derivation": false,
"skip_backend_derivation": false
},
"dimension_data": [
{
"dimension": "string",
"dimension_id": "string"
}
],
"entity_uuid": "string",
"metric_description": "string",
"metrics_min_scale": "number",
"metrics_sum_agg_invalid": false,
"missing_intervals": [
{
"end": "string",
"start": "string"
}
],
"name": "string",
"obj_id": "string",
"obj_id_type": "string",
"pool_uuid": "string",
"priority": false,
"server": "string",
"serviceengine_uuid": "string",
"statistics": {
"last_sample": "number",
"max": "number",
"max_ts": "string",
"mean": "number",
"min": "number",
"min_ts": "string",
"num_samples": 0,
"sum": "number",
"trend": "number"
},
"tenant_uuid": "string",
"units": "string"
}
}
],
"start": "string",
"step": 0,
"stop": "string",
"url": "string"
}
],
"next": "string"
}count
results
next
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/analytics/anomaly/serviceengine