Health Info
This request will provide the following information:
- can the Cloud Service access its database
- can the Cloud Service talk to the lookup service
- can the Cloud Service talk to the H4 Manager
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-v3.5+json;charset=UTF-8
{
"address": "string",
"buildDate": 0,
"buildVersion": "string",
"currentTime": 0,
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"managerConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"managerHealth": {
"address": "string",
"buildDate": 0,
"buildVersion": "string",
"currentTime": 0,
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"localReplicatorsHealth": [
{
"address": "string",
"buildDate": 0,
"buildVersion": "string",
"currentTime": 0,
"dbConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"hbrConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"instanceId": "string",
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"lwdProxyConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"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"
}
],
"lsConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"offlineReplicators": [
{
"apiUrl": "string",
"apiVersion": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": false,
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}
],
"onlineReplicators": [
{
"apiUrl": "string",
"apiVersion": "string",
"certThumbprint": "string",
"description": "string",
"id": "string",
"isInMaintenanceMode": false,
"owner": "string",
"pairingCookie": "string",
"site": "string",
"state": {
"incomingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
},
"outgoingCommError": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}
],
"productName": "string",
"runtimeId": "string"
},
"productName": "string",
"runtimeId": "string",
"tunnelConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
},
"vcdConnectivity": {
"value": {
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}
}
}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
Returned error codes include (but are not limited to):
- NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}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
Returned error codes include (but are not limited to):
- Forbidden
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}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
Returned error codes include (but are not limited to):
- GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8
{
"args": [
"string"
],
"code": "string",
"msg": "string",
"stacktrace": "string"
}array of string
args
Optional
Positional arguments.
string
code
Optional
Specific error code.
string
msg
Optional
Detailed error message.
string
stacktrace
Optional
Exception stacktrace.