GET /analytics/metrics/virtualservice
/analytics/metrics/virtualservice
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
Required if the metrics need to be aggregated across multiple entities like virtualservice. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
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.
Autonomous System number. Eg. asn=3794. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Dos Attack ID filter. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Browser filter. Eg. browser=Chrome. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Two letter country filter. Eg. country=US. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Device type filter. Eg. devtype=desktop. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Aggregations for dimensions. Eg. use dimension_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Limit the number of dimensions in the result. specially useful in case of URLs. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Deprecated. perform sampling for dimensional metrics. zero means auto. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Group by dimensions for the metrics. Eg. For results by single dimension use dimensions=browser. For results by browser and operating system use dimensions=browser,os. Enum options - METRICS_DIMENSION_METRIC_TIMESTAMP, METRICS_DIMENSION_COUNTRY, METRICS_DIMENSION_OS, METRICS_DIMENSION_URL, METRICS_DIMENSION_DEVTYPE, METRICS_DIMENSION_LANG, METRICS_DIMENSION_BROWSER, METRICS_DIMENSION_IPGROUP, METRICS_DIMENSION_ATTACK, METRICS_DIMENSION_ASN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
UUID of the entity. Eg. entity_uuid=virtualservice-0-1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
ID of the request. In case of GET API it is returned in the metrics query response. In case of collections API responses are grouped byresponses corresponding to each optimized query. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Resolve UUID to names. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Include metrics statistics with the request. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
IPGROUP filter Eg. UUID of the IP group. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Language filter. Eg. lang=english. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Describes the entity type for which metrics is requested. Eg. &metric_entity=VSERVER_METRICS_ENTITY. 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.
Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
number of levels of microservices map. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
serverip port of the pool server. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Operating system filter. Eg. os=mac. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Pad missing data when not available. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
page id for the query. Allowed only for aggregation queries. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
page size of the query. Allowed only for the aggregation queries. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
metrics for a member pool in a virtual service. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Request prediction values instead of actual observed metrics in future if supported. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Deprecated. Please do not use this option. APIs only support JSON format. 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.
Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Pool Server ID in format server IP port. Eg. 10.10.1.42 80. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Metrics time series returned with time points every time duration specified as step. Eg. if bandwidth is desired every 5 Secs then use step=5&metric_id=l4_client.avg_bandwidth. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
UUID of the Tenant. . Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
URL filter. Eg. url=http //www.avinetworks.com. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Validate every data before returning. This will result in increased latency and should only be used for troubleshooting. Allowed with any value in Enterprise, 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": [
{
"entity_uuid": "string",
"id": "string",
"limit": 0,
"metric_entity": "string",
"metric_id": "string",
"series": [
{
"data": [
{
"application_response_time": "number",
"blocking_time": "number",
"browser_rendering_time": "number",
"client_rtt": "number",
"connection_time": "number",
"dns_lookup_time": "number",
"dom_content_load_time": "number",
"is_null": false,
"num_samples": 0,
"page_download_time": "number",
"page_load_time": "number",
"prediction_interval_high": "number",
"prediction_interval_low": "number",
"redirection_time": "number",
"rum_client_data_transfer_time": "number",
"server_rtt": "number",
"service_time": "number",
"timestamp": "string",
"value": "number",
"value_str": "string",
"value_str_desc": "string",
"waiting_time": "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/Metrics/virtualservice