Get HA Group

Get HA Group
get HA group for specific groupId

Retrieves comprehensive configuration and operational details for a specific HA group. This API provides complete information about the group's member appliances, current health status, active/standby roles, HA policy configuration, failover history, and performance metrics. Use this endpoint to monitor specific HA group health, troubleshoot issues, or retrieve configuration for automation workflows.

Request
URI
GET
https://{server}/hybridity/api/interconnect/appliances/ha/groups/{groupId}
COPY
Path Parameters
string
groupId
Required

Unique identifier of the HA group to retrieve. This ID is returned when creating an HA group and uniquely identifies the group within the HCX environment.

Query Parameters
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 to view complete HA group topology including remote site appliances. Default is false.

Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns haGroup of type(s) application/json 
{
    "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
}
string
groupId
Optional

groupId

string
name
Optional

name

string
serviceMeshId
Optional

serviceMeshId

string
groupType
Optional

groupType

array of object
groupMembers
Optional

groupMembers

object
policyInfo
Optional

policyInfo

object
status
Optional

status

string
dvsId
Optional

dvsId

string
dvsName
Optional

dvsName

string
remoteDvsId
Optional

remoteDvsId

string
remoteDvsName
Optional

remoteDvsName

integer
networkExtensionCount
Optional

networkExtensionCount

integer
networkStretchCapacity
Optional

networkStretchCapacity


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

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

errors


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/{groupId}
On This Page
Get Hagroup Operations
GET
Get HA Group
DELETE
Delete HA Group