HealthScoreQuery

HealthScoreQuery
HealthScoreQuery
JSON Example
{
    "detailed_header": false,
    "dimension_aggregation": "string",
    "entity_uuid": "string",
    "hs_type": "string",
    "include_refs": false,
    "include_statistics": false,
    "limit": 0,
    "metric_entity": "string",
    "order_series_by": "string",
    "pad_missing_data": false,
    "patch_oper_status": false,
    "pool_uuid": "string",
    "result_format": "string",
    "server": "string",
    "start": "string",
    "step": 0,
    "stop": "string",
    "summary": false,
    "tenant_uuid": "string"
}
boolean
detailed_header
Optional
Constraints: default: true

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
Constraints: default: METRICS_DIMENSION_AGG_NONE

Aggregations for dimensions. Eg. use dimension_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
Required

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

string
hs_type
Optional
Constraints: default: HEALTH_SCORE

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
Constraints: default: true

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

integer As int32 As int32
limit
Optional
Constraints: default: 1

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
Required
Constraints: default: VSERVER_METRICS_ENTITY

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
Constraints: default: true

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
Constraints: default: true

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
Constraints: default: METRICS_FORMAT_JSON

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
Constraints: default: 1970-01-01T00:00:00

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 As int32 As int32
step
Optional
Constraints: default: 300

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.