Avi Object API

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

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

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

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /analytics/healthscore/pool/
get /analytics/healthscore/pool/{uuid}
get /analytics/healthscore/serviceengine/
get /analytics/healthscore/serviceengine/{uuid}
get /analytics/healthscore/virtualservice/
get /analytics/healthscore/virtualservice/{uuid}

get /analytics/healthscore/pool/

(analyticsHealthscorePoolGet)

Consumes

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

application/json

Query parameters

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

detailed_header (optional)

Query Parameter — Return detailed header with information like contributors etc.?.

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.

entity_uuid (optional)

Query Parameter — UUID of the entity type.

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.

include_refs (optional)

Query Parameter — Resolve uuid to references?.

include_statistics (optional)

Query Parameter — Include statistics when no filters specified?.

limit (optional)

Query Parameter — Max number of metric samples to be returned in the response.

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.

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.

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.

patch_oper_status (optional)

Query Parameter — Patch health score with operational data?.

pool_uuid (optional)

Query Parameter — Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

Query Parameter — Object id like vip or server ip port.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Query Parameter — Step interval in seconds.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Query Parameter — Return only summary for health score.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

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",
            "disable_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
            "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",
            "disable_client_renegotiation" : true,
            "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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK HealthScoreQueryResponseApiResponse

401

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:

application/json

Query parameters

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

detailed_header (optional)

Query Parameter — Return detailed header with information like contributors etc.?.

