API to request health state of embedded vRO integration returns inconsistent responses, where endpointHealthCheckState may be unavailable in some environments.

Products

• VMware Aria Suite

Issue/Introduction

An API call to https://{vra-fqdn}/iaas/api/integrations?apiVersion=2021-07-15 will by default return a list of integrations along with some key:value pair attributes for each integration.

Missing in this default list of attributes is the endpointHealthCheckState, which will have the value AVAILABLE to signal the state of the embedded integration.

There may be a scenario where customers use automated scripts to monitor the value of this key:value pair to trigger alerts whenever an integration fails, however this attribute is not available by default.

Environment

Aria Automation 8.18

Cause

In instances where an integration has failed, an additional set of key:value pairs of attributes are created, and the values are updated after recovery.

Among these new key:value pairs created is the key endpointHealthCheckState which will have the value AVAILABLE upon an integration returning to a healthy state.

Resolution

The recommended method to trigger the creation of these additional key:value pairs is to add or update the description of the integration via the GUI, validate the associated credentials, and then save the integration details, e.g.:

Then, issuing a new API call to https://{vra-fqdn}/iaas/api/integrations?apiVersion=2021-07-15 will return the desired key:value pair to be monitored.