GET /analytics/healthscore/serviceengine

GET /analytics/healthscore/serviceengine

/analytics/healthscore/serviceengine

Request
URI
GET
https://{api_host}/api/analytics/healthscore/serviceengine
COPY
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.

string
name
Optional

object name

boolean
detailed_header
Optional

Return detailed header with information like contributors etc.?. Allowed with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
entity_uuid
Optional

UUID of the entity type. Allowed with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
include_refs
Optional

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

boolean
include_statistics
Optional

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

integer
limit
Optional

Max number of metric samples to be returned in the response. Allowed with any value in Enterprise, 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 with any value in Enterprise, 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 with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
patch_oper_status
Optional

Patch health score with operational data?. Allowed with any value in Enterprise, 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 with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
server
Optional

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

string
start
Optional

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

integer
step
Optional

Step interval in seconds. Allowed with any value in Enterprise, 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 with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
summary
Optional

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

string
tenant_uuid
Optional

UUID of the Tenant. . Allowed with any value in Enterprise, 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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns healthScoreQueryResponseApiResponse of type(s) application/json 
"healthScoreQueryResponseApiResponse Object"

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
On This Page
Health Score Operations
GET
GET /analytics/healthscore/pool
GET
GET /analytics/healthscore/pool/{uuid}
GET
GET /analytics/healthscore/serviceengine
GET
GET /analytics/healthscore/serviceengine/{uuid}
GET
GET /analytics/healthscore/virtualservice
GET
GET /analytics/healthscore/virtualservice/{uuid}