Avi Object API

More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /analytics/healthscore/pool/
  2. get /analytics/healthscore/pool/{uuid}
  3. get /analytics/healthscore/serviceengine/
  4. get /analytics/healthscore/serviceengine/{uuid}
  5. get /analytics/healthscore/virtualservice/
  6. get /analytics/healthscore/virtualservice/{uuid}
Up 
get /analytics/healthscore/pool/
(analyticsHealthscorePoolGet)

Consumes

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

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
detailed_header (optional)
Query Parameter — Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
Query Parameter — Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
Query Parameter — Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Query Parameter — Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Query Parameter — Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

HealthScoreQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "pool_ref" : "aeiou",
    "server" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "reason" : "aeiou",
        "performance_score" : {
          "reason" : "aeiou",
          "application_performance" : {
            "virtualservice_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "reason" : "aeiou",
                "ref" : "aeiou",
                "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
                "pool_performance_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                    "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                    "oper_state" : "aeiou"
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou"
          },
          "serviceengine_performance" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "oper_state" : "aeiou"
          },
          "virtualservice_performance" : "",
          "pool_performance" : "",
          "server_performance" : {
            "reason" : "aeiou",
            "server" : "aeiou",
            "ref" : "aeiou",
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou",
            "pool_uuid" : "aeiou"
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "is_null" : true,
        "performance_value" : 123,
        "security_threat_level" : {
          "reason" : "aeiou",
          "ssl_score_data" : {
            "reason" : "aeiou",
            "weak_signature_algorithm" : "aeiou",
            "deactivate_client_renegotiation" : true,
            "hsts_enabled_score" : 1.3579000000000001069366817318950779736042022705078125,
            "hsts_enabled" : true,
            "cert_chain_verified" : "aeiou",
            "pfs_support_score" : 1.3579000000000001069366817318950779736042022705078125,
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "pfs_support" : true,
            "value" : 1.3579000000000001069366817318950779736042022705078125,
            "deactivate_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_cipher_strength" : "aeiou",
            "earliest_cert_expiry" : "aeiou",
            "min_cipher_strength_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_ssl_protocol_strength" : "aeiou",
            "cert_revoked_status" : "aeiou",
            "weak_signature_algorithm_score" : 1.3579000000000001069366817318950779736042022705078125,
            "weakest_enc_algo" : "aeiou",
            "cert_revoked_status_score" : 1.3579000000000001069366817318950779736042022705078125,
            "cert_chain_verified_score" : 1.3579000000000001069366817318950779736042022705078125,
            "ssl_enabled" : true,
            "weakest_enc_algo_score" : 1.3579000000000001069366817318950779736042022705078125,
            "earliest_cert_expiry_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_ssl_protocol_strength_score" : 1.3579000000000001069366817318950779736042022705078125
          },
          "serviceengine_dos_attack_level_data" : "",
          "dos_attack_level_data" : {
            "pct_dos_rx_bytes" : 1.3579000000000001069366817318950779736042022705078125,
            "reason" : "aeiou",
            "avg_dos_total_req" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_total_connections" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_connections_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_dos_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_policy_drops" : 1.3579000000000001069366817318950779736042022705078125,
            "serviceengine_dos_attack_level_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pct_rx_pkts_dropped" : 1.3579000000000001069366817318950779736042022705078125,
                "reason" : "aeiou",
                "ref" : "aeiou",
                "avg_rx_pkts" : 1.3579000000000001069366817318950779736042022705078125,
                "pct_rx_bytes_dropped" : 1.3579000000000001069366817318950779736042022705078125,
                "avg_connections" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "avg_rx_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
                "value" : 1.3579000000000001069366817318950779736042022705078125,
                "pct_connections_dropped" : 1.3579000000000001069366817318950779736042022705078125
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "pct_pkts_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_application_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "value" : 1.3579000000000001069366817318950779736042022705078125
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "security_penalty" : 123,
        "anomaly_penalty" : 123,
        "anomaly_score" : {
          "reason" : "aeiou",
          "virtualservice_anomaly" : "",
          "application_anomaly" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "virtualservice_anomaly_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : {
                "pool_ref" : "aeiou",
                "server" : "aeiou",
                "entity_uuid" : "aeiou",
                "metrics_entity" : "aeiou"
              },
              "score_data" : {
                "anomalous_l4_metrics" : [ "aeiou" ],
                "reason" : "aeiou",
                "ref" : "aeiou",
                "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                "anomalous_l7_metrics" : [ "aeiou" ],
                "serviceengine_anomaly_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "per_anomalous_vm_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "anomalous_se_stats_metrics" : [ "aeiou" ],
                    "per_anomalous_se_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "anomalous_vm_stats_metrics" : [ "aeiou" ],
                    "reason_attr" : "aeiou"
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                "pool_anomaly_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "anomalous_l4_metrics" : [ "aeiou" ],
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "anomalous_l7_metrics" : [ "aeiou" ],
                    "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "avg_server_anomaly_score" : 1.3579000000000001069366817318950779736042022705078125,
                    "server_anomaly_scores" : [ {
                      "reason" : "aeiou",
                      "hs_entity" : "",
                      "score_data" : {
                        "anomalous_l4_metrics" : [ "aeiou" ],
                        "reason" : "aeiou",
                        "server" : "aeiou",
                        "ref" : "aeiou",
                        "anomalous_vm_metrics" : [ "aeiou" ],
                        "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "anomalous_l7_metrics" : [ "aeiou" ],
                        "per_anomalous_vm_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "reason_attr" : "aeiou",
                        "pool_uuid" : "aeiou"
                      },
                      "value" : 1.3579000000000001069366817318950779736042022705078125
                    } ]
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason_attr" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou"
          },
          "pool_anomaly" : "",
          "reason_attr" : "aeiou",
          "server_anomaly" : "",
          "serviceengine_anomaly" : "",
          "value" : 1.3579000000000001069366817318950779736042022705078125,
          "controller_anomaly" : {
            "per_anomalous_controller_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
            "reason" : "aeiou",
            "anomalous_controller_stats_metrics" : [ "aeiou" ],
            "reason_attr" : "aeiou",
            "uuid" : "aeiou"
          }
        },
        "resources_score" : {
          "serviceengine_resources" : "",
          "application_resources" : {
            "virtualservice_resources_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_resources_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "reason" : "aeiou",
                    "avg_server_resources_score" : 1.3579000000000001069366817318950779736042022705078125,
                    "ref" : "aeiou",
                    "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "server_resources_scores" : [ {
                      "reason" : "aeiou",
                      "hs_entity" : "",
                      "score_data" : {
                        "reason" : "aeiou",
                        "server" : "aeiou",
                        "avg_disk2_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "pct_open_conns" : 1.3579000000000001069366817318950779736042022705078125,
                        "ref" : "aeiou",
                        "avg_disk4_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_disk3_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                        "reason_attr" : "aeiou",
                        "pool_uuid" : "aeiou",
                        "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
                      },
                      "value" : 1.3579000000000001069366817318950779736042022705078125
                    } ]
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason" : "aeiou",
                "ha_index" : 1.3579000000000001069366817318950779736042022705078125,
                "ref" : "aeiou",
                "max_open_conns_usage" : 1.3579000000000001069366817318950779736042022705078125,
                "serviceengine_resources_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "reason" : "aeiou",
                    "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_persistent_table_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_packet_buffer_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "oper_state" : "aeiou",
                    "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_ssl_session_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_dynamic_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "ref" : "aeiou",
                    "pct_syn_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_shared_memory_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_connection_mem_usage" : 1.3579000000000001069366817318950779736042022705078125
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "avg_bandwidth_usage" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "multivip_index" : 1.3579000000000001069366817318950779736042022705078125
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou"
          },
          "reason" : "aeiou",
          "virtualservice_resources" : "",
          "server_resources" : "",
          "pool_resources" : "",
          "controller_resources" : {
            "reason" : "aeiou",
            "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
            "reason_attr" : "aeiou",
            "uuid" : "aeiou",
            "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "dos_attack_level" : 1.3579000000000001069366817318950779736042022705078125,
        "ssl_score" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "resources_penalty" : 123,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "resources_penalty_statistics" : "",
        "performance_score_statistics" : "",
        "metrics_min_scale" : 123,
        "units" : "aeiou",
        "anomaly_penalty_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
        },
        "pool_ref" : "aeiou",
        "entity_uuid" : "aeiou",
        "security_penalty_statistics" : "",
        "hs_type" : "aeiou",
        "name" : "aeiou",
        "contributors" : [ {
          "entities" : [ "" ],
          "hs_type" : "aeiou",
          "metric_ids" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "serviceengine_ref" : "aeiou",
        "statistics" : ""
      }
    } ],
    "start" : "aeiou",
    "step" : 123,
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

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

Responses

200

OK HealthScoreQueryResponseApiResponse

401

log in failed
Up 
get /analytics/healthscore/pool/{uuid}
(analyticsHealthscorePoolUuidGet)

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:

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.
detailed_header (optional)
Query Parameter — Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
Query Parameter — Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
Query Parameter — Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Query Parameter — Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Query Parameter — Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

HealthScoreQueryResponse

Example data

Content-Type: application/json
{
  "pool_ref" : "aeiou",
  "server" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "reason" : "aeiou",
      "performance_score" : {
        "reason" : "aeiou",
        "application_performance" : {
          "virtualservice_performance_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "reason" : "aeiou",
              "ref" : "aeiou",
              "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_performance_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                  "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou",
              "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
              "oper_state" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "serviceengine_performance" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "oper_state" : "aeiou"
        },
        "virtualservice_performance" : "",
        "pool_performance" : "",
        "server_performance" : {
          "reason" : "aeiou",
          "server" : "aeiou",
          "ref" : "aeiou",
          "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
          "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
          "oper_state" : "aeiou",
          "pool_uuid" : "aeiou"
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "is_null" : true,
      "performance_value" : 123,
      "security_threat_level" : {
        "reason" : "aeiou",
        "ssl_score_data" : {
          "reason" : "aeiou",
          "weak_signature_algorithm" : "aeiou",
          "deactivate_client_renegotiation" : true,
          "hsts_enabled_score" : 1.3579000000000001069366817318950779736042022705078125,
          "hsts_enabled" : true,
          "cert_chain_verified" : "aeiou",
          "pfs_support_score" : 1.3579000000000001069366817318950779736042022705078125,
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "pfs_support" : true,
          "value" : 1.3579000000000001069366817318950779736042022705078125,
          "deactivate_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_cipher_strength" : "aeiou",
          "earliest_cert_expiry" : "aeiou",
          "min_cipher_strength_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ssl_protocol_strength" : "aeiou",
          "cert_revoked_status" : "aeiou",
          "weak_signature_algorithm_score" : 1.3579000000000001069366817318950779736042022705078125,
          "weakest_enc_algo" : "aeiou",
          "cert_revoked_status_score" : 1.3579000000000001069366817318950779736042022705078125,
          "cert_chain_verified_score" : 1.3579000000000001069366817318950779736042022705078125,
          "ssl_enabled" : true,
          "weakest_enc_algo_score" : 1.3579000000000001069366817318950779736042022705078125,
          "earliest_cert_expiry_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ssl_protocol_strength_score" : 1.3579000000000001069366817318950779736042022705078125
        },
        "serviceengine_dos_attack_level_data" : "",
        "dos_attack_level_data" : {
          "pct_dos_rx_bytes" : 1.3579000000000001069366817318950779736042022705078125,
          "reason" : "aeiou",
          "avg_dos_total_req" : 1.3579000000000001069366817318950779736042022705078125,
          "avg_total_connections" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_connections_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_dos_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_policy_drops" : 1.3579000000000001069366817318950779736042022705078125,
          "serviceengine_dos_attack_level_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "pct_rx_pkts_dropped" : 1.3579000000000001069366817318950779736042022705078125,
              "reason" : "aeiou",
              "ref" : "aeiou",
              "avg_rx_pkts" : 1.3579000000000001069366817318950779736042022705078125,
              "pct_rx_bytes_dropped" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_connections" : 1.3579000000000001069366817318950779736042022705078125,
              "reason_attr" : "aeiou",
              "avg_rx_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
              "value" : 1.3579000000000001069366817318950779736042022705078125,
              "pct_connections_dropped" : 1.3579000000000001069366817318950779736042022705078125
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "pct_pkts_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_application_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "security_penalty" : 123,
      "anomaly_penalty" : 123,
      "anomaly_score" : {
        "reason" : "aeiou",
        "virtualservice_anomaly" : "",
        "application_anomaly" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "virtualservice_anomaly_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : {
              "pool_ref" : "aeiou",
              "server" : "aeiou",
              "entity_uuid" : "aeiou",
              "metrics_entity" : "aeiou"
            },
            "score_data" : {
              "anomalous_l4_metrics" : [ "aeiou" ],
              "reason" : "aeiou",
              "ref" : "aeiou",
              "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
              "anomalous_l7_metrics" : [ "aeiou" ],
              "serviceengine_anomaly_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "per_anomalous_vm_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "anomalous_se_stats_metrics" : [ "aeiou" ],
                  "per_anomalous_se_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "anomalous_vm_stats_metrics" : [ "aeiou" ],
                  "reason_attr" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_anomaly_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "anomalous_l4_metrics" : [ "aeiou" ],
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "anomalous_l7_metrics" : [ "aeiou" ],
                  "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "avg_server_anomaly_score" : 1.3579000000000001069366817318950779736042022705078125,
                  "server_anomaly_scores" : [ {
                    "reason" : "aeiou",
                    "hs_entity" : "",
                    "score_data" : {
                      "anomalous_l4_metrics" : [ "aeiou" ],
                      "reason" : "aeiou",
                      "server" : "aeiou",
                      "ref" : "aeiou",
                      "anomalous_vm_metrics" : [ "aeiou" ],
                      "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "anomalous_l7_metrics" : [ "aeiou" ],
                      "per_anomalous_vm_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "reason_attr" : "aeiou",
                      "pool_uuid" : "aeiou"
                    },
                    "value" : 1.3579000000000001069366817318950779736042022705078125
                  } ]
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason_attr" : "aeiou"
        },
        "pool_anomaly" : "",
        "reason_attr" : "aeiou",
        "server_anomaly" : "",
        "serviceengine_anomaly" : "",
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "controller_anomaly" : {
          "per_anomalous_controller_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
          "reason" : "aeiou",
          "anomalous_controller_stats_metrics" : [ "aeiou" ],
          "reason_attr" : "aeiou",
          "uuid" : "aeiou"
        }
      },
      "resources_score" : {
        "serviceengine_resources" : "",
        "application_resources" : {
          "virtualservice_resources_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "pool_resources_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "avg_server_resources_score" : 1.3579000000000001069366817318950779736042022705078125,
                  "ref" : "aeiou",
                  "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "server_resources_scores" : [ {
                    "reason" : "aeiou",
                    "hs_entity" : "",
                    "score_data" : {
                      "reason" : "aeiou",
                      "server" : "aeiou",
                      "avg_disk2_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "pct_open_conns" : 1.3579000000000001069366817318950779736042022705078125,
                      "ref" : "aeiou",
                      "avg_disk4_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_disk3_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                      "reason_attr" : "aeiou",
                      "pool_uuid" : "aeiou",
                      "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
                    },
                    "value" : 1.3579000000000001069366817318950779736042022705078125
                  } ]
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason" : "aeiou",
              "ha_index" : 1.3579000000000001069366817318950779736042022705078125,
              "ref" : "aeiou",
              "max_open_conns_usage" : 1.3579000000000001069366817318950779736042022705078125,
              "serviceengine_resources_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "reason" : "aeiou",
                  "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_persistent_table_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_packet_buffer_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou",
                  "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_ssl_session_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_dynamic_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "ref" : "aeiou",
                  "pct_syn_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_shared_memory_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_connection_mem_usage" : 1.3579000000000001069366817318950779736042022705078125
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "avg_bandwidth_usage" : 1.3579000000000001069366817318950779736042022705078125,
              "reason_attr" : "aeiou",
              "multivip_index" : 1.3579000000000001069366817318950779736042022705078125
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "reason" : "aeiou",
        "virtualservice_resources" : "",
        "server_resources" : "",
        "pool_resources" : "",
        "controller_resources" : {
          "reason" : "aeiou",
          "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "uuid" : "aeiou",
          "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "dos_attack_level" : 1.3579000000000001069366817318950779736042022705078125,
      "ssl_score" : 1.3579000000000001069366817318950779736042022705078125,
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "resources_penalty" : 123,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "resources_penalty_statistics" : "",
      "performance_score_statistics" : "",
      "metrics_min_scale" : 123,
      "units" : "aeiou",
      "anomaly_penalty_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
      },
      "pool_ref" : "aeiou",
      "entity_uuid" : "aeiou",
      "security_penalty_statistics" : "",
      "hs_type" : "aeiou",
      "name" : "aeiou",
      "contributors" : [ {
        "entities" : [ "" ],
        "hs_type" : "aeiou",
        "metric_ids" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "serviceengine_ref" : "aeiou",
      "statistics" : ""
    }
  } ],
  "start" : "aeiou",
  "step" : 123,
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

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

Responses

200

OK HealthScoreQueryResponse

401

log in failed
Up 
get /analytics/healthscore/serviceengine/
(analyticsHealthscoreServiceengineGet)

Consumes

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

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
detailed_header (optional)
Query Parameter — Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
Query Parameter — Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
Query Parameter — Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Query Parameter — Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Query Parameter — Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

HealthScoreQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "pool_ref" : "aeiou",
    "server" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "reason" : "aeiou",
        "performance_score" : {
          "reason" : "aeiou",
          "application_performance" : {
            "virtualservice_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "reason" : "aeiou",
                "ref" : "aeiou",
                "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
                "pool_performance_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                    "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                    "oper_state" : "aeiou"
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou"
          },
          "serviceengine_performance" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "oper_state" : "aeiou"
          },
          "virtualservice_performance" : "",
          "pool_performance" : "",
          "server_performance" : {
            "reason" : "aeiou",
            "server" : "aeiou",
            "ref" : "aeiou",
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou",
            "pool_uuid" : "aeiou"
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "is_null" : true,
        "performance_value" : 123,
        "security_threat_level" : {
          "reason" : "aeiou",
          "ssl_score_data" : {
            "reason" : "aeiou",
            "weak_signature_algorithm" : "aeiou",
            "deactivate_client_renegotiation" : true,
            "hsts_enabled_score" : 1.3579000000000001069366817318950779736042022705078125,
            "hsts_enabled" : true,
            "cert_chain_verified" : "aeiou",
            "pfs_support_score" : 1.3579000000000001069366817318950779736042022705078125,
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "pfs_support" : true,
            "value" : 1.3579000000000001069366817318950779736042022705078125,
            "deactivate_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_cipher_strength" : "aeiou",
            "earliest_cert_expiry" : "aeiou",
            "min_cipher_strength_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_ssl_protocol_strength" : "aeiou",
            "cert_revoked_status" : "aeiou",
            "weak_signature_algorithm_score" : 1.3579000000000001069366817318950779736042022705078125,
            "weakest_enc_algo" : "aeiou",
            "cert_revoked_status_score" : 1.3579000000000001069366817318950779736042022705078125,
            "cert_chain_verified_score" : 1.3579000000000001069366817318950779736042022705078125,
            "ssl_enabled" : true,
            "weakest_enc_algo_score" : 1.3579000000000001069366817318950779736042022705078125,
            "earliest_cert_expiry_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_ssl_protocol_strength_score" : 1.3579000000000001069366817318950779736042022705078125
          },
          "serviceengine_dos_attack_level_data" : "",
          "dos_attack_level_data" : {
            "pct_dos_rx_bytes" : 1.3579000000000001069366817318950779736042022705078125,
            "reason" : "aeiou",
            "avg_dos_total_req" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_total_connections" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_connections_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_dos_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_policy_drops" : 1.3579000000000001069366817318950779736042022705078125,
            "serviceengine_dos_attack_level_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pct_rx_pkts_dropped" : 1.3579000000000001069366817318950779736042022705078125,
                "reason" : "aeiou",
                "ref" : "aeiou",
                "avg_rx_pkts" : 1.3579000000000001069366817318950779736042022705078125,
                "pct_rx_bytes_dropped" : 1.3579000000000001069366817318950779736042022705078125,
                "avg_connections" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "avg_rx_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
                "value" : 1.3579000000000001069366817318950779736042022705078125,
                "pct_connections_dropped" : 1.3579000000000001069366817318950779736042022705078125
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "pct_pkts_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_application_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "value" : 1.3579000000000001069366817318950779736042022705078125
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "security_penalty" : 123,
        "anomaly_penalty" : 123,
        "anomaly_score" : {
          "reason" : "aeiou",
          "virtualservice_anomaly" : "",
          "application_anomaly" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "virtualservice_anomaly_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : {
                "pool_ref" : "aeiou",
                "server" : "aeiou",
                "entity_uuid" : "aeiou",
                "metrics_entity" : "aeiou"
              },
              "score_data" : {
                "anomalous_l4_metrics" : [ "aeiou" ],
                "reason" : "aeiou",
                "ref" : "aeiou",
                "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                "anomalous_l7_metrics" : [ "aeiou" ],
                "serviceengine_anomaly_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "per_anomalous_vm_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "anomalous_se_stats_metrics" : [ "aeiou" ],
                    "per_anomalous_se_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "anomalous_vm_stats_metrics" : [ "aeiou" ],
                    "reason_attr" : "aeiou"
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                "pool_anomaly_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "anomalous_l4_metrics" : [ "aeiou" ],
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "anomalous_l7_metrics" : [ "aeiou" ],
                    "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "avg_server_anomaly_score" : 1.3579000000000001069366817318950779736042022705078125,
                    "server_anomaly_scores" : [ {
                      "reason" : "aeiou",
                      "hs_entity" : "",
                      "score_data" : {
                        "anomalous_l4_metrics" : [ "aeiou" ],
                        "reason" : "aeiou",
                        "server" : "aeiou",
                        "ref" : "aeiou",
                        "anomalous_vm_metrics" : [ "aeiou" ],
                        "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "anomalous_l7_metrics" : [ "aeiou" ],
                        "per_anomalous_vm_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "reason_attr" : "aeiou",
                        "pool_uuid" : "aeiou"
                      },
                      "value" : 1.3579000000000001069366817318950779736042022705078125
                    } ]
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason_attr" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou"
          },
          "pool_anomaly" : "",
          "reason_attr" : "aeiou",
          "server_anomaly" : "",
          "serviceengine_anomaly" : "",
          "value" : 1.3579000000000001069366817318950779736042022705078125,
          "controller_anomaly" : {
            "per_anomalous_controller_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
            "reason" : "aeiou",
            "anomalous_controller_stats_metrics" : [ "aeiou" ],
            "reason_attr" : "aeiou",
            "uuid" : "aeiou"
          }
        },
        "resources_score" : {
          "serviceengine_resources" : "",
          "application_resources" : {
            "virtualservice_resources_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_resources_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "reason" : "aeiou",
                    "avg_server_resources_score" : 1.3579000000000001069366817318950779736042022705078125,
                    "ref" : "aeiou",
                    "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "server_resources_scores" : [ {
                      "reason" : "aeiou",
                      "hs_entity" : "",
                      "score_data" : {
                        "reason" : "aeiou",
                        "server" : "aeiou",
                        "avg_disk2_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "pct_open_conns" : 1.3579000000000001069366817318950779736042022705078125,
                        "ref" : "aeiou",
                        "avg_disk4_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_disk3_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                        "reason_attr" : "aeiou",
                        "pool_uuid" : "aeiou",
                        "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
                      },
                      "value" : 1.3579000000000001069366817318950779736042022705078125
                    } ]
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason" : "aeiou",
                "ha_index" : 1.3579000000000001069366817318950779736042022705078125,
                "ref" : "aeiou",
                "max_open_conns_usage" : 1.3579000000000001069366817318950779736042022705078125,
                "serviceengine_resources_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "reason" : "aeiou",
                    "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_persistent_table_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_packet_buffer_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "oper_state" : "aeiou",
                    "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_ssl_session_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_dynamic_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "ref" : "aeiou",
                    "pct_syn_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_shared_memory_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_connection_mem_usage" : 1.3579000000000001069366817318950779736042022705078125
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "avg_bandwidth_usage" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "multivip_index" : 1.3579000000000001069366817318950779736042022705078125
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou"
          },
          "reason" : "aeiou",
          "virtualservice_resources" : "",
          "server_resources" : "",
          "pool_resources" : "",
          "controller_resources" : {
            "reason" : "aeiou",
            "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
            "reason_attr" : "aeiou",
            "uuid" : "aeiou",
            "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "dos_attack_level" : 1.3579000000000001069366817318950779736042022705078125,
        "ssl_score" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "resources_penalty" : 123,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "resources_penalty_statistics" : "",
        "performance_score_statistics" : "",
        "metrics_min_scale" : 123,
        "units" : "aeiou",
        "anomaly_penalty_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
        },
        "pool_ref" : "aeiou",
        "entity_uuid" : "aeiou",
        "security_penalty_statistics" : "",
        "hs_type" : "aeiou",
        "name" : "aeiou",
        "contributors" : [ {
          "entities" : [ "" ],
          "hs_type" : "aeiou",
          "metric_ids" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "serviceengine_ref" : "aeiou",
        "statistics" : ""
      }
    } ],
    "start" : "aeiou",
    "step" : 123,
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

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

Responses

200

OK HealthScoreQueryResponseApiResponse

401

log in failed
Up 
get /analytics/healthscore/serviceengine/{uuid}
(analyticsHealthscoreServiceengineUuidGet)

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:

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.
detailed_header (optional)
Query Parameter — Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
Query Parameter — Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
Query Parameter — Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Query Parameter — Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Query Parameter — Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

HealthScoreQueryResponse

Example data

Content-Type: application/json
{
  "pool_ref" : "aeiou",
  "server" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "reason" : "aeiou",
      "performance_score" : {
        "reason" : "aeiou",
        "application_performance" : {
          "virtualservice_performance_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "reason" : "aeiou",
              "ref" : "aeiou",
              "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_performance_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                  "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou",
              "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
              "oper_state" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "serviceengine_performance" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "oper_state" : "aeiou"
        },
        "virtualservice_performance" : "",
        "pool_performance" : "",
        "server_performance" : {
          "reason" : "aeiou",
          "server" : "aeiou",
          "ref" : "aeiou",
          "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
          "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
          "oper_state" : "aeiou",
          "pool_uuid" : "aeiou"
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "is_null" : true,
      "performance_value" : 123,
      "security_threat_level" : {
        "reason" : "aeiou",
        "ssl_score_data" : {
          "reason" : "aeiou",
          "weak_signature_algorithm" : "aeiou",
          "deactivate_client_renegotiation" : true,
          "hsts_enabled_score" : 1.3579000000000001069366817318950779736042022705078125,
          "hsts_enabled" : true,
          "cert_chain_verified" : "aeiou",
          "pfs_support_score" : 1.3579000000000001069366817318950779736042022705078125,
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "pfs_support" : true,
          "value" : 1.3579000000000001069366817318950779736042022705078125,
          "deactivate_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_cipher_strength" : "aeiou",
          "earliest_cert_expiry" : "aeiou",
          "min_cipher_strength_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ssl_protocol_strength" : "aeiou",
          "cert_revoked_status" : "aeiou",
          "weak_signature_algorithm_score" : 1.3579000000000001069366817318950779736042022705078125,
          "weakest_enc_algo" : "aeiou",
          "cert_revoked_status_score" : 1.3579000000000001069366817318950779736042022705078125,
          "cert_chain_verified_score" : 1.3579000000000001069366817318950779736042022705078125,
          "ssl_enabled" : true,
          "weakest_enc_algo_score" : 1.3579000000000001069366817318950779736042022705078125,
          "earliest_cert_expiry_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ssl_protocol_strength_score" : 1.3579000000000001069366817318950779736042022705078125
        },
        "serviceengine_dos_attack_level_data" : "",
        "dos_attack_level_data" : {
          "pct_dos_rx_bytes" : 1.3579000000000001069366817318950779736042022705078125,
          "reason" : "aeiou",
          "avg_dos_total_req" : 1.3579000000000001069366817318950779736042022705078125,
          "avg_total_connections" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_connections_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_dos_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_policy_drops" : 1.3579000000000001069366817318950779736042022705078125,
          "serviceengine_dos_attack_level_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "pct_rx_pkts_dropped" : 1.3579000000000001069366817318950779736042022705078125,
              "reason" : "aeiou",
              "ref" : "aeiou",
              "avg_rx_pkts" : 1.3579000000000001069366817318950779736042022705078125,
              "pct_rx_bytes_dropped" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_connections" : 1.3579000000000001069366817318950779736042022705078125,
              "reason_attr" : "aeiou",
              "avg_rx_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
              "value" : 1.3579000000000001069366817318950779736042022705078125,
              "pct_connections_dropped" : 1.3579000000000001069366817318950779736042022705078125
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "pct_pkts_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_application_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "security_penalty" : 123,
      "anomaly_penalty" : 123,
      "anomaly_score" : {
        "reason" : "aeiou",
        "virtualservice_anomaly" : "",
        "application_anomaly" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "virtualservice_anomaly_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : {
              "pool_ref" : "aeiou",
              "server" : "aeiou",
              "entity_uuid" : "aeiou",
              "metrics_entity" : "aeiou"
            },
            "score_data" : {
              "anomalous_l4_metrics" : [ "aeiou" ],
              "reason" : "aeiou",
              "ref" : "aeiou",
              "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
              "anomalous_l7_metrics" : [ "aeiou" ],
              "serviceengine_anomaly_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "per_anomalous_vm_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "anomalous_se_stats_metrics" : [ "aeiou" ],
                  "per_anomalous_se_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "anomalous_vm_stats_metrics" : [ "aeiou" ],
                  "reason_attr" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_anomaly_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "anomalous_l4_metrics" : [ "aeiou" ],
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "anomalous_l7_metrics" : [ "aeiou" ],
                  "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "avg_server_anomaly_score" : 1.3579000000000001069366817318950779736042022705078125,
                  "server_anomaly_scores" : [ {
                    "reason" : "aeiou",
                    "hs_entity" : "",
                    "score_data" : {
                      "anomalous_l4_metrics" : [ "aeiou" ],
                      "reason" : "aeiou",
                      "server" : "aeiou",
                      "ref" : "aeiou",
                      "anomalous_vm_metrics" : [ "aeiou" ],
                      "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "anomalous_l7_metrics" : [ "aeiou" ],
                      "per_anomalous_vm_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "reason_attr" : "aeiou",
                      "pool_uuid" : "aeiou"
                    },
                    "value" : 1.3579000000000001069366817318950779736042022705078125
                  } ]
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason_attr" : "aeiou"
        },
        "pool_anomaly" : "",
        "reason_attr" : "aeiou",
        "server_anomaly" : "",
        "serviceengine_anomaly" : "",
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "controller_anomaly" : {
          "per_anomalous_controller_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
          "reason" : "aeiou",
          "anomalous_controller_stats_metrics" : [ "aeiou" ],
          "reason_attr" : "aeiou",
          "uuid" : "aeiou"
        }
      },
      "resources_score" : {
        "serviceengine_resources" : "",
        "application_resources" : {
          "virtualservice_resources_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "pool_resources_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "avg_server_resources_score" : 1.3579000000000001069366817318950779736042022705078125,
                  "ref" : "aeiou",
                  "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "server_resources_scores" : [ {
                    "reason" : "aeiou",
                    "hs_entity" : "",
                    "score_data" : {
                      "reason" : "aeiou",
                      "server" : "aeiou",
                      "avg_disk2_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "pct_open_conns" : 1.3579000000000001069366817318950779736042022705078125,
                      "ref" : "aeiou",
                      "avg_disk4_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_disk3_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                      "reason_attr" : "aeiou",
                      "pool_uuid" : "aeiou",
                      "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
                    },
                    "value" : 1.3579000000000001069366817318950779736042022705078125
                  } ]
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason" : "aeiou",
              "ha_index" : 1.3579000000000001069366817318950779736042022705078125,
              "ref" : "aeiou",
              "max_open_conns_usage" : 1.3579000000000001069366817318950779736042022705078125,
              "serviceengine_resources_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "reason" : "aeiou",
                  "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_persistent_table_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_packet_buffer_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou",
                  "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_ssl_session_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_dynamic_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "ref" : "aeiou",
                  "pct_syn_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_shared_memory_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_connection_mem_usage" : 1.3579000000000001069366817318950779736042022705078125
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "avg_bandwidth_usage" : 1.3579000000000001069366817318950779736042022705078125,
              "reason_attr" : "aeiou",
              "multivip_index" : 1.3579000000000001069366817318950779736042022705078125
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "reason" : "aeiou",
        "virtualservice_resources" : "",
        "server_resources" : "",
        "pool_resources" : "",
        "controller_resources" : {
          "reason" : "aeiou",
          "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "uuid" : "aeiou",
          "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "dos_attack_level" : 1.3579000000000001069366817318950779736042022705078125,
      "ssl_score" : 1.3579000000000001069366817318950779736042022705078125,
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "resources_penalty" : 123,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "resources_penalty_statistics" : "",
      "performance_score_statistics" : "",
      "metrics_min_scale" : 123,
      "units" : "aeiou",
      "anomaly_penalty_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
      },
      "pool_ref" : "aeiou",
      "entity_uuid" : "aeiou",
      "security_penalty_statistics" : "",
      "hs_type" : "aeiou",
      "name" : "aeiou",
      "contributors" : [ {
        "entities" : [ "" ],
        "hs_type" : "aeiou",
        "metric_ids" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "serviceengine_ref" : "aeiou",
      "statistics" : ""
    }
  } ],
  "start" : "aeiou",
  "step" : 123,
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

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

Responses

200

OK HealthScoreQueryResponse

401

log in failed
Up 
get /analytics/healthscore/virtualservice/
(analyticsHealthscoreVirtualserviceGet)

Consumes

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

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
detailed_header (optional)
Query Parameter — Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
Query Parameter — Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
Query Parameter — Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Query Parameter — Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Query Parameter — Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

HealthScoreQueryResponseApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "pool_ref" : "aeiou",
    "server" : "aeiou",
    "entity_uuid" : "aeiou",
    "stop" : "aeiou",
    "series" : [ {
      "data" : [ {
        "reason" : "aeiou",
        "performance_score" : {
          "reason" : "aeiou",
          "application_performance" : {
            "virtualservice_performance_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "reason" : "aeiou",
                "ref" : "aeiou",
                "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
                "pool_performance_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                    "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                    "oper_state" : "aeiou"
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason_attr" : "aeiou",
                "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                "oper_state" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou"
          },
          "serviceengine_performance" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "oper_state" : "aeiou"
          },
          "virtualservice_performance" : "",
          "pool_performance" : "",
          "server_performance" : {
            "reason" : "aeiou",
            "server" : "aeiou",
            "ref" : "aeiou",
            "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
            "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
            "reason_attr" : "aeiou",
            "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
            "oper_state" : "aeiou",
            "pool_uuid" : "aeiou"
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "is_null" : true,
        "performance_value" : 123,
        "security_threat_level" : {
          "reason" : "aeiou",
          "ssl_score_data" : {
            "reason" : "aeiou",
            "weak_signature_algorithm" : "aeiou",
            "deactivate_client_renegotiation" : true,
            "hsts_enabled_score" : 1.3579000000000001069366817318950779736042022705078125,
            "hsts_enabled" : true,
            "cert_chain_verified" : "aeiou",
            "pfs_support_score" : 1.3579000000000001069366817318950779736042022705078125,
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "pfs_support" : true,
            "value" : 1.3579000000000001069366817318950779736042022705078125,
            "deactivate_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_cipher_strength" : "aeiou",
            "earliest_cert_expiry" : "aeiou",
            "min_cipher_strength_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_ssl_protocol_strength" : "aeiou",
            "cert_revoked_status" : "aeiou",
            "weak_signature_algorithm_score" : 1.3579000000000001069366817318950779736042022705078125,
            "weakest_enc_algo" : "aeiou",
            "cert_revoked_status_score" : 1.3579000000000001069366817318950779736042022705078125,
            "cert_chain_verified_score" : 1.3579000000000001069366817318950779736042022705078125,
            "ssl_enabled" : true,
            "weakest_enc_algo_score" : 1.3579000000000001069366817318950779736042022705078125,
            "earliest_cert_expiry_score" : 1.3579000000000001069366817318950779736042022705078125,
            "min_ssl_protocol_strength_score" : 1.3579000000000001069366817318950779736042022705078125
          },
          "serviceengine_dos_attack_level_data" : "",
          "dos_attack_level_data" : {
            "pct_dos_rx_bytes" : 1.3579000000000001069366817318950779736042022705078125,
            "reason" : "aeiou",
            "avg_dos_total_req" : 1.3579000000000001069366817318950779736042022705078125,
            "avg_total_connections" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_connections_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_dos_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_policy_drops" : 1.3579000000000001069366817318950779736042022705078125,
            "serviceengine_dos_attack_level_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pct_rx_pkts_dropped" : 1.3579000000000001069366817318950779736042022705078125,
                "reason" : "aeiou",
                "ref" : "aeiou",
                "avg_rx_pkts" : 1.3579000000000001069366817318950779736042022705078125,
                "pct_rx_bytes_dropped" : 1.3579000000000001069366817318950779736042022705078125,
                "avg_connections" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "avg_rx_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
                "value" : 1.3579000000000001069366817318950779736042022705078125,
                "pct_connections_dropped" : 1.3579000000000001069366817318950779736042022705078125
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "pct_pkts_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "pct_application_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
            "ref" : "aeiou",
            "reason_attr" : "aeiou",
            "value" : 1.3579000000000001069366817318950779736042022705078125
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "security_penalty" : 123,
        "anomaly_penalty" : 123,
        "anomaly_score" : {
          "reason" : "aeiou",
          "virtualservice_anomaly" : "",
          "application_anomaly" : {
            "reason" : "aeiou",
            "ref" : "aeiou",
            "virtualservice_anomaly_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : {
                "pool_ref" : "aeiou",
                "server" : "aeiou",
                "entity_uuid" : "aeiou",
                "metrics_entity" : "aeiou"
              },
              "score_data" : {
                "anomalous_l4_metrics" : [ "aeiou" ],
                "reason" : "aeiou",
                "ref" : "aeiou",
                "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                "anomalous_l7_metrics" : [ "aeiou" ],
                "serviceengine_anomaly_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "per_anomalous_vm_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "anomalous_se_stats_metrics" : [ "aeiou" ],
                    "per_anomalous_se_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "anomalous_vm_stats_metrics" : [ "aeiou" ],
                    "reason_attr" : "aeiou"
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                "pool_anomaly_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "anomalous_l4_metrics" : [ "aeiou" ],
                    "reason" : "aeiou",
                    "ref" : "aeiou",
                    "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "anomalous_l7_metrics" : [ "aeiou" ],
                    "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "avg_server_anomaly_score" : 1.3579000000000001069366817318950779736042022705078125,
                    "server_anomaly_scores" : [ {
                      "reason" : "aeiou",
                      "hs_entity" : "",
                      "score_data" : {
                        "anomalous_l4_metrics" : [ "aeiou" ],
                        "reason" : "aeiou",
                        "server" : "aeiou",
                        "ref" : "aeiou",
                        "anomalous_vm_metrics" : [ "aeiou" ],
                        "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "anomalous_l7_metrics" : [ "aeiou" ],
                        "per_anomalous_vm_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                        "reason_attr" : "aeiou",
                        "pool_uuid" : "aeiou"
                      },
                      "value" : 1.3579000000000001069366817318950779736042022705078125
                    } ]
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason_attr" : "aeiou"
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason_attr" : "aeiou"
          },
          "pool_anomaly" : "",
          "reason_attr" : "aeiou",
          "server_anomaly" : "",
          "serviceengine_anomaly" : "",
          "value" : 1.3579000000000001069366817318950779736042022705078125,
          "controller_anomaly" : {
            "per_anomalous_controller_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
            "reason" : "aeiou",
            "anomalous_controller_stats_metrics" : [ "aeiou" ],
            "reason_attr" : "aeiou",
            "uuid" : "aeiou"
          }
        },
        "resources_score" : {
          "serviceengine_resources" : "",
          "application_resources" : {
            "virtualservice_resources_scores" : [ {
              "reason" : "aeiou",
              "hs_entity" : "",
              "score_data" : {
                "pool_resources_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "pool_ref" : "aeiou",
                    "reason" : "aeiou",
                    "avg_server_resources_score" : 1.3579000000000001069366817318950779736042022705078125,
                    "ref" : "aeiou",
                    "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "server_resources_scores" : [ {
                      "reason" : "aeiou",
                      "hs_entity" : "",
                      "score_data" : {
                        "reason" : "aeiou",
                        "server" : "aeiou",
                        "avg_disk2_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "pct_open_conns" : 1.3579000000000001069366817318950779736042022705078125,
                        "ref" : "aeiou",
                        "avg_disk4_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_disk3_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                        "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                        "reason_attr" : "aeiou",
                        "pool_uuid" : "aeiou",
                        "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
                      },
                      "value" : 1.3579000000000001069366817318950779736042022705078125
                    } ]
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "reason" : "aeiou",
                "ha_index" : 1.3579000000000001069366817318950779736042022705078125,
                "ref" : "aeiou",
                "max_open_conns_usage" : 1.3579000000000001069366817318950779736042022705078125,
                "serviceengine_resources_scores" : [ {
                  "reason" : "aeiou",
                  "hs_entity" : "",
                  "score_data" : {
                    "reason" : "aeiou",
                    "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_persistent_table_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_packet_buffer_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "oper_state" : "aeiou",
                    "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_ssl_session_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_dynamic_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "ref" : "aeiou",
                    "pct_syn_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_shared_memory_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "reason_attr" : "aeiou",
                    "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125,
                    "avg_connection_mem_usage" : 1.3579000000000001069366817318950779736042022705078125
                  },
                  "value" : 1.3579000000000001069366817318950779736042022705078125
                } ],
                "avg_bandwidth_usage" : 1.3579000000000001069366817318950779736042022705078125,
                "reason_attr" : "aeiou",
                "multivip_index" : 1.3579000000000001069366817318950779736042022705078125
              },
              "value" : 1.3579000000000001069366817318950779736042022705078125
            } ],
            "reason" : "aeiou",
            "ref" : "aeiou",
            "reason_attr" : "aeiou"
          },
          "reason" : "aeiou",
          "virtualservice_resources" : "",
          "server_resources" : "",
          "pool_resources" : "",
          "controller_resources" : {
            "reason" : "aeiou",
            "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
            "reason_attr" : "aeiou",
            "uuid" : "aeiou",
            "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
          },
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "dos_attack_level" : 1.3579000000000001069366817318950779736042022705078125,
        "ssl_score" : 1.3579000000000001069366817318950779736042022705078125,
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "resources_penalty" : 123,
        "num_samples" : 123,
        "timestamp" : "aeiou"
      } ],
      "header" : {
        "server" : "aeiou",
        "resources_penalty_statistics" : "",
        "performance_score_statistics" : "",
        "metrics_min_scale" : 123,
        "units" : "aeiou",
        "anomaly_penalty_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
        },
        "pool_ref" : "aeiou",
        "entity_uuid" : "aeiou",
        "security_penalty_statistics" : "",
        "hs_type" : "aeiou",
        "name" : "aeiou",
        "contributors" : [ {
          "entities" : [ "" ],
          "hs_type" : "aeiou",
          "metric_ids" : "aeiou"
        } ],
        "missing_intervals" : [ {
          "start" : "aeiou",
          "end" : "aeiou"
        } ],
        "serviceengine_ref" : "aeiou",
        "statistics" : ""
      }
    } ],
    "start" : "aeiou",
    "step" : 123,
    "metric_entity" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

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

Responses

200

OK HealthScoreQueryResponseApiResponse

401

log in failed
Up 
get /analytics/healthscore/virtualservice/{uuid}
(analyticsHealthscoreVirtualserviceUuidGet)

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:

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.
detailed_header (optional)
Query Parameter — Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
Query Parameter — UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
Query Parameter — Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Query Parameter — Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Query Parameter — Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Query Parameter — Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity (optional)
Query Parameter — Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
Query Parameter — Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Query Parameter — Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Query Parameter — Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
Query Parameter — Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
Query Parameter — Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Query Parameter — Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
stop (optional)
Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Query Parameter — Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
Query Parameter — UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Return type

HealthScoreQueryResponse

Example data

Content-Type: application/json
{
  "pool_ref" : "aeiou",
  "server" : "aeiou",
  "entity_uuid" : "aeiou",
  "stop" : "aeiou",
  "series" : [ {
    "data" : [ {
      "reason" : "aeiou",
      "performance_score" : {
        "reason" : "aeiou",
        "application_performance" : {
          "virtualservice_performance_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "reason" : "aeiou",
              "ref" : "aeiou",
              "vs_uptime" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
              "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "rum_apdexr" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_pool_performance_score" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_performance_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
                  "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou",
              "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
              "oper_state" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "serviceengine_performance" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "oper_state" : "aeiou"
        },
        "virtualservice_performance" : "",
        "pool_performance" : "",
        "server_performance" : {
          "reason" : "aeiou",
          "server" : "aeiou",
          "ref" : "aeiou",
          "apdexc" : 1.3579000000000001069366817318950779736042022705078125,
          "apdexr" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "sum_finished_conns" : 1.3579000000000001069366817318950779736042022705078125,
          "oper_state" : "aeiou",
          "pool_uuid" : "aeiou"
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "is_null" : true,
      "performance_value" : 123,
      "security_threat_level" : {
        "reason" : "aeiou",
        "ssl_score_data" : {
          "reason" : "aeiou",
          "weak_signature_algorithm" : "aeiou",
          "deactivate_client_renegotiation" : true,
          "hsts_enabled_score" : 1.3579000000000001069366817318950779736042022705078125,
          "hsts_enabled" : true,
          "cert_chain_verified" : "aeiou",
          "pfs_support_score" : 1.3579000000000001069366817318950779736042022705078125,
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "pfs_support" : true,
          "value" : 1.3579000000000001069366817318950779736042022705078125,
          "deactivate_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_cipher_strength" : "aeiou",
          "earliest_cert_expiry" : "aeiou",
          "min_cipher_strength_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ssl_protocol_strength" : "aeiou",
          "cert_revoked_status" : "aeiou",
          "weak_signature_algorithm_score" : 1.3579000000000001069366817318950779736042022705078125,
          "weakest_enc_algo" : "aeiou",
          "cert_revoked_status_score" : 1.3579000000000001069366817318950779736042022705078125,
          "cert_chain_verified_score" : 1.3579000000000001069366817318950779736042022705078125,
          "ssl_enabled" : true,
          "weakest_enc_algo_score" : 1.3579000000000001069366817318950779736042022705078125,
          "earliest_cert_expiry_score" : 1.3579000000000001069366817318950779736042022705078125,
          "min_ssl_protocol_strength_score" : 1.3579000000000001069366817318950779736042022705078125
        },
        "serviceengine_dos_attack_level_data" : "",
        "dos_attack_level_data" : {
          "pct_dos_rx_bytes" : 1.3579000000000001069366817318950779736042022705078125,
          "reason" : "aeiou",
          "avg_dos_total_req" : 1.3579000000000001069366817318950779736042022705078125,
          "avg_total_connections" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_connections_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_dos_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_policy_drops" : 1.3579000000000001069366817318950779736042022705078125,
          "serviceengine_dos_attack_level_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "pct_rx_pkts_dropped" : 1.3579000000000001069366817318950779736042022705078125,
              "reason" : "aeiou",
              "ref" : "aeiou",
              "avg_rx_pkts" : 1.3579000000000001069366817318950779736042022705078125,
              "pct_rx_bytes_dropped" : 1.3579000000000001069366817318950779736042022705078125,
              "avg_connections" : 1.3579000000000001069366817318950779736042022705078125,
              "reason_attr" : "aeiou",
              "avg_rx_bandwidth" : 1.3579000000000001069366817318950779736042022705078125,
              "value" : 1.3579000000000001069366817318950779736042022705078125,
              "pct_connections_dropped" : 1.3579000000000001069366817318950779736042022705078125
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "pct_pkts_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "pct_application_dos_attacks" : 1.3579000000000001069366817318950779736042022705078125,
          "ref" : "aeiou",
          "reason_attr" : "aeiou",
          "value" : 1.3579000000000001069366817318950779736042022705078125
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "security_penalty" : 123,
      "anomaly_penalty" : 123,
      "anomaly_score" : {
        "reason" : "aeiou",
        "virtualservice_anomaly" : "",
        "application_anomaly" : {
          "reason" : "aeiou",
          "ref" : "aeiou",
          "virtualservice_anomaly_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : {
              "pool_ref" : "aeiou",
              "server" : "aeiou",
              "entity_uuid" : "aeiou",
              "metrics_entity" : "aeiou"
            },
            "score_data" : {
              "anomalous_l4_metrics" : [ "aeiou" ],
              "reason" : "aeiou",
              "ref" : "aeiou",
              "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
              "anomalous_l7_metrics" : [ "aeiou" ],
              "serviceengine_anomaly_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "per_anomalous_vm_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "anomalous_se_stats_metrics" : [ "aeiou" ],
                  "per_anomalous_se_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "anomalous_vm_stats_metrics" : [ "aeiou" ],
                  "reason_attr" : "aeiou"
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
              "pool_anomaly_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "anomalous_l4_metrics" : [ "aeiou" ],
                  "reason" : "aeiou",
                  "ref" : "aeiou",
                  "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "anomalous_l7_metrics" : [ "aeiou" ],
                  "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "avg_server_anomaly_score" : 1.3579000000000001069366817318950779736042022705078125,
                  "server_anomaly_scores" : [ {
                    "reason" : "aeiou",
                    "hs_entity" : "",
                    "score_data" : {
                      "anomalous_l4_metrics" : [ "aeiou" ],
                      "reason" : "aeiou",
                      "server" : "aeiou",
                      "ref" : "aeiou",
                      "anomalous_vm_metrics" : [ "aeiou" ],
                      "per_anomalous_l4_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "anomalous_l7_metrics" : [ "aeiou" ],
                      "per_anomalous_vm_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "per_anomalous_l7_metrics" : 1.3579000000000001069366817318950779736042022705078125,
                      "reason_attr" : "aeiou",
                      "pool_uuid" : "aeiou"
                    },
                    "value" : 1.3579000000000001069366817318950779736042022705078125
                  } ]
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason_attr" : "aeiou"
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason_attr" : "aeiou"
        },
        "pool_anomaly" : "",
        "reason_attr" : "aeiou",
        "server_anomaly" : "",
        "serviceengine_anomaly" : "",
        "value" : 1.3579000000000001069366817318950779736042022705078125,
        "controller_anomaly" : {
          "per_anomalous_controller_stats_metrics" : 1.3579000000000001069366817318950779736042022705078125,
          "reason" : "aeiou",
          "anomalous_controller_stats_metrics" : [ "aeiou" ],
          "reason_attr" : "aeiou",
          "uuid" : "aeiou"
        }
      },
      "resources_score" : {
        "serviceengine_resources" : "",
        "application_resources" : {
          "virtualservice_resources_scores" : [ {
            "reason" : "aeiou",
            "hs_entity" : "",
            "score_data" : {
              "pool_resources_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "pool_ref" : "aeiou",
                  "reason" : "aeiou",
                  "avg_server_resources_score" : 1.3579000000000001069366817318950779736042022705078125,
                  "ref" : "aeiou",
                  "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "server_resources_scores" : [ {
                    "reason" : "aeiou",
                    "hs_entity" : "",
                    "score_data" : {
                      "reason" : "aeiou",
                      "server" : "aeiou",
                      "avg_disk2_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "pct_open_conns" : 1.3579000000000001069366817318950779736042022705078125,
                      "ref" : "aeiou",
                      "avg_disk4_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_disk3_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                      "avg_uptime" : 1.3579000000000001069366817318950779736042022705078125,
                      "reason_attr" : "aeiou",
                      "pool_uuid" : "aeiou",
                      "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
                    },
                    "value" : 1.3579000000000001069366817318950779736042022705078125
                  } ]
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "reason" : "aeiou",
              "ha_index" : 1.3579000000000001069366817318950779736042022705078125,
              "ref" : "aeiou",
              "max_open_conns_usage" : 1.3579000000000001069366817318950779736042022705078125,
              "serviceengine_resources_scores" : [ {
                "reason" : "aeiou",
                "hs_entity" : "",
                "score_data" : {
                  "reason" : "aeiou",
                  "avg_cpu_wait" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_persistent_table_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_packet_buffer_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "oper_state" : "aeiou",
                  "avg_disk1_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_ssl_session_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_dynamic_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "ref" : "aeiou",
                  "pct_syn_cache_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_shared_memory_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "reason_attr" : "aeiou",
                  "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125,
                  "avg_connection_mem_usage" : 1.3579000000000001069366817318950779736042022705078125
                },
                "value" : 1.3579000000000001069366817318950779736042022705078125
              } ],
              "avg_bandwidth_usage" : 1.3579000000000001069366817318950779736042022705078125,
              "reason_attr" : "aeiou",
              "multivip_index" : 1.3579000000000001069366817318950779736042022705078125
            },
            "value" : 1.3579000000000001069366817318950779736042022705078125
          } ],
          "reason" : "aeiou",
          "ref" : "aeiou",
          "reason_attr" : "aeiou"
        },
        "reason" : "aeiou",
        "virtualservice_resources" : "",
        "server_resources" : "",
        "pool_resources" : "",
        "controller_resources" : {
          "reason" : "aeiou",
          "avg_mem_usage" : 1.3579000000000001069366817318950779736042022705078125,
          "reason_attr" : "aeiou",
          "uuid" : "aeiou",
          "avg_cpu_usage" : 1.3579000000000001069366817318950779736042022705078125
        },
        "reason_attr" : "aeiou",
        "value" : 1.3579000000000001069366817318950779736042022705078125
      },
      "dos_attack_level" : 1.3579000000000001069366817318950779736042022705078125,
      "ssl_score" : 1.3579000000000001069366817318950779736042022705078125,
      "reason_attr" : "aeiou",
      "value" : 1.3579000000000001069366817318950779736042022705078125,
      "resources_penalty" : 123,
      "num_samples" : 123,
      "timestamp" : "aeiou"
    } ],
    "header" : {
      "server" : "aeiou",
      "resources_penalty_statistics" : "",
      "performance_score_statistics" : "",
      "metrics_min_scale" : 123,
      "units" : "aeiou",
      "anomaly_penalty_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
      },
      "pool_ref" : "aeiou",
      "entity_uuid" : "aeiou",
      "security_penalty_statistics" : "",
      "hs_type" : "aeiou",
      "name" : "aeiou",
      "contributors" : [ {
        "entities" : [ "" ],
        "hs_type" : "aeiou",
        "metric_ids" : "aeiou"
      } ],
      "missing_intervals" : [ {
        "start" : "aeiou",
        "end" : "aeiou"
      } ],
      "serviceengine_ref" : "aeiou",
      "statistics" : ""
    }
  } ],
  "start" : "aeiou",
  "step" : 123,
  "metric_entity" : "aeiou",
  "url" : "aeiou"
}

Produces

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

Responses

200

OK HealthScoreQueryResponse

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. ApplicationAnomalyScoreData
  2. ApplicationPerformanceScoreData
  3. ApplicationResourcesScoreData
  4. ControllerAnomalyScoreData
  5. ControllerResourcesScoreData
  6. DosAttackLevelData
  7. HealthScoreAnomalyData
  8. HealthScoreData
  9. HealthScoreDataSeries
  10. HealthScoreEntity
  11. HealthScoreHeader
  12. HealthScorePerformanceData
  13. HealthScoreQuery
  14. HealthScoreQueryResponse
  15. HealthScoreQueryResponseApiResponse
  16. HealthScoreResourcesData
  17. HealthScoreSecurityData
  18. HealthScoreTypeContributorData
  19. MetricStatistics
  20. MetricsMissingDataInterval
  21. PoolAnomalyScore
  22. PoolAnomalyScoreData
  23. PoolPerformanceScore
  24. PoolPerformanceScoreData
  25. PoolResourcesScore
  26. PoolResourcesScoreData
  27. ServerAnomalyScore
  28. ServerAnomalyScoreData
  29. ServerPerformanceScoreData
  30. ServerResourcesScore
  31. ServerResourcesScoreData
  32. ServiceEngineAnomalyScore
  33. ServiceEngineAnomalyScoreData
  34. ServiceEngineDosAttackLevel
  35. ServiceEngineDosAttackLevelData
  36. ServiceEnginePerformanceScoreData
  37. ServiceEngineResourcesScore
  38. ServiceEngineResourcesScoreData
  39. SslScoreData
  40. VirtualServiceAnomalyScore
  41. VirtualServiceAnomalyScoreData
  42. VirtualServicePerformanceScore
  43. VirtualServicePerformanceScoreData
  44. VirtualServiceResourcesScore
  45. VirtualServiceResourcesScoreData

ApplicationAnomalyScoreData Up

reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type Application. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
virtualservice_anomaly_scores (optional)
array[VirtualServiceAnomalyScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ApplicationPerformanceScoreData Up

reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type Application. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
virtualservice_performance_scores (optional)
array[VirtualServicePerformanceScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ApplicationResourcesScoreData Up

reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type Application. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
virtualservice_resources_scores (optional)
array[VirtualServiceResourcesScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ControllerAnomalyScoreData Up

anomalous_controller_stats_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
per_anomalous_controller_stats_metrics
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ControllerResourcesScoreData Up

avg_cpu_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_mem_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
uuid (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

DosAttackLevelData Up

avg_dos_total_req (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_total_connections (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_application_dos_attacks (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_connections_dos_attacks (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_dos_bandwidth (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_dos_rx_bytes (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_pkts_dos_attacks (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_policy_drops (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the DoS Attack Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the DoS Attack Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_dos_attack_level_scores (optional)
array[ServiceEngineDosAttackLevel] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

HealthScoreAnomalyData Up

application_anomaly (optional)
ApplicationAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_anomaly (optional)
ControllerAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_anomaly (optional)
PoolAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for Anomaly Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_anomaly (optional)
ServerAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_anomaly (optional)
ServiceEngineAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
virtualservice_anomaly (optional)
VirtualServiceAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreData Up

anomaly_penalty (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
anomaly_score (optional)
HealthScoreAnomalyData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
dos_attack_level (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
is_null (optional)
Boolean This is set if the data is none or zero is none. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_samples (optional)
Integer This keeps the num samples reported during aggregation queries. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
performance_score (optional)
HealthScorePerformanceData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
performance_value (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resources_penalty (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
resources_score (optional)
HealthScoreResourcesData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
security_penalty (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
security_threat_level (optional)
HealthScoreSecurityData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_score (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
timestamp (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

HealthScoreDataSeries Up

data (optional)
array[HealthScoreData] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
header
HealthScoreHeader Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreEntity Up

entity_uuid
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metrics_entity
String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_ref (optional)
String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreHeader Up

anomaly_penalty_statistics (optional)
MetricStatistics Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
contributors (optional)
array[HealthScoreTypeContributorData] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid (optional)
String uuid of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
String Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metrics_min_scale (optional)
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
missing_intervals (optional)
array[MetricsMissingDataInterval] Missing data intervals. data in these intervals are not used for stats calculation. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name (optional)
String Health Score metric name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
performance_score_statistics (optional)
MetricStatistics Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_ref (optional)
String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
resources_penalty_statistics (optional)
MetricStatistics Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
security_penalty_statistics (optional)
MetricStatistics Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
statistics (optional)
MetricStatistics Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScorePerformanceData Up

application_performance (optional)
ApplicationPerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_performance (optional)
PoolPerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for Performance Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_performance (optional)
ServerPerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_performance (optional)
ServiceEnginePerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
virtualservice_performance (optional)
VirtualServicePerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreQuery Up

detailed_header (optional)
Boolean Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
entity_uuid
String UUID of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type (optional)
String Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_refs (optional)
Boolean Resolve uuid to references?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
include_statistics (optional)
Boolean Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
limit (optional)
Integer Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
metric_entity
String Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
order_series_by (optional)
String Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pad_missing_data (optional)
Boolean Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
patch_oper_status (optional)
Boolean Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid (optional)
String Pool name. This will apply to any backend stats that are specified in the query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
result_format (optional)
String Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
String Object id like vip or server ip port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start (optional)
String Start time for the metrics in ISO 8601 format. Default is UNIX Epoch. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step (optional)
Integer Step interval in seconds. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
stop (optional)
String End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
summary (optional)
Boolean Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_uuid (optional)
String UUID of the Tenant. . Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreQueryResponse Up

entity_uuid
String uuid of the entity type. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_entity
String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_ref (optional)
String Pool name. This will apply to any back end statistics that are specified in the query. It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
series (optional)
array[HealthScoreDataSeries] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
String server name or ip. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
step
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
stop
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url

HealthScoreQueryResponseApiResponse Up

count
Integer format: int32
results
array[HealthScoreQueryResponse]
next (optional)
String

HealthScoreResourcesData Up

application_resources (optional)
ApplicationResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_resources (optional)
ControllerResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_resources (optional)
PoolResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for Resources Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_resources (optional)
ServerResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_resources (optional)
ServiceEngineResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
virtualservice_resources (optional)
VirtualServiceResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HealthScoreSecurityData Up

dos_attack_level_data (optional)
DosAttackLevelData Threat associated with VirtualService DoS infrastructure. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason (optional)
String Reason for Security Threat Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_dos_attack_level_data (optional)
ServiceEngineDosAttackLevelData Threat associated with ServiceEngine DoS infrastructure. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_score_data (optional)
SslScoreData Threat associated with VirtualService SSL infrastructure. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

HealthScoreTypeContributorData Up

entities (optional)
array[HealthScoreEntity] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hs_type
String Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
metric_ids (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MetricStatistics Up

last_sample (optional)
Double value of the last sample. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
max (optional)
Double maximum value in time series requested. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
max_ts (optional)
String timestamp of the minimum value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mean (optional)
Double arithmetic mean. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min (optional)
Double minimum value in time series requested. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min_ts (optional)
String timestamp of the minimum value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
num_samples (optional)
Integer Number of actual data samples. It excludes fake data. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
sum (optional)
Double summation of all values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
trend (optional)
Double slope of the data points across the time series requested. trend = (last_value - avg)/avg. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

MetricsMissingDataInterval Up

end
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
start
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PoolAnomalyScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
PoolAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

PoolAnomalyScoreData Up

anomalous_l4_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
anomalous_l7_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
avg_server_anomaly_score (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
per_anomalous_l4_metrics
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
per_anomalous_l7_metrics (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pool_ref
String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_anomaly_scores (optional)
array[ServerAnomalyScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PoolPerformanceScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
PoolPerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

PoolPerformanceScoreData Up

apdexc (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
apdexr (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
oper_state (optional)
String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_ref
String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sum_finished_conns (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

PoolResourcesScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
PoolResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

PoolResourcesScoreData Up

avg_server_resources_score (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_uptime (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pool_ref
String It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server_resources_scores (optional)
array[ServerResourcesScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServerAnomalyScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
ServerAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServerAnomalyScoreData Up

anomalous_l4_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
anomalous_l7_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
anomalous_vm_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
per_anomalous_l4_metrics
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
per_anomalous_l7_metrics (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
per_anomalous_vm_metrics (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pool_uuid
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServerPerformanceScoreData Up

apdexc (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
apdexr (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
oper_state (optional)
String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_uuid
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
sum_finished_conns (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServerResourcesScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
ServerResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServerResourcesScoreData Up

avg_cpu_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_cpu_wait (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_disk1_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_disk2_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_disk3_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_disk4_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_mem_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_uptime (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_open_conns (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pool_uuid
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServiceEngineAnomalyScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
ServiceEngineAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServiceEngineAnomalyScoreData Up

anomalous_se_stats_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
anomalous_vm_stats_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
per_anomalous_se_stats_metrics
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
per_anomalous_vm_stats_metrics (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServiceEngineDosAttackLevel Up

hs_entity (optional)
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
ServiceEngineDosAttackLevelData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServiceEngineDosAttackLevelData Up

avg_connections (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_rx_bandwidth (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_rx_pkts (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_connections_dropped (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_rx_bytes_dropped (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pct_rx_pkts_dropped (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the SE DoS Attack Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the DoS Attack Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServiceEnginePerformanceScoreData Up

oper_state (optional)
String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Performance Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the performance score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ServiceEngineResourcesScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
ServiceEngineResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

ServiceEngineResourcesScoreData Up

avg_connection_mem_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_cpu_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_cpu_wait (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_disk1_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_dynamic_mem_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_mem_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_packet_buffer_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_persistent_table_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_shared_memory_usage (optional)
Double Use shared memory usage in computation of SE resource penalty. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_ssl_session_cache_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
oper_state (optional)
String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pct_syn_cache_usage (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type ServiceEngine. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SslScoreData Up

cert_chain_verified (optional)
String Chains for all certificates are verified. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cert_chain_verified_score (optional)
Double Score Chains for all certificates are verified. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
cert_revoked_status (optional)
String Certificate revoked status by OCSP Responder. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cert_revoked_status_score (optional)
Double Score Certficate Revoked for VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
deactivate_client_renegotiation (optional)
Boolean Deactivate client renegotiation. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
deactivate_client_renegotiation_score (optional)
Double Score Deactivate client renegotiation. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: double
earliest_cert_expiry (optional)
String Earliest certificate expiration time. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
earliest_cert_expiry_score (optional)
Double Score Earliest certificate expiration time. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
hsts_enabled (optional)
Boolean HSTS enabled for VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hsts_enabled_score (optional)
Double Score HSTS enabled for VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min_cipher_strength (optional)
String Strength of the weakest symmetric encryption algorithm. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
min_cipher_strength_score (optional)
Double Score Strength of the weakest symmetric encryption algorithm. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
min_ssl_protocol_strength (optional)
String Weakest SSL protocol supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
min_ssl_protocol_strength_score (optional)
Double Score Weakest SSL protocol supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pfs_support (optional)
Boolean Is a PFS cipher suite supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pfs_support_score (optional)
Double Score Is a PFS cipher suite supported. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
reason
String Reason for the SSL Config Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the SSL Config Level. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ssl_enabled (optional)
Boolean Set whether the SSL service is enabled for the VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
weak_signature_algorithm (optional)
String Weak algorithm used for signing the certificate, amongst all certificates for the VS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
weak_signature_algorithm_score (optional)
Double Score Weak algorithm used for signing the certificate. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
weakest_enc_algo (optional)
String Weakest algorithm for symmetric encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
weakest_enc_algo_score (optional)
Double Score Weakest algorithm for symmetric encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

VirtualServiceAnomalyScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
VirtualServiceAnomalyScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

VirtualServiceAnomalyScoreData Up

anomalous_l4_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
anomalous_l7_metrics (optional)
array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
per_anomalous_l4_metrics (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
per_anomalous_l7_metrics (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pool_anomaly_scores (optional)
array[PoolAnomalyScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_anomaly_scores (optional)
array[ServiceEngineAnomalyScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

VirtualServicePerformanceScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
VirtualServicePerformanceScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

VirtualServicePerformanceScoreData Up

apdexc (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
apdexr (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
avg_pool_performance_score (optional)
Double Average of all pool performance scores. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
oper_state
String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_performance_scores (optional)
array[PoolPerformanceScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rum_apdexr (optional)
Double Rum Apdexr when client insights is active. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
sum_finished_conns (optional)
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
vs_uptime (optional)
Double Percentage time of last 5mins that the VirtualService has been up. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

VirtualServiceResourcesScore Up

hs_entity
HealthScoreEntity Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
score_data (optional)
VirtualServiceResourcesScoreData Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value
Double Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double

VirtualServiceResourcesScoreData Up

avg_bandwidth_usage (optional)
Double Resources of the virtual service with respect to max_throughput. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
ha_index (optional)
Double Fraction of service engines available. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
max_open_conns_usage (optional)
Double Resources of the virtual service with respect to max_open_conns. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
multivip_index (optional)
Double Fraction of VIPs available, given a VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: double
pool_resources_scores (optional)
array[PoolResourcesScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason
String Reason for the Health Score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
reason_attr (optional)
String Attribute that is dominating the health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ref (optional)
String It is a reference to an object of type VirtualService. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
serviceengine_resources_scores (optional)
array[ServiceEngineResourcesScore] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.