Avi Object API

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

post /analytics/metrics/collection/
get /analytics/metrics/controller/
get /analytics/metrics/controller/{uuid}
get /analytics/metrics/pool/
get /analytics/metrics/pool/{uuid}
get /analytics/metrics/serviceengine/
get /analytics/metrics/serviceengine/{uuid}
get /analytics/metrics/virtualservice/
get /analytics/metrics/virtualservice/{uuid}

post /analytics/metrics/collection/

(analyticsMetricsCollectionPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — MetricsQueryResponse Collections API

Query parameters

include_name (optional)

Query Parameter — Include name in the REST references

include_refs (optional)

Query Parameter — Include references instead of object UUIDs

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

pad_missing_data (optional)

Query Parameter — Pad time series data with null in case there is not metric data present.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

Return type

MetricsCollectionApiRsp

Example data

Content-Type: application/json

{ }

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsCollectionApiRsp

401

get /analytics/metrics/controller/

(analyticsMetricsControllerGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

Query Parameter — Aggregations for dimensions. Eg. use dimenstion_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.

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

Query Parameter — 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.

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

Query Parameter — 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.

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

Query Parameter — 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.

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponseApiResponse

401

get /analytics/metrics/controller/{uuid}

(analyticsMetricsControllerUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json

{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponse

401

get /analytics/metrics/pool/

(analyticsMetricsPoolGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponseApiResponse

401

get /analytics/metrics/pool/{uuid}

(analyticsMetricsPoolUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json

{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponse

401

get /analytics/metrics/serviceengine/

(analyticsMetricsServiceengineGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponseApiResponse

401

get /analytics/metrics/serviceengine/{uuid}

(analyticsMetricsServiceengineUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json

{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponse

401

get /analytics/metrics/virtualservice/

(analyticsMetricsVirtualserviceGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponseApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "metric_id" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
        "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
        "service_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str" : "aeiou",
        "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
        "is_null" : true,
        "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
        "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value_str_desc" : "aeiou",
        "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
        "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
        "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
        "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
        "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
        "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
        "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "obj_id" : "aeiou",
        "obj_id_type" : "aeiou",
        "serviceengine_uuid" : "aeiou",
        "derivation_data" : {
          "skip_backend_derivation" : true,
          "include_derivation_metrics" : true,
          "derivation_fn" : "aeiou",
          "exclude_derived_metric" : true,
          "metric_ids" : "aeiou",
          "second_order_derivation" : true,
          "join_tables" : "aeiou",
          "result_has_additional_fields" : true
        },
        "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
        "units" : "aeiou",
        "priority" : true,
        "entity_uuid" : "aeiou",
        "tenant_uuid" : "aeiou",
        "metrics_sum_agg_invalid" : true,
        "name" : "aeiou",
        "metric_description" : "aeiou",
        "dimension_data" : [ {
          "dimension_id" : "aeiou",
          "dimension" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "pool_uuid" : "aeiou",
        "statistics" : {
          "min" : 1.3579000000000001069366817318950779736042022705078125,
          "max" : 1.3579000000000001069366817318950779736042022705078125,
          "max_ts" : "aeiou",
          "trend" : 1.3579000000000001069366817318950779736042022705078125,
          "mean" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ts" : "aeiou",
          "sum" : 1.3579000000000001069366817318950779736042022705078125,
          "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
          "num_samples" : 123
        }
      }
    } ],
    "limit" : 123,
    "start" : "aeiou",
    "step" : 123,
    "id" : "aeiou",
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponseApiResponse

401

get /analytics/metrics/virtualservice/{uuid}

(analyticsMetricsVirtualserviceUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

include_name (optional)

Query Parameter — 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.

skip_default (optional)

Query Parameter — Default values are not set.

aggregate_entity (optional)

Query Parameter — Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Query Parameter — 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.

asn (optional)

Query Parameter — Autonomous System number. Eg. asn=3794.

attack (optional)

Query Parameter — Dos Attack ID filter.

browser (optional)

Query Parameter — Browser filter. Eg. browser=Chrome.

client_insights (optional)

Query Parameter — Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

Query Parameter — Two letter country filter. Eg. country=US.

detailed_header (optional)

Query Parameter — Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

Query Parameter — Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

dimension_filter_op (optional)

Query Parameter — Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Query Parameter — Limit the number of dimensions in the result. specially useful in case of URLs.

dimension_sampling (optional)

Query Parameter — Deprecated. perform sampling for dimensional metrics. zero means auto.

dimensions (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

include_refs (optional)

Query Parameter — Resolve UUID to names.

include_statistics (optional)

Query Parameter — Include metrics statistics with the request.

ipgroup (optional)

Query Parameter — IPGROUP filter Eg. UUID of the IP group.

lang (optional)

Query Parameter — Language filter. Eg. lang=english.

limit (optional)

Query Parameter — Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples.

metric_entity (optional)

metric_id (optional)

Query Parameter — Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Query Parameter — number of levels of microservices map.

obj_id (optional)

Query Parameter — serverip port of the pool server.

order_by (optional)

Query Parameter — Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

Query Parameter — Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Query Parameter — Pad missing data when not available.

page (optional)

Query Parameter — page id for the query. Allowed only for aggregation queries.

page_size (optional)

Query Parameter — page size of the query. Allowed only for the aggregation queries.

pool_uuid (optional)

Query Parameter — metrics for a member pool in a virtual service.

prediction (optional)

Query Parameter — Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

Query Parameter — 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.

sampling_level (optional)

Query Parameter — Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

Query Parameter — Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

Query Parameter — UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Query Parameter — 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.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

url (optional)

Query Parameter — URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Query Parameter — Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

Return type

MetricsQueryResponse

Example data

Content-Type: application/json

{
  "metric_id" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "page_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_high" : 1.3579000000000001069366817318950779736042022705078125,
      "prediction_interval_low" : 1.3579000000000001069366817318950779736042022705078125,
      "service_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str" : "aeiou",
      "client_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "waiting_time" : 1.3579000000000001069366817318950779736042022705078125,
      "is_null" : true,
      "dns_lookup_time" : 1.3579000000000001069366817318950779736042022705078125,
      "dom_content_load_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value_str_desc" : "aeiou",
      "connection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "page_download_time" : 1.3579000000000001069366817318950779736042022705078125,
      "rum_client_data_transfer_time" : 1.3579000000000001069366817318950779736042022705078125,
      "blocking_time" : 1.3579000000000001069366817318950779736042022705078125,
      "server_rtt" : 1.3579000000000001069366817318950779736042022705078125,
      "redirection_time" : 1.3579000000000001069366817318950779736042022705078125,
      "application_response_time" : 1.3579000000000001069366817318950779736042022705078125,
      "browser_rendering_time" : 1.3579000000000001069366817318950779736042022705078125,
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "obj_id" : "aeiou",
      "obj_id_type" : "aeiou",
      "serviceengine_uuid" : "aeiou",
      "derivation_data" : {
        "skip_backend_derivation" : true,
        "include_derivation_metrics" : true,
        "derivation_fn" : "aeiou",
        "exclude_derived_metric" : true,
        "metric_ids" : "aeiou",
        "second_order_derivation" : true,
        "join_tables" : "aeiou",
        "result_has_additional_fields" : true
      },
      "metrics_min_scale" : 1.3579000000000001069366817318950779736042022705078125,
      "units" : "aeiou",
      "priority" : true,
      "entity_uuid" : "aeiou",
      "tenant_uuid" : "aeiou",
      "metrics_sum_agg_invalid" : true,
      "name" : "aeiou",
      "metric_description" : "aeiou",
      "dimension_data" : [ {
        "dimension_id" : "aeiou",
        "dimension" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "pool_uuid" : "aeiou",
      "statistics" : {
        "min" : 1.3579000000000001069366817318950779736042022705078125,
        "max" : 1.3579000000000001069366817318950779736042022705078125,
        "max_ts" : "aeiou",
        "trend" : 1.3579000000000001069366817318950779736042022705078125,
        "mean" : 1.3579000000000001069366817318950779736042022705078125,
        "min_ts" : "aeiou",
        "sum" : 1.3579000000000001069366817318950779736042022705078125,
        "last_sample" : 1.3579000000000001069366817318950779736042022705078125,
        "num_samples" : 123
      }
    }
  } ],
  "limit" : 123,
  "start" : "aeiou",
  "step" : 123,
  "id" : "aeiou",
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK MetricsQueryResponse

401

Models

[ Jump to Methods ]

MetricStatistics
MetricsCollectionApiReq
MetricsCollectionApiRsp
MetricsData
MetricsDataHeader
MetricsDataSeries
MetricsDerivationData
MetricsDimensionData
MetricsFilters
MetricsMissingDataInterval
MetricsQuery
MetricsQueryApiResponse
MetricsQueryResponse
MetricsQueryResponseApiResponse
RelationalOperatorsParams

MetricStatistics Up

last_sample (optional)

Double value of the last sample. format: double

max (optional)

Double maximum value in time series requested. format: double

max_ts (optional)

String timestamp of the minimum value.

mean (optional)

Double arithmetic mean. format: double

min (optional)

Double minimum value in time series requested. format: double

min_ts (optional)

String timestamp of the minimum value.

num_samples (optional)

Integer Number of actual data samples. It excludes fake data. format: int32

sum (optional)

Double summation of all values. format: double

trend (optional)

Double slope of the data points across the time series requested. trend = (last_value - avg)/avg. format: double

MetricsCollectionApiReq Up

metric_requests (optional)

array[MetricsQuery] list of metrics queries

MetricsCollectionApiRsp Up

MetricsData Up

application_response_time (optional)

Double Placeholder for description of property application_response_time of obj type MetricsData field type str type number format: double

blocking_time (optional)

Double Placeholder for description of property blocking_time of obj type MetricsData field type str type number format: double

browser_rendering_time (optional)

Double Placeholder for description of property browser_rendering_time of obj type MetricsData field type str type number format: double

client_rtt (optional)

Double Placeholder for description of property client_rtt of obj type MetricsData field type str type number format: double

connection_time (optional)

Double Placeholder for description of property connection_time of obj type MetricsData field type str type number format: double

dns_lookup_time (optional)

Double Placeholder for description of property dns_lookup_time of obj type MetricsData field type str type number format: double

dom_content_load_time (optional)

Double Placeholder for description of property dom_content_load_time of obj type MetricsData field type str type number format: double

is_null (optional)

Boolean Placeholder for description of property is_null of obj type MetricsData field type str type boolean

num_samples (optional)

Integer Number of num_samples. format: int32

page_download_time (optional)

Double Placeholder for description of property page_download_time of obj type MetricsData field type str type number format: double

page_load_time (optional)

Double Placeholder for description of property page_load_time of obj type MetricsData field type str type number format: double

prediction_interval_high (optional)

Double Placeholder for description of property prediction_interval_high of obj type MetricsData field type str type number format: double

prediction_interval_low (optional)

Double Placeholder for description of property prediction_interval_low of obj type MetricsData field type str type number format: double

redirection_time (optional)

Double Placeholder for description of property redirection_time of obj type MetricsData field type str type number format: double

rum_client_data_transfer_time (optional)

Double Placeholder for description of property rum_client_data_transfer_time of obj type MetricsData field type str type number format: double

server_rtt (optional)

Double Placeholder for description of property server_rtt of obj type MetricsData field type str type number format: double

service_time (optional)

Double Placeholder for description of property service_time of obj type MetricsData field type str type number format: double

timestamp (optional)

String timestamp of MetricsData.

value

Double Placeholder for description of property value of obj type MetricsData field type str type number format: double

value_str (optional)

String Field introduced in 17.2.2.

value_str_desc (optional)

String Field introduced in 17.2.2.

waiting_time (optional)

Double Placeholder for description of property waiting_time of obj type MetricsData field type str type number format: double

MetricsDataHeader Up

derivation_data (optional)

MetricsDerivationData Metrics derivation info.

dimension_data (optional)

array[MetricsDimensionData] Placeholder for description of property dimension_data of obj type MetricsDataHeader field type str type object

entity_uuid (optional)

String entity uuid.

metric_description (optional)

String metric_description of MetricsDataHeader.

metrics_min_scale (optional)

Double Placeholder for description of property metrics_min_scale of obj type MetricsDataHeader field type str type number format: double

metrics_sum_agg_invalid (optional)

Boolean Placeholder for description of property metrics_sum_agg_invalid of obj type MetricsDataHeader field type str type boolean

missing_intervals (optional)

array[MetricsMissingDataInterval] Missing data intervals. data in these intervals are not used for stats calculation.

name

String name of the column.

obj_id (optional)

String object ID of the series when object ID was specified in the metric.

obj_id_type (optional)

String obj_id_type. Enum options - METRICS_OBJ_ID_TYPE_VIRTUALSERVICE, METRICS_OBJ_ID_TYPE_SERVER, METRICS_OBJ_ID_TYPE_POOL, METRICS_OBJ_ID_TYPE_SERVICEENGINE, METRICS_OBJ_ID_TYPE_VIRTUALMACHINE, METRICS_OBJ_ID_TYPE_CONTROLLER, METRICS_OBJ_ID_TYPE_TENANT, METRICS_OBJ_ID_TYPE_CLUSTER, METRICS_OBJ_ID_TYPE_SE_INTERFACE.

pool_uuid (optional)

String pool_id for the metric.

priority (optional)

Boolean Placeholder for description of property priority of obj type MetricsDataHeader field type str type boolean

server (optional)

String server ip port.

serviceengine_uuid (optional)

String Service Engine ref or UUID. Field introduced in 17.2.8.

statistics (optional)

MetricStatistics statistics of the metric.

tenant_uuid (optional)

String Tenant ref or UUID.

units (optional)

String units of the column data. Enum options - METRIC_COUNT, BITS_PER_SECOND, MILLISECONDS, SECONDS, PER_SECOND, BYTES, PERCENT, KILO_BYTES, KILO_BYTES_PER_SECOND, BYTES_PER_SECOND, KILO_BITS_PER_SECOND, GIGA_BYTES, MEGA_BYTES, NORMALIZED, STRING, SEC, MIN, DAYS, KB, MB, GB, MBPS, GHZ, RATIO, WORD, MICROSECONDS, HEALTH, HOURS.

MetricsDataSeries Up

data (optional)

array[MetricsData] Placeholder for description of property data of obj type MetricsDataSeries field type str type object

header

MetricsDataHeader Placeholder for description of property header of obj type MetricsDataSeries field type str type object

MetricsDerivationData Up

derivation_fn

String Enum options - METRICS_ALIAS, SUM_FIRST_N_DIVIDE_BY_LAST, SUM_BW_GAUGE, AVG_GET_POST_OTHER_LATENCY, APPDEX_ON_3_BUCKETS, APPDEX_ON_4_BUCKETS, SUM_GAUGE, SUM_N_METRICS, APPDEX_ON_5_BUCKETS, APPDEX_ON_6_BUCKETS, APPDEX_ON_CONNECTIONS, APPDEX_ON_2_BUCKETS, AVG_CLIENT_LATENCY, AVG_APPLICATION_LATENCY, MIN_N_METRICS, SUM_FIRST_N_DIVIDE_BY_LAST_PERCENTAGE, L4_CONNECTION_ERROR_PERCENTAGE, AVG_L4_CLIENT_LATENCY, CHECK_FOR_TRANSITIONS, SUBSTRACT_ALL_FROM_FIRST, AVG_N_OVER_TIME_PERIOD, AVG_NAVIGATION_TIMING, AVG_RUM_VISITS, PCT_SSL_ERROR_CONNECTIONS, AVG_RESPONSE_TIME, SUM_RATES_FIRST_N_DIVIDE_BY_LAST, SUM_RATES_FIRST_N_DIVIDE_BY_LAST_PERCENTAGE, PCT_CACHE_METRICS, SUM_FIRST_N_DIVIDE_BY_SECLAST_EXCL_ERROR_RATE, SUM_FIRST_N_SUBSTRACT_LAST, AVG_POOL_METRICS, AVG_POOL_BW, AVG_BY_SUBSTRACT_ALL_FROM_FIRST_OVER_TIME, AVG_RSA_PFS, EVAL_FN, SSL_PROTOCOL_INDICATOR, SUM_FIRST_N_DIVIDE_BY_SECLAST_RATE_EXCL_ERROR_RATE, SUBSTRACT_ALL_FROM_FIRST_WITH_FLOOR_ZERO, AVAILABLE_CAPACITY, CONNECTION_SATURATION, AVG_RSA_NON_PFS, SSL_HANDSHAKES_NONPFS, DYN_MEM_USAGE, FIRST_DIVIDE_BY_DIFFERENCE_OF_SECOND_AND_THIRD, DIVIDE_BY_100.

exclude_derived_metric (optional)

Boolean Placeholder for description of property exclude_derived_metric of obj type MetricsDerivationData field type str type boolean

include_derivation_metrics (optional)

Boolean Placeholder for description of property include_derivation_metrics of obj type MetricsDerivationData field type str type boolean

join_tables (optional)

String Enum options - METRICS_TABLE_NONE, METRICS_TABLE_ANOMALY, METRICS_TABLE_CONTROLLER_STATS, METRICS_TABLE_HEALTH_SCORE, METRICS_TABLE_SE_STATS, METRICS_TABLE_VSERVER_L4_SERVER, METRICS_TABLE_VSERVER_L4_CLIENT, METRICS_TABLE_VSERVER_L7_CLIENT, METRICS_TABLE_VSERVER_L7_SERVER, METRICS_TABLE_RUM_PREAGG_BROWSER, METRICS_TABLE_RUM_PREAGG_COUNTRY, METRICS_TABLE_RUM_PREAGG_DEVTYPE, METRICS_TABLE_RUM_PREAGG_LANG, METRICS_TABLE_RUM_PREAGG_OS, METRICS_TABLE_RUM_PREAGG_URL, METRICS_TABLE_RUM_ANALYTICS, METRICS_TABLE_VM_STATS, METRICS_TABLE_RESOURCE_TIMING_DIM, METRICS_TABLE_RESOURCE_TIMING_BLOB, METRICS_TABLE_RUM_PREAGG_IPGROUP, METRICS_TABLE_DOS_ANALYTICS, METRICS_TABLE_APP_INSIGHTS, METRICS_TABLE_VSERVER_DNS, METRICS_TABLE_SERVER_DNS, METRICS_TABLE_SERVICE_INSIGHTS, METRICS_TABLE_SOURCE_INSIGHTS, METRICS_TABLE_TENANT_STATS, METRICS_TABLE_SE_IF_STATS, METRICS_TABLE_USER_METRICS, METRICS_TABLE_WAF_GROUP, METRICS_TABLE_WAF_TAG, METRICS_TABLE_WAF_RULE, METRICS_TABLE_PROCESS_STATS, METRICS_TABLE_VSERVER_HTTP2_CLIENT, METRICS_TABLE_PG_STAT_DATABASE, METRICS_TABLE_PG_STAT_ALL_TABLES, METRICS_TABLE_PG_STAT_ALL_INDEXES, METRICS_TABLE_PG_STAT_IO_ALL_TABLES, METRICS_TABLE_PG_STAT_CLASS, METRICS_TABLE_PG_STAT_BG_WRITER, METRICS_TABLE_WAF_WHITELIST, METRICS_TABLE_WAF_PSMGROUP, METRICS_TABLE_WAF_PSMLOCATION, METRICS_TABLE_WAF_PSMRULE, METRICS_TABLE_GSLB_STATS, METRICS_TABLE_VS_SCALEOUT, METRICS_TABLE_API_PERF_STATS, METRICS_TABLE_NSXT_STATS, METRICS_TABLE_ICAP.

metric_ids

String metric_ids of MetricsDerivationData.

result_has_additional_fields (optional)

Boolean Placeholder for description of property result_has_additional_fields of obj type MetricsDerivationData field type str type boolean

second_order_derivation (optional)

Boolean Field introduced in 17.2.8.

skip_backend_derivation (optional)

Boolean Placeholder for description of property skip_backend_derivation of obj type MetricsDerivationData field type str type boolean

MetricsDimensionData Up

dimension

String Dimension Type. 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.

dimension_id

String Dimension ID.

MetricsFilters Up

String Enum options - EQ, GT, GE, LT, LE, NE.

rel_param

RelationalOperatorsParams Placeholder for description of property rel_param of obj type MetricsFilters field type str type object

MetricsMissingDataInterval Up

end

String end of MetricsMissingDataInterval.

start

String start of MetricsMissingDataInterval.

MetricsQuery Up

aggregate_entity (optional)

Boolean Required if the metrics need to be aggregated across multiple entities like virtualservice.

aggregate_obj_id (optional)

Boolean 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.

asn (optional)

String Autonomous System number. Eg. asn=3794.

attack (optional)

String Dos Attack ID filter.

browser (optional)

String Browser filter. Eg. browser=Chrome.

client_insights (optional)

String Client Insights Source Type - Active or Passive. Enum options - NO_INSIGHTS, PASSIVE, ACTIVE.

country (optional)

String Two letter country filter. Eg. country=US.

detailed_header (optional)

Boolean Detailed header returns metric information, statistics etc. It is has overhead which can be bypassed if caller just wants raw data.

devtype (optional)

String Device type filter. Eg. devtype=desktop.

dimension_aggregation (optional)

String Aggregations for dimensions. Eg. use dimenstion_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.

dimension_filter_op (optional)

String Filters the obj_id based on the filter specified. Enum options - METRICS_FILTER_EQUALS, METRICS_FILTER_LIKE, METRICS_FILTER_CONTAINS, METRICS_FILTER_NOT_EQUALS.

dimension_limit (optional)

Integer Limit the number of dimensions in the result. specially useful in case of URLs. format: int32

dimension_sampling (optional)

Integer Deprecated. perform sampling for dimensional metrics. zero means auto. format: int32

dimensions (optional)

array[String] 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.

entity_uuid (optional)

String UUID of the entity. Eg. entity_uuid=virtualservice-0-1.

id (optional)

String 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.

include_refs (optional)

Boolean Resolve UUID to names.

include_statistics (optional)

Boolean Include metrics statistics with the request.

ipgroup (optional)

String IPGROUP filter Eg. UUID of the IP group.

lang (optional)

String Language filter. Eg. lang=english.

limit (optional)

Integer Max number of metric samples per metric requestedEg. limit=100 implies return only 100 samples. format: int32

metric_entity (optional)

String 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.

metric_id (optional)

String Comma separated list of metrics requested.Eg. metric_id=l4_client.avg_bandwidth,l7_client.avg_total_responses.

microservice_levels (optional)

Integer number of levels of microservices map. format: int32

obj_id (optional)

String serverip port of the pool server.

order_by (optional)

String Order metrics series by metric timestamp. -metric_timestamp will result in most recent value first in the time series.

os (optional)

String Operating system filter. Eg. os=mac.

pad_missing_data (optional)

Boolean Pad missing data when not available.

page (optional)

Integer page id for the query. Allowed only for aggregation queries. format: int32

page_size (optional)

Integer page size of the query. Allowed only for the aggregation queries. format: int32

pool_uuid (optional)

String metrics for a member pool in a virtual service.

prediction (optional)

Boolean Request prediction values instead of actual observed metrics in future if supported.

result_format (optional)

String 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.

sampling_level (optional)

String Deprecated. Enum options - METRICS_SAMPLING_DEFAULT, METRICS_SAMPLING_FAST, METRICS_SAMPLING_FORCE.

server (optional)

String Pool Server ID in format server IP port. Eg. 10.10.1.42 80.

serviceengine_uuid (optional)

String UUID of the service engine.Eg. serviceengine_uuid=se-422ce810-50a4-2ecd-d45d-870656e99b7b.

start (optional)

String Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Eg. start=1970-01-01T00 00 00.

step (optional)

Integer 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. format: int32

stop (optional)

String End time for the metrics in ISO 8601 format. Default is now. Eg. stop=2014-01-01T12 42 42.

tenant_uuid (optional)

String UUID of the Tenant. .

url (optional)

String URL filter. Eg. url=http //www.avinetworks.com.

validate_data (optional)

Boolean Validate every data before returning. This will result in increased latency and should only be used for troubleshooting.

MetricsQueryApiResponse Up

count

Integer format: int32

results

array[MetricsQuery]

next (optional)

String

MetricsQueryResponse Up

entity_uuid (optional)

String Unique object identifier of entity.

id (optional)

String returns the ID specified in the query.

limit (optional)

Integer Number of limit. format: int32

metric_entity (optional)

String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY.

metric_id (optional)

String metric_id of MetricsQueryResponse.

series (optional)

array[MetricsDataSeries] Placeholder for description of property series of obj type MetricsQueryResponse field type str type object

start (optional)

String start of MetricsQueryResponse.

step (optional)

Integer Number of step. format: int32

stop (optional)

String stop of MetricsQueryResponse.

url (optional)

String url

MetricsQueryResponseApiResponse Up

count

Integer format: int32

results

array[MetricsQueryResponse]

next (optional)

String

RelationalOperatorsParams Up

entity_uuid (optional)

String Unique object identifier of entity.

metric_id

String metric_id of RelationalOperatorsParams.

right_arg

String right_arg of RelationalOperatorsParams.

Avi Object API

Access

Table of Contents

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401