dimension_aggregation (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity type.

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.

include_refs (optional)

Query Parameter — Resolve uuid to references?.

include_statistics (optional)

Query Parameter — Include statistics when no filters specified?.

limit (optional)

Query Parameter — Max number of metric samples to be returned in the response.

metric_entity (optional)

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.

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.

patch_oper_status (optional)

Query Parameter — Patch health score with operational data?.

pool_uuid (optional)

Query Parameter — Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

Query Parameter — Object id like vip or server ip port.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Query Parameter — Step interval in seconds.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Query Parameter — Return only summary for health score.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

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",
          "disable_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
          "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",
          "disable_client_renegotiation" : true,
          "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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK HealthScoreQueryResponse

401

get /analytics/healthscore/serviceengine/

(analyticsHealthscoreServiceengineGet)

Consumes

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

application/json

Query parameters

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

detailed_header (optional)

Query Parameter — Return detailed header with information like contributors etc.?.

dimension_aggregation (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity type.

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.

include_refs (optional)

Query Parameter — Resolve uuid to references?.

include_statistics (optional)

Query Parameter — Include statistics when no filters specified?.

limit (optional)

Query Parameter — Max number of metric samples to be returned in the response.

metric_entity (optional)

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.

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.

patch_oper_status (optional)

Query Parameter — Patch health score with operational data?.

pool_uuid (optional)

Query Parameter — Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

Query Parameter — Object id like vip or server ip port.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Query Parameter — Step interval in seconds.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Query Parameter — Return only summary for health score.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

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",
            "disable_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
            "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",
            "disable_client_renegotiation" : true,
            "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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK HealthScoreQueryResponseApiResponse

401

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:

application/json

Query parameters

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

detailed_header (optional)

Query Parameter — Return detailed header with information like contributors etc.?.

dimension_aggregation (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity type.

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.

include_refs (optional)

Query Parameter — Resolve uuid to references?.

include_statistics (optional)

Query Parameter — Include statistics when no filters specified?.

limit (optional)

Query Parameter — Max number of metric samples to be returned in the response.

metric_entity (optional)

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.

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.

patch_oper_status (optional)

Query Parameter — Patch health score with operational data?.

pool_uuid (optional)

Query Parameter — Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

Query Parameter — Object id like vip or server ip port.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Query Parameter — Step interval in seconds.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Query Parameter — Return only summary for health score.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

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",
          "disable_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
          "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",
          "disable_client_renegotiation" : true,
          "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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK HealthScoreQueryResponse

401

get /analytics/healthscore/virtualservice/

(analyticsHealthscoreVirtualserviceGet)

Consumes

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

application/json

Query parameters

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

name (optional)

Query Parameter — object name

detailed_header (optional)

Query Parameter — Return detailed header with information like contributors etc.?.

dimension_aggregation (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity type.

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.

include_refs (optional)

Query Parameter — Resolve uuid to references?.

include_statistics (optional)

Query Parameter — Include statistics when no filters specified?.

limit (optional)

Query Parameter — Max number of metric samples to be returned in the response.

metric_entity (optional)

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.

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.

patch_oper_status (optional)

Query Parameter — Patch health score with operational data?.

pool_uuid (optional)

Query Parameter — Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

Query Parameter — Object id like vip or server ip port.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Query Parameter — Step interval in seconds.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Query Parameter — Return only summary for health score.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

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",
            "disable_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
            "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",
            "disable_client_renegotiation" : true,
            "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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK HealthScoreQueryResponseApiResponse

401

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:

application/json

Query parameters

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

detailed_header (optional)

Query Parameter — Return detailed header with information like contributors etc.?.

dimension_aggregation (optional)

entity_uuid (optional)

Query Parameter — UUID of the entity type.

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.

include_refs (optional)

Query Parameter — Resolve uuid to references?.

include_statistics (optional)

Query Parameter — Include statistics when no filters specified?.

limit (optional)

Query Parameter — Max number of metric samples to be returned in the response.

metric_entity (optional)

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.

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.

patch_oper_status (optional)

Query Parameter — Patch health score with operational data?.

pool_uuid (optional)

Query Parameter — Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

Query Parameter — Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

Query Parameter — Object id like vip or server ip port.

start (optional)

Query Parameter — Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Query Parameter — Step interval in seconds.

stop (optional)

Query Parameter — End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Query Parameter — Return only summary for health score.

tenant_uuid (optional)

Query Parameter — UUID of the Tenant. .

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",
          "disable_client_renegotiation_score" : 1.3579000000000001069366817318950779736042022705078125,
          "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",
          "disable_client_renegotiation" : true,
          "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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK HealthScoreQueryResponse

401

Models

[ Jump to Methods ]

ApplicationAnomalyScoreData
ApplicationPerformanceScoreData
ApplicationResourcesScoreData
ControllerAnomalyScoreData
ControllerResourcesScoreData
DosAttackLevelData
HealthScoreAnomalyData
HealthScoreData
HealthScoreDataSeries
HealthScoreEntity
HealthScoreHeader
HealthScorePerformanceData
HealthScoreQuery
HealthScoreQueryResponse
HealthScoreQueryResponseApiResponse
HealthScoreResourcesData
HealthScoreSecurityData
HealthScoreTypeContributorData
MetricStatistics
MetricsMissingDataInterval
PoolAnomalyScore
PoolAnomalyScoreData
PoolPerformanceScore
PoolPerformanceScoreData
PoolResourcesScore
PoolResourcesScoreData
ServerAnomalyScore
ServerAnomalyScoreData
ServerPerformanceScoreData
ServerResourcesScore
ServerResourcesScoreData
ServiceEngineAnomalyScore
ServiceEngineAnomalyScoreData
ServiceEngineDosAttackLevel
ServiceEngineDosAttackLevelData
ServiceEnginePerformanceScoreData
ServiceEngineResourcesScore
ServiceEngineResourcesScoreData
SslScoreData
VirtualServiceAnomalyScore
VirtualServiceAnomalyScoreData
VirtualServicePerformanceScore
VirtualServicePerformanceScoreData
VirtualServiceResourcesScore
VirtualServiceResourcesScoreData

ApplicationAnomalyScoreData Up

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type Application.

virtualservice_anomaly_scores (optional)

array[VirtualServiceAnomalyScore] Placeholder for description of property virtualservice_anomaly_scores of obj type ApplicationAnomalyScoreData field type str type object

ApplicationPerformanceScoreData Up

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type Application.

virtualservice_performance_scores (optional)

array[VirtualServicePerformanceScore] Placeholder for description of property virtualservice_performance_scores of obj type ApplicationPerformanceScoreData field type str type object

ApplicationResourcesScoreData Up

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type Application.

virtualservice_resources_scores (optional)

array[VirtualServiceResourcesScore] Placeholder for description of property virtualservice_resources_scores of obj type ApplicationResourcesScoreData field type str type object

ControllerAnomalyScoreData Up

anomalous_controller_stats_metrics (optional)

array[String] anomalous_controller_stats_metrics of ControllerAnomalyScoreData.

per_anomalous_controller_stats_metrics

Double Placeholder for description of property per_anomalous_controller_stats_metrics of obj type ControllerAnomalyScoreData field type str type number format: double

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

uuid (optional)

String Unique object identifier of the object.

ControllerResourcesScoreData Up

avg_cpu_usage (optional)

Double Placeholder for description of property avg_cpu_usage of obj type ControllerResourcesScoreData field type str type number format: double

avg_mem_usage (optional)

Double Placeholder for description of property avg_mem_usage of obj type ControllerResourcesScoreData field type str type number format: double

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

uuid (optional)

String Unique object identifier of the object.

DosAttackLevelData Up

avg_dos_total_req (optional)

Double Placeholder for description of property avg_dos_total_req of obj type DosAttackLevelData field type str type number format: double

avg_total_connections (optional)

Double Placeholder for description of property avg_total_connections of obj type DosAttackLevelData field type str type number format: double

pct_application_dos_attacks (optional)

Double Placeholder for description of property pct_application_dos_attacks of obj type DosAttackLevelData field type str type number format: double

pct_connections_dos_attacks (optional)

Double Placeholder for description of property pct_connections_dos_attacks of obj type DosAttackLevelData field type str type number format: double

pct_dos_bandwidth (optional)

Double Placeholder for description of property pct_dos_bandwidth of obj type DosAttackLevelData field type str type number format: double

pct_dos_rx_bytes (optional)

Double Placeholder for description of property pct_dos_rx_bytes of obj type DosAttackLevelData field type str type number format: double

pct_pkts_dos_attacks (optional)

Double Placeholder for description of property pct_pkts_dos_attacks of obj type DosAttackLevelData field type str type number format: double

pct_policy_drops (optional)

Double Placeholder for description of property pct_policy_drops of obj type DosAttackLevelData field type str type number format: double

reason

String Reason for the DoS Attack Level.

reason_attr (optional)

String Attribute that is dominating the DoS Attack Level.

ref (optional)

String It is a reference to an object of type VirtualService.

serviceengine_dos_attack_level_scores (optional)

array[ServiceEngineDosAttackLevel] Placeholder for description of property serviceengine_dos_attack_level_scores of obj type DosAttackLevelData field type str type object

value (optional)

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

HealthScoreAnomalyData Up

application_anomaly (optional)

ApplicationAnomalyScoreData Placeholder for description of property application_anomaly of obj type HealthScoreAnomalyData field type str type object

controller_anomaly (optional)

ControllerAnomalyScoreData Placeholder for description of property controller_anomaly of obj type HealthScoreAnomalyData field type str type object

pool_anomaly (optional)

PoolAnomalyScoreData Placeholder for description of property pool_anomaly of obj type HealthScoreAnomalyData field type str type object

reason

String Reason for Anomaly Score.

reason_attr (optional)

String reason_attr of HealthScoreAnomalyData.

server_anomaly (optional)

ServerAnomalyScoreData Placeholder for description of property server_anomaly of obj type HealthScoreAnomalyData field type str type object

serviceengine_anomaly (optional)

ServiceEngineAnomalyScoreData Placeholder for description of property serviceengine_anomaly of obj type HealthScoreAnomalyData field type str type object

value

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

virtualservice_anomaly (optional)

VirtualServiceAnomalyScoreData Placeholder for description of property virtualservice_anomaly of obj type HealthScoreAnomalyData field type str type object

HealthScoreData Up

anomaly_penalty (optional)

Integer Number of anomaly_penalty. format: int32

anomaly_score (optional)

HealthScoreAnomalyData Placeholder for description of property anomaly_score of obj type HealthScoreData field type str type object

dos_attack_level (optional)

Double Placeholder for description of property dos_attack_level of obj type HealthScoreData field type str type number format: double

is_null (optional)

Boolean This is set if the data is none or zero is none.

num_samples (optional)

Integer This keeps the num samples reported during aggregation queries. format: int32

performance_score (optional)

HealthScorePerformanceData Placeholder for description of property performance_score of obj type HealthScoreData field type str type object

performance_value (optional)

Integer Number of performance_value. format: int32

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

resources_penalty (optional)

Integer Number of resources_penalty. format: int32

resources_score (optional)

HealthScoreResourcesData Placeholder for description of property resources_score of obj type HealthScoreData field type str type object

security_penalty (optional)

Integer Number of security_penalty. format: int32

security_threat_level (optional)

HealthScoreSecurityData Placeholder for description of property security_threat_level of obj type HealthScoreData field type str type object

ssl_score (optional)

Double Placeholder for description of property ssl_score of obj type HealthScoreData field type str type number format: double

timestamp (optional)

String timestamp of HealthScoreData.

value

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

HealthScoreDataSeries Up

data (optional)

array[HealthScoreData] Placeholder for description of property data of obj type HealthScoreDataSeries field type str type object

header

HealthScoreHeader Placeholder for description of property header of obj type HealthScoreDataSeries field type str type object

HealthScoreEntity Up

entity_uuid

String Unique object identifier of entity.

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.

pool_ref (optional)

String It is a reference to an object of type Pool.

server (optional)

String server of HealthScoreEntity.

HealthScoreHeader Up

anomaly_penalty_statistics (optional)

MetricStatistics Placeholder for description of property anomaly_penalty_statistics of obj type HealthScoreHeader field type str type object

contributors (optional)

array[HealthScoreTypeContributorData] Placeholder for description of property contributors of obj type HealthScoreHeader field type str type object

entity_uuid (optional)

String uuid of the entity type.

hs_type (optional)

String Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL.

metrics_min_scale (optional)

Integer Number of metrics_min_scale. format: int32

missing_intervals (optional)

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

name (optional)

String Health Score metric name.

performance_score_statistics (optional)

MetricStatistics Placeholder for description of property performance_score_statistics of obj type HealthScoreHeader field type str type object

pool_ref (optional)

String It is a reference to an object of type Pool.

resources_penalty_statistics (optional)

MetricStatistics Placeholder for description of property resources_penalty_statistics of obj type HealthScoreHeader field type str type object

security_penalty_statistics (optional)

MetricStatistics Placeholder for description of property security_penalty_statistics of obj type HealthScoreHeader field type str type object

server (optional)

String server of HealthScoreHeader.

serviceengine_ref (optional)

String It is a reference to an object of type ServiceEngine.

statistics (optional)

MetricStatistics Placeholder for description of property statistics of obj type HealthScoreHeader field type str type object

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.

HealthScorePerformanceData Up

application_performance (optional)

ApplicationPerformanceScoreData Placeholder for description of property application_performance of obj type HealthScorePerformanceData field type str type object

pool_performance (optional)

PoolPerformanceScoreData Placeholder for description of property pool_performance of obj type HealthScorePerformanceData field type str type object

reason

String Reason for Performance Score.

reason_attr (optional)

String reason_attr of HealthScorePerformanceData.

server_performance (optional)

ServerPerformanceScoreData Placeholder for description of property server_performance of obj type HealthScorePerformanceData field type str type object

serviceengine_performance (optional)

ServiceEnginePerformanceScoreData Placeholder for description of property serviceengine_performance of obj type HealthScorePerformanceData field type str type object

value

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

virtualservice_performance (optional)

VirtualServicePerformanceScoreData Placeholder for description of property virtualservice_performance of obj type HealthScorePerformanceData field type str type object

HealthScoreQuery Up

detailed_header (optional)

Boolean Return detailed header with information like contributors etc.?.

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.

entity_uuid

String UUID of the entity type.

hs_type (optional)

String Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL.

include_refs (optional)

Boolean Resolve uuid to references?.

include_statistics (optional)

Boolean Include statistics when no filters specified?.

limit (optional)

Integer Max number of metric samples to be returned in the response. 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.

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.

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.

patch_oper_status (optional)

Boolean Patch health score with operational data?.

pool_uuid (optional)

String Pool name. This will apply to any backend stats that are specified in the query.

result_format (optional)

String Format of the data returned. Enum options - METRICS_FORMAT_JSON, METRICS_FORMAT_CSV, METRICS_FORMAT_TXT, METRICS_FORMAT_PROTOBUF.

server (optional)

String Object id like vip or server ip port.

start (optional)

String Start time for the metrics in ISO 8601 format. Default is UNIX Epoch.

step (optional)

Integer Step interval in seconds. format: int32

stop (optional)

String End time for the metrics in ISO 8601 format. Default is now. Negative numbers mean relative time from now.

summary (optional)

Boolean Return only summary for health score.

tenant_uuid (optional)

String UUID of the Tenant. .

HealthScoreQueryResponse Up

entity_uuid

String uuid of the entity type.

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.

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.

series (optional)

array[HealthScoreDataSeries] Placeholder for description of property series of obj type HealthScoreQueryResponse field type str type object

server (optional)

String server name or ip.

start

String start of HealthScoreQueryResponse.

step

Integer Number of step. format: int32

stop

String stop of HealthScoreQueryResponse.

url (optional)

String url

HealthScoreQueryResponseApiResponse Up

count

Integer format: int32

results

array[HealthScoreQueryResponse]

next (optional)

String

HealthScoreResourcesData Up

application_resources (optional)

ApplicationResourcesScoreData Placeholder for description of property application_resources of obj type HealthScoreResourcesData field type str type object

controller_resources (optional)

ControllerResourcesScoreData Placeholder for description of property controller_resources of obj type HealthScoreResourcesData field type str type object

pool_resources (optional)

PoolResourcesScoreData Placeholder for description of property pool_resources of obj type HealthScoreResourcesData field type str type object

reason

String Reason for Resources Score.

reason_attr (optional)

String reason_attr of HealthScoreResourcesData.

server_resources (optional)

ServerResourcesScoreData Placeholder for description of property server_resources of obj type HealthScoreResourcesData field type str type object

serviceengine_resources (optional)

ServiceEngineResourcesScoreData Placeholder for description of property serviceengine_resources of obj type HealthScoreResourcesData field type str type object

value

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

virtualservice_resources (optional)

VirtualServiceResourcesScoreData Placeholder for description of property virtualservice_resources of obj type HealthScoreResourcesData field type str type object

HealthScoreSecurityData Up

dos_attack_level_data (optional)

DosAttackLevelData Threat associated with VirtualService DoS infrastructure.

reason (optional)

String Reason for Security Threat Level.

reason_attr (optional)

String reason_attr of HealthScoreSecurityData.

serviceengine_dos_attack_level_data (optional)

ServiceEngineDosAttackLevelData Threat associated with ServiceEngine DoS infrastructure.

ssl_score_data (optional)

SslScoreData Threat associated with VirtualService SSL infrastructure.

value (optional)

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

HealthScoreTypeContributorData Up

entities (optional)

array[HealthScoreEntity] Placeholder for description of property entities of obj type HealthScoreTypeContributorData field type str type object

hs_type

String Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL.

metric_ids (optional)

String metric_ids of HealthScoreTypeContributorData.

MetricStatistics Up

last_sample (optional)

Double value of the last sample. format: double

max (optional)

Double maximum value in time series requested. format: double

max_ts (optional)

String timestamp of the minimum value.

mean (optional)

Double arithmetic mean. format: double

min (optional)

Double minimum value in time series requested. format: double

min_ts (optional)

String timestamp of the minimum value.

num_samples (optional)

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

sum (optional)

Double summation of all values. format: double

trend (optional)

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

MetricsMissingDataInterval Up

end

String end of MetricsMissingDataInterval.

start

String start of MetricsMissingDataInterval.

PoolAnomalyScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type PoolAnomalyScore field type str type object

reason

String reason of PoolAnomalyScore.

score_data (optional)

PoolAnomalyScoreData Placeholder for description of property score_data of obj type PoolAnomalyScore field type str type object

value

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

PoolAnomalyScoreData Up

anomalous_l4_metrics (optional)

array[String] anomalous_l4_metrics of PoolAnomalyScoreData.

anomalous_l7_metrics (optional)

array[String] anomalous_l7_metrics of PoolAnomalyScoreData.

avg_server_anomaly_score (optional)

Double Placeholder for description of property avg_server_anomaly_score of obj type PoolAnomalyScoreData field type str type number format: double

per_anomalous_l4_metrics

Double Placeholder for description of property per_anomalous_l4_metrics of obj type PoolAnomalyScoreData field type str type number format: double

per_anomalous_l7_metrics (optional)

Double Placeholder for description of property per_anomalous_l7_metrics of obj type PoolAnomalyScoreData field type str type number format: double

pool_ref

String It is a reference to an object of type Pool.

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

server_anomaly_scores (optional)

array[ServerAnomalyScore] Placeholder for description of property server_anomaly_scores of obj type PoolAnomalyScoreData field type str type object

PoolPerformanceScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type PoolPerformanceScore field type str type object

reason

String reason of PoolPerformanceScore.

score_data (optional)

PoolPerformanceScoreData Placeholder for description of property score_data of obj type PoolPerformanceScore field type str type object

value

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

PoolPerformanceScoreData Up

apdexc (optional)

Double Placeholder for description of property apdexc of obj type PoolPerformanceScoreData field type str type number format: double

apdexr (optional)

Double Placeholder for description of property apdexr of obj type PoolPerformanceScoreData field type str type number 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.

pool_ref

String It is a reference to an object of type Pool.

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

sum_finished_conns (optional)

Double Placeholder for description of property sum_finished_conns of obj type PoolPerformanceScoreData field type str type number format: double

PoolResourcesScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type PoolResourcesScore field type str type object

reason

String reason of PoolResourcesScore.

score_data (optional)

PoolResourcesScoreData Placeholder for description of property score_data of obj type PoolResourcesScore field type str type object

value

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

PoolResourcesScoreData Up

avg_server_resources_score (optional)

Double Placeholder for description of property avg_server_resources_score of obj type PoolResourcesScoreData field type str type number format: double

avg_uptime (optional)

Double Placeholder for description of property avg_uptime of obj type PoolResourcesScoreData field type str type number format: double

pool_ref

String It is a reference to an object of type Pool.

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

server_resources_scores (optional)

array[ServerResourcesScore] Placeholder for description of property server_resources_scores of obj type PoolResourcesScoreData field type str type object

ServerAnomalyScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type ServerAnomalyScore field type str type object

reason

String reason of ServerAnomalyScore.

score_data (optional)

ServerAnomalyScoreData Placeholder for description of property score_data of obj type ServerAnomalyScore field type str type object

value

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

ServerAnomalyScoreData Up

anomalous_l4_metrics (optional)

array[String] anomalous_l4_metrics of ServerAnomalyScoreData.

anomalous_l7_metrics (optional)

array[String] anomalous_l7_metrics of ServerAnomalyScoreData.

anomalous_vm_metrics (optional)

array[String] anomalous_vm_metrics of ServerAnomalyScoreData.

per_anomalous_l4_metrics

Double Placeholder for description of property per_anomalous_l4_metrics of obj type ServerAnomalyScoreData field type str type number format: double

per_anomalous_l7_metrics (optional)

Double Placeholder for description of property per_anomalous_l7_metrics of obj type ServerAnomalyScoreData field type str type number format: double

per_anomalous_vm_metrics (optional)

Double Placeholder for description of property per_anomalous_vm_metrics of obj type ServerAnomalyScoreData field type str type number format: double

pool_uuid

String Unique object identifier of pool.

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

server

String server of ServerAnomalyScoreData.

ServerPerformanceScoreData Up

apdexc (optional)

Double Placeholder for description of property apdexc of obj type ServerPerformanceScoreData field type str type number format: double

apdexr (optional)

Double Placeholder for description of property apdexr of obj type ServerPerformanceScoreData field type str type number format: double

oper_state (optional)

pool_uuid

String Unique object identifier of pool.

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

server

String server of ServerPerformanceScoreData.

sum_finished_conns (optional)

Double Placeholder for description of property sum_finished_conns of obj type ServerPerformanceScoreData field type str type number format: double

ServerResourcesScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type ServerResourcesScore field type str type object

reason

String reason of ServerResourcesScore.

score_data (optional)

ServerResourcesScoreData Placeholder for description of property score_data of obj type ServerResourcesScore field type str type object

value

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

ServerResourcesScoreData Up

avg_cpu_usage (optional)

Double Placeholder for description of property avg_cpu_usage of obj type ServerResourcesScoreData field type str type number format: double

avg_cpu_wait (optional)

Double Placeholder for description of property avg_cpu_wait of obj type ServerResourcesScoreData field type str type number format: double

avg_disk1_usage (optional)

Double Placeholder for description of property avg_disk1_usage of obj type ServerResourcesScoreData field type str type number format: double

avg_disk2_usage (optional)

Double Placeholder for description of property avg_disk2_usage of obj type ServerResourcesScoreData field type str type number format: double

avg_disk3_usage (optional)

Double Placeholder for description of property avg_disk3_usage of obj type ServerResourcesScoreData field type str type number format: double

avg_disk4_usage (optional)

Double Placeholder for description of property avg_disk4_usage of obj type ServerResourcesScoreData field type str type number format: double

avg_mem_usage (optional)

Double Placeholder for description of property avg_mem_usage of obj type ServerResourcesScoreData field type str type number format: double

avg_uptime (optional)

Double Placeholder for description of property avg_uptime of obj type ServerResourcesScoreData field type str type number format: double

pct_open_conns (optional)

Double Placeholder for description of property pct_open_conns of obj type ServerResourcesScoreData field type str type number format: double

pool_uuid

String Unique object identifier of pool.

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

server

String server of ServerResourcesScoreData.

ServiceEngineAnomalyScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type ServiceEngineAnomalyScore field type str type object

reason

String reason of ServiceEngineAnomalyScore.

score_data (optional)

ServiceEngineAnomalyScoreData Placeholder for description of property score_data of obj type ServiceEngineAnomalyScore field type str type object

value

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

ServiceEngineAnomalyScoreData Up

anomalous_se_stats_metrics (optional)

array[String] anomalous_se_stats_metrics of ServiceEngineAnomalyScoreData.

anomalous_vm_stats_metrics (optional)

array[String] anomalous_vm_stats_metrics of ServiceEngineAnomalyScoreData.

per_anomalous_se_stats_metrics

Double Placeholder for description of property per_anomalous_se_stats_metrics of obj type ServiceEngineAnomalyScoreData field type str type number format: double

per_anomalous_vm_stats_metrics (optional)

Double Placeholder for description of property per_anomalous_vm_stats_metrics of obj type ServiceEngineAnomalyScoreData field type str type number format: double

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type ServiceEngine.

ServiceEngineDosAttackLevel Up

hs_entity (optional)

HealthScoreEntity Placeholder for description of property hs_entity of obj type ServiceEngineDosAttackLevel field type str type object

reason (optional)

String reason of ServiceEngineDosAttackLevel.

score_data (optional)

ServiceEngineDosAttackLevelData Placeholder for description of property score_data of obj type ServiceEngineDosAttackLevel field type str type object

value (optional)

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

ServiceEngineDosAttackLevelData Up

avg_connections (optional)

Double Placeholder for description of property avg_connections of obj type ServiceEngineDosAttackLevelData field type str type number format: double

avg_rx_bandwidth (optional)

Double Placeholder for description of property avg_rx_bandwidth of obj type ServiceEngineDosAttackLevelData field type str type number format: double

avg_rx_pkts (optional)

Double Placeholder for description of property avg_rx_pkts of obj type ServiceEngineDosAttackLevelData field type str type number format: double

pct_connections_dropped (optional)

Double Placeholder for description of property pct_connections_dropped of obj type ServiceEngineDosAttackLevelData field type str type number format: double

pct_rx_bytes_dropped (optional)

Double Placeholder for description of property pct_rx_bytes_dropped of obj type ServiceEngineDosAttackLevelData field type str type number format: double

pct_rx_pkts_dropped (optional)

Double Placeholder for description of property pct_rx_pkts_dropped of obj type ServiceEngineDosAttackLevelData field type str type number format: double

reason

String Reason for the SE DoS Attack Level.

reason_attr (optional)

String Attribute that is dominating the DoS Attack Level.

ref (optional)

String It is a reference to an object of type ServiceEngine.

value (optional)

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

ServiceEnginePerformanceScoreData Up

oper_state (optional)

reason

String Reason for the Health Performance Score.

reason_attr (optional)

String Attribute that is dominating the performance score.

ref (optional)

String It is a reference to an object of type ServiceEngine.

ServiceEngineResourcesScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type ServiceEngineResourcesScore field type str type object

reason

String reason of ServiceEngineResourcesScore.

score_data (optional)

ServiceEngineResourcesScoreData Placeholder for description of property score_data of obj type ServiceEngineResourcesScore field type str type object

value

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

ServiceEngineResourcesScoreData Up

avg_connection_mem_usage (optional)

Double Placeholder for description of property avg_connection_mem_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_cpu_usage (optional)

Double Placeholder for description of property avg_cpu_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_cpu_wait (optional)

Double Placeholder for description of property avg_cpu_wait of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_disk1_usage (optional)

Double Placeholder for description of property avg_disk1_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_dynamic_mem_usage (optional)

Double Placeholder for description of property avg_dynamic_mem_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_mem_usage (optional)

Double Placeholder for description of property avg_mem_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_packet_buffer_usage (optional)

Double Placeholder for description of property avg_packet_buffer_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_persistent_table_usage (optional)

Double Placeholder for description of property avg_persistent_table_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

avg_shared_memory_usage (optional)

Double Use shared memory usage in computation of SE resource penalty. format: double

avg_ssl_session_cache_usage (optional)

Double Placeholder for description of property avg_ssl_session_cache_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

oper_state (optional)

pct_syn_cache_usage (optional)

Double Placeholder for description of property pct_syn_cache_usage of obj type ServiceEngineResourcesScoreData field type str type number format: double

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type ServiceEngine.

SslScoreData Up

cert_chain_verified (optional)

String Chains for all certificates are verified.

cert_chain_verified_score (optional)

Double Score Chains for all certificates are verified. format: double

cert_revoked_status (optional)

String Certificate revoked status by OCSP Responder.

cert_revoked_status_score (optional)

Double Score Certficate Revoked for VS. format: double

deactivate_client_renegotiation (optional)

Boolean Deactivate client renegotiation. Field introduced in 20.1.3.

deactivate_client_renegotiation_score (optional)

Double Score Deactivate client renegotiation. Field introduced in 20.1.3. format: double

disable_client_renegotiation (optional)

Boolean Disable client renegotiation. Field deprecated in 20.1.3.

disable_client_renegotiation_score (optional)

Double Score Disable client renegotiation. Field deprecated in 20.1.3. format: double

earliest_cert_expiry (optional)

String Earliest certificate expiration time.

earliest_cert_expiry_score (optional)

Double Score Earliest certificate expiration time. format: double

hsts_enabled (optional)

Boolean HSTS enabled for VS.

hsts_enabled_score (optional)

Double Score HSTS enabled for VS. format: double

min_cipher_strength (optional)

String Strength of the weakest symmetric encryption algorithm.

min_cipher_strength_score (optional)

Double Score Strength of the weakest symmetric encryption algorithm. format: double

min_ssl_protocol_strength (optional)

String Weakest SSL protocol supported.

min_ssl_protocol_strength_score (optional)

Double Score Weakest SSL protocol supported. format: double

pfs_support (optional)

Boolean Is a PFS cipher suite supported.

pfs_support_score (optional)

Double Score Is a PFS cipher suite supported. format: double

reason

String Reason for the SSL Config Level.

reason_attr (optional)

String Attribute that is dominating the SSL Config Level.

ref (optional)

String It is a reference to an object of type VirtualService.

ssl_enabled (optional)

Boolean Set whether the SSL service is enabled for the VS.

value (optional)

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

weak_signature_algorithm (optional)

String Weak algorithm used for signing the certificate, amongst all certificates for the VS.

weak_signature_algorithm_score (optional)

Double Score Weak algorithm used for signing the certificate. format: double

weakest_enc_algo (optional)

String Weakest algorithm for symmetric encryption.

weakest_enc_algo_score (optional)

Double Score Weakest algorithm for symmetric encryption. format: double

VirtualServiceAnomalyScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type VirtualServiceAnomalyScore field type str type object

reason

String reason of VirtualServiceAnomalyScore.

score_data (optional)

VirtualServiceAnomalyScoreData Placeholder for description of property score_data of obj type VirtualServiceAnomalyScore field type str type object

value

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

VirtualServiceAnomalyScoreData Up

anomalous_l4_metrics (optional)

array[String] anomalous_l4_metrics of VirtualServiceAnomalyScoreData.

anomalous_l7_metrics (optional)

array[String] anomalous_l7_metrics of VirtualServiceAnomalyScoreData.

per_anomalous_l4_metrics (optional)

Double Placeholder for description of property per_anomalous_l4_metrics of obj type VirtualServiceAnomalyScoreData field type str type number format: double

per_anomalous_l7_metrics (optional)

Double Placeholder for description of property per_anomalous_l7_metrics of obj type VirtualServiceAnomalyScoreData field type str type number format: double

pool_anomaly_scores (optional)

array[PoolAnomalyScore] Placeholder for description of property pool_anomaly_scores of obj type VirtualServiceAnomalyScoreData field type str type object

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

serviceengine_anomaly_scores (optional)

array[ServiceEngineAnomalyScore] Placeholder for description of property serviceengine_anomaly_scores of obj type VirtualServiceAnomalyScoreData field type str type object

VirtualServicePerformanceScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type VirtualServicePerformanceScore field type str type object

reason

String reason of VirtualServicePerformanceScore.

score_data (optional)

VirtualServicePerformanceScoreData Placeholder for description of property score_data of obj type VirtualServicePerformanceScore field type str type object

value

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

VirtualServicePerformanceScoreData Up

apdexc (optional)

Double Placeholder for description of property apdexc of obj type VirtualServicePerformanceScoreData field type str type number format: double

apdexr (optional)

Double Placeholder for description of property apdexr of obj type VirtualServicePerformanceScoreData field type str type number format: double

avg_pool_performance_score (optional)

Double Average of all pool performance scores. format: double

oper_state

pool_performance_scores (optional)

array[PoolPerformanceScore] Placeholder for description of property pool_performance_scores of obj type VirtualServicePerformanceScoreData field type str type object

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

rum_apdexr (optional)

Double Rum Apdexr when client insights is active. format: double

sum_finished_conns (optional)

Double Placeholder for description of property sum_finished_conns of obj type VirtualServicePerformanceScoreData field type str type number format: double

vs_uptime (optional)

Double Percentage time of last 5mins that the VirtualService has been up. format: double

VirtualServiceResourcesScore Up

hs_entity

HealthScoreEntity Placeholder for description of property hs_entity of obj type VirtualServiceResourcesScore field type str type object

reason

String reason of VirtualServiceResourcesScore.

score_data (optional)

VirtualServiceResourcesScoreData Placeholder for description of property score_data of obj type VirtualServiceResourcesScore field type str type object

value

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

VirtualServiceResourcesScoreData Up

avg_bandwidth_usage (optional)

Double Resources of the virtual service with respect to max_throughput. format: double

ha_index (optional)

Double Fraction of service engines available. format: double

max_open_conns_usage (optional)

Double Resources of the virtual service with respect to max_open_conns. format: double

multivip_index (optional)

Double Fraction of VIPs available, given a VirtualService. format: double

pool_resources_scores (optional)

array[PoolResourcesScore] Placeholder for description of property pool_resources_scores of obj type VirtualServiceResourcesScoreData field type str type object

reason

String Reason for the Health Score.

reason_attr (optional)

String Attribute that is dominating the health score.

ref (optional)

String It is a reference to an object of type VirtualService.

serviceengine_resources_scores (optional)

array[ServiceEngineResourcesScore] Placeholder for description of property serviceengine_resources_scores of obj type VirtualServiceResourcesScoreData field type str type object

Avi Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents