Get Universal Router Health

Get Universal Router Health

Get Health information of a universal router and its associated entities such as egress points and routing. It includes information about reachability status of all the participating vDC's of referenced vDC group and it also includes information about all the nsx managers covered by this universal router along with associated nsx controller cluster.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/health
COPY
Path Parameters
string
universalRouterId
Required

universalRouterId

string
universalRouterId
Required

universalRouterId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RouterHealthReport of type(s) application/json;version=39.0 
{
    "nsxManagersHealth": [
        {
            "component": "string",
            "status": {},
            "message": "string",
            "action": "string",
            "code": 0
        }
    ],
    "controlVmHealth": [
        {
            "component": "string",
            "status": {},
            "message": "string",
            "action": "string",
            "code": 0
        }
    ],
    "controlPlaneHealth": {
        "component": "string",
        "status": {},
        "message": "string",
        "action": "string",
        "code": 0
    },
    "vdcReachabilityStatus": [
        {
            "component": "string",
            "status": {},
            "message": "string",
            "action": "string",
            "code": 0
        }
    ]
}
array of RouterComponentHealth
nsxManagersHealth
Optional

Status of all the nsx managers spanned by the universal router.

array of RouterComponentHealth
controlVmHealth
Optional

Status of all the universal router control VMs within each network provider scope. This also includes status of egress points and routes configured for the universal router.

RouterComponentHealth
controlPlaneHealth
Optional

A ComponentHealth object

array of RouterComponentHealth
vdcReachabilityStatus
Optional

Reachability status for local and remote participating vDC's of referenced vDC group. States whether a vDC is reachable from this local site.


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


On This Page
Universal Router Health Operations
GET
Get Universal Router Health