HCX - GetAppliance API call failed to execute with error "JSONObject["networks"] not found"

Products

• VMware HCX
• VMware Cloud on AWS

Issue/Introduction

This resource is to inform all about HCX GetAppliance API failure and how to recover that.

Symptoms:
Customer may report an issue where "GetAppliance" API call failed to execute and below error can be seen in the API response.

API:

curl --location --request GET 'https://hcx_mgr_IP/hybridity/api/interconnect/appliances' \

Response:

<?xml version='1.0' encoding='UTF-8'?>
<com.vmware.vchs.hybridity.api.common.model.ErrorResponse>
    <errors>
        <com.vmware.vchs.hybridity.api.common.model.Error>
            <code>E_INVALID_SCHEMA</code>
            <message>JSONObject["networks"] not found.</message>
        </com.vmware.vchs.hybridity.api.common.model.Error>
    </errors>
</com.vmware.vchs.hybridity.api.common.model.ErrorResponse>

Cause

This behavior could be seen in the below circumstances:

1. For the environments where SM/Fleet Appliances got deployed partially and got failed to cleanup in the backend.
2. SM/Fleet Appliances got deployed successfully but the appliances got forcefully removed/deleted by user from vCenter UI.

Resolution

None

Workaround:
Please open a service request with VMware support team for further assistance.

Additional Information

Impact/Risks:

• This issue will be ONLY observed in GetAppliance API call executed through HCX API explorer or POSTMAN application.

Note: This will also be observed through PowerCLI "get-hcxappliance" cmdlet.

• The SM/Appliances status will remain accessible through UI.