HealthAssessmentResult

Health Assessment Result

Complete health assessment result for a single resource. Contains the overall health level, metadata about the assessment, and detailed breakdown of individual metrics and their health statuses.

JSON Example

{
    "id": "string",
    "assessed_resource_id": "string",
    "assessed_resource_type": "string",
    "assessed_resource_name": "string",
    "assessed_resource_path": "string",
    "site_id": "string",
    "related_resource_id": "string",
    "related_resource_type": "string",
    "related_resource_name": "string",
    "related_resource_path": "string",
    "related_overall_level": "string",
    "overall_level": "string",
    "report_timestamp": 0,
    "details": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

string

id

Required  

Unique identifier of the assessment that produced this result (e.g., 'idps_legacy_eligibility').

string

assessed_resource_id

Required  

Unique identifier of the resource being assessed (e.g., host UUID or cluster ID).

string

assessed_resource_type

Required  

Type of the resource (e.g. 'HostTransportNode', 'ComputeCollection'). Uses camelCase for resource type names.

string

assessed_resource_name

Optional

Display name of the assessed resource (e.g., VM name, host name). Null if name is not available.

string

assessed_resource_path

Optional

Policy path of the assessed resource (e.g., '/infra/sites/default/enforcement-points/default/host-transport-nodes/...'). Null if path is not available or the resource type does not use policy paths.

string

site_id

Optional

Site ID of the resource being assessed.

string

related_resource_id

Optional

ID of a related resource (e.g., cluster ID for a host, or peer resource). Null if no related resource exists.

string

related_resource_type

Optional

Type of the related resource (e.g., 'ComputeCollection' for a cluster). Uses camelCase for resource type names. Null if no related resource exists.

string

related_resource_name

Optional

Display name of the related resource (e.g., cluster name, host name). Null if no related resource exists or name is not available.

string

related_resource_path

Optional

Policy path of the related resource. Null if no related resource exists, path is not available, or the resource type does not use policy paths.

string

related_overall_level

Optional

Overall health level of the related resource. Null if no related resource exists or related assessment has not been computed yet.

string

overall_level

Required  

Overall health level for this resource, determined by aggregating all individual metric health statuses according to the calculator's logic. Value is one of the strings defined in the assessment's possible_health_levels.

EpochMsTimestamp

report_timestamp

Required  

Timestamp in milliseconds since epoch indicating when this assessment was last computed.

array of HealthDetailKeyValue

details

Optional

Array of key-value pairs providing detailed breakdown of the assessment. Includes individual metric health statuses, computed values, thresholds, and other contextual information.