Health Info
This request returns the following health information about the Cloud service:
- can the Cloud service access its database
- can the Cloud service communicate with the vCenter Server Lookup service
- can the Cloud service communicate with the VMware Cloud Director
- can the Cloud service communicate with the Tunnel service
- can the Cloud service communicate with the Manager service
Request
URI
GET
https://{api_host}//diagnostics/health
COPY
Header Parameters
string
operationID
Optional
Operation ID for correlating logs across multiple services
Authentication
This operation uses the following authentication methods.
Responses
200
OK
Returns
CloudHealthInfo
of type(s)
application/vnd.vmware.h4-v4+json;charset=UTF-8
{
"address": "string",
"buildDate": 0,
"buildVersion": "string",
"currentTime": 0,
"dbConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"managerConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"managerHealth": {
"address": "string",
"buildDate": 0,
"buildVersion": "string",
"currentTime": 0,
"dbConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"instanceId": "string",
"localReplicatorsHealth": [
{
"address": "string",
"buildDate": 0,
"buildVersion": "string",
"currentTime": 0,
"dbConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"hbrConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"lwdProxyConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"ntpConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"offlineManagers": [
{
"apiUrl": "string",
"apiVersion": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"onlineManagers": [
{
"apiUrl": "string",
"apiVersion": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"localPassword": "string",
"localUser": "string",
"owner": "string"
}
],
"productName": "string",
"runtimeId": "string"
}
],
"localReplicatorsLsMismatch": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"lsConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"ntpConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"offlineReplicators": [
{
"apiUrl": "string",
"apiVersion": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": false,
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
},
"outgoingCommError": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
}
}
],
"onlineReplicators": [
{
"apiUrl": "string",
"apiVersion": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": false,
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
},
"outgoingCommError": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
}
}
],
"productName": "string",
"runtimeId": "string"
},
"ntpConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"productName": "string",
"runtimeId": "string",
"tunnelConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
},
"vcdConnectivity": {
"value": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
}
}
string
address
Optional
The address of the appliance.
integer As int64
As int64
buildDate
Optional
RPM build time.
string
buildVersion
Optional
Represents the product version along with the build id.
integer As int64
As int64
currentTime
Optional
The current time of the appliance.
string As uuid
As uuid
instanceId
Optional
Unique identifier of the service, which never changes.
string
productName
Optional
The name of the product.
string As uuid
As uuid
runtimeId
Optional
A value that remains constant as long as the service is running. If it changes, this means the service was rebooted.
401
The returned error codes include (but are not limited to):
- NotAuthenticated
Returns
ApiError
of type(s)
application/vnd.vmware.h4-v4+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
array of
string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
403
The returned error codes include (but are not limited to):
- Forbidden
Returns
ApiError
of type(s)
application/vnd.vmware.h4-v4+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
array of
string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.
500
The returned error codes include (but are not limited to):
- GeneralServerFailure
Returns
ApiError
of type(s)
application/vnd.vmware.h4-v4+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.vdr.error.exceptions.PermissionDeniedException: Permission denied."
}
array of
string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.