GET /analytics/healthscore/serviceengine/{uuid}

GET /analytics/healthscore/serviceengine/{uuid}

/analytics/healthscore/serviceengine/{uuid}

Request
URI
GET
https://{api_host}/api/analytics/healthscore/serviceengine/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
boolean
include_name
Optional

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.

boolean
skip_default
Optional

Default values are not set.

boolean
detailed_header
Optional

Return detailed header with information like contributors etc.?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
dimension_aggregation
Optional

Aggregations for dimensions. Eg. use dimenstion_aggregation=avg for averaged metric values. Enum options - METRICS_DIMENSION_AGG_NONE, METRICS_DIMENSION_AGG_AVG, METRICS_DIMENSION_AGG_SUM, METRICS_DIMENSION_AGG_MAX, METRICS_DIMENSION_AGG_MIN, METRICS_DIMENSION_AGG_PERCENT, METRICS_DIMENSION_AGG_ALL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
entity_uuid
Optional

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

string
hs_type
Optional

Health Score Type. Enum options - HEALTH_SCORE, HEALTH_PERFORMANCE_SCORE, HEALTH_ANOMALY_SCORE, HEALTH_RESOURCES_SCORE, HEALTH_SECURITY_THREAT_LEVEL. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
include_refs
Optional

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

boolean
include_statistics
Optional

Include statistics when no filters specified?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer
limit
Optional

Max number of metric samples to be returned in the response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
metric_entity
Optional

Metrics Types supported. Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
order_series_by
Optional

Order by field in the statistics. It is required tohave include_statistics set to true. A negative sign means decreasing order. Egs. mean, min, max, etc. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
pad_missing_data
Optional

Pad missing health scores. That is, if data for certain intervals not present, fill up the time series with null values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
patch_oper_status
Optional

Patch health score with operational data?. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
pool_uuid
Optional

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

string
result_format
Optional

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

string
server
Optional

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

string
start
Optional

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

integer
step
Optional

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

string
stop
Optional

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

boolean
summary
Optional

Return only summary for health score. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_uuid
Optional

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

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller with reject requests.


Responses
200

OK

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

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

string
metric_entity
Required

Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY, POOL_METRICS_ENTITY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
pool_ref
Optional

Pool name. This will apply to any back end statistics that are specified in the query. It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
series
Optional

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

string
server
Optional

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

string
start
Required

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

integer As int32 As int32
step
Required

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

string
stop
Required

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

string
url
Optional

url


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/analytics/healthscore/serviceengine/{uuid}