List HA Group

List HA Group
list HA groups

Retrieves a list of all High Availability groups configured in the HCX environment, optionally filtered by service mesh. Returns summary information for each HA group including member appliances, health status, current active appliance, and HA policy. Use this API to monitor HA group status, verify configurations, or identify groups requiring attention.

Request
URI
GET
https://{server}/hybridity/api/interconnect/appliances/ha/groups
COPY
Query Parameters
string
serviceMeshId
Optional

Filter HA groups by service mesh ID. When specified, returns only HA groups associated with the specified service mesh. Omit to return all HA groups across all service meshes.

boolean
allGroupMembers
Optional
Constraints: default: false

Include all group members from both local and peer sites when true. When false (default), returns only local site members. Set to true for complete HA group topology view across both sites in the service mesh. Default is false.

Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns listHAGroupResponse of type(s) application/json 
{
    "items": [
        {
            "groupId": "string",
            "name": "string",
            "serviceMeshId": "string",
            "groupType": "string",
            "groupMembers": [
                {
                    "applianceId": "string",
                    "applianceName": "string",
                    "peerApplianceId": "string",
                    "peerApplianceName": "string",
                    "role": "string"
                }
            ],
            "policyInfo": {
                "policy": "string"
            },
            "status": {
                "groupState": "string",
                "statusMessage": "string",
                "availabilityState": "string",
                "availabilityDescription": "string"
            },
            "dvsId": "string",
            "dvsName": "string",
            "remoteDvsId": "string",
            "remoteDvsName": "string",
            "networkExtensionCount": 0,
            "networkStretchCapacity": 0
        }
    ]
}
array of object
items
Optional

items


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Internal Server Error

Returns HAInternalServerError of type(s) application/json 
{
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}
array of object
errors
Optional

errors


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/hybridity/api/interconnect/appliances/ha/groups
On This Page
Hagroups Operations
POST
Create HA Group
GET
List HA Group
GET
Get Timeline Events
POST
Redeploy HA Group
POST
Recover HA Group
POST
Force Failover HA Group
POST
Force Sync HA Group
POST
Upgrade HA Group