AnomalyzerQuery

AnomalyzerQuery
AnomalyzerQuery
JSON Example
{
    "aggregate_obj_id": false,
    "aggregation": "string",
    "aggregation_window": 0,
    "detailed_header": false,
    "dimension_filter_op": "string",
    "entity_uuid": "string",
    "include_refs": false,
    "include_related": false,
    "limit": 0,
    "metric_entity": "string",
    "metric_id": "string",
    "model": "string",
    "obj_id": "string",
    "order_by": "string",
    "page": 0,
    "page_size": 0,
    "pool_uuid": "string",
    "priority": "string",
    "result_format": "string",
    "server": "string",
    "serviceengine_uuid": "string",
    "start": "string",
    "step": 0,
    "stop": "string",
    "tenant_uuid": "string"
}
boolean
aggregate_obj_id
Optional

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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
aggregation
Optional
Constraints: default: METRICS_ANOMALY_AGG_NONE

Enum options - METRICS_ANOMALY_AGG_NONE, METRICS_ANOMALY_AGG_COUNT. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
aggregation_window
Optional
Constraints: default: 1

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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
detailed_header
Optional
Constraints: default: true

ability to reduce the information returned in header. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
dimension_filter_op
Optional
Constraints: default: METRICS_FILTER_EQUALS

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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
entity_uuid
Required

uuid of the entity type. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
include_refs
Optional
Constraints: default: true

Resolve uuid to references. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
include_related
Optional
Constraints: default: true

include anomalies from related objects. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
limit
Optional
Constraints: default: 50

Max number of metric samples. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
metric_entity
Required
Constraints: default: VSERVER_METRICS_ENTITY

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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
metric_id
Optional

This is of the form l4_server. comma seperated values. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
model
Optional

Enum options - EXPONENTIAL_MOVING_AVG, EXPONENTIAL_WEIGHTED_MOVING_AVG, HOLTWINTERS_AT_AS, HOLTWINTERS_AT_MS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
obj_id
Optional

object id like vip or server ip. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
order_by
Optional
Constraints: default: metric_timestamp

Positive means sort from start and Negative sign means sort from end. Only metric_timestamp is supported for now. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
page
Optional

page id for the anomaly query. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
page_size
Optional

size of each page of anomalies. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
pool_uuid
Optional

Pool name. This will apply to any backend stats that are specified in the query. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
priority
Optional
Constraints: default: ANZ_PRIORITY_HIGH

High priority Anomaly. Enum options - ANZ_PRIORITY_HIGH, ANZ_PRIORITY_MEDIUM, ANZ_PRIORITY_LOW. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
result_format
Optional
Constraints: default: METRICS_FORMAT_JSON

format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
server
Optional

server ip port. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
serviceengine_uuid
Optional

ID of the Node. Eg. if query is SE specific then it would have SE UUID. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
start
Optional
Constraints: default: 1970-01-01T00:00:00

Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
step
Optional
Constraints: default: 5

step interval in seconds. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
stop
Optional

End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_uuid
Optional

UUID of the Tenant. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.