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
Responses
202
Accepted
Returns C4ApiTask_of_CloudHealthInfo of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
"endTime": 1499929558827,
"error": {
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
},
"id": "f61d60d2-698a-46dc-a266-88df27644956",
"lastUpdated": 1499929558827,
"progress": 100,
"result": {
"id": "febc5d3c-51dd-4f8d-b31b-4bbfa9024676",
"user": "root",
"workflowInfo": {
"type": "health",
"resourceType": "CLOUD",
"resourceId": null,
"resourceName": null
},
"progress": 100,
"state": "SUCCEEDED",
"lastUpdated": -1,
"startTime": 1596885221519,
"endTime": 1596885221988,
"resultType": "CloudHealthInfo",
"result": {
"productName": "VMware Cloud Director Availability vApp Replication Manager",
"buildVersion": "4.1.0.e62bde624",
"buildDate": 1596801857112,
"instanceId": "055bd0b4-ce6c-46e7-886d-0d21ce95da95",
"runtimeId": "085329ba-f349-4f40-8a41-ff0b9c52264a",
"currentTime": 1596885221988,
"address": "10.71.221.163",
"tunnelError": null,
"vcdError": null,
"managerError": null,
"managerHealth": {
"productName": "VMware Cloud Director Availability Replication Manager",
"buildVersion": "4.1.0.e62bde624",
"buildDate": 1596801857112,
"instanceId": "39df887a-b9b4-4949-b0bd-6d7c6ec14798",
"runtimeId": "2895a797-6212-4801-9f97-28780492223a",
"currentTime": 1596885221931,
"address": "10.71.221.163",
"offlineReplicators": [],
"onlineReplicators": [
{
"id": "dbc216cd-b838-40a5-8323-6a886a249dff",
"owner": "*",
"site": "site1",
"description": "Auto-paired replicator",
"apiUrl": "https://10.71.221.163:8043",
"certThumbprint": "SHA-256:5E:31:E3:F4:3E:03:5A:72:CA:D1:C6:2F:65:16:54:1E:49:0E:5B:EF:2C:73:0D:AE:99:46:8B:7C:92:79:DC:C5",
"pairingCookie": null,
"state": {
"incomingCommError": null,
"outgoingCommError": null
},
"isInMaintenanceMode": false,
"apiVersion": "4.1"
}
],
"localReplicatorsHealth": [
{
"productName": "VMware Cloud Director Availability Replicator",
"buildVersion": "4.1.0.e62bde624",
"buildDate": 1596801857112,
"instanceId": "dbc216cd-b838-40a5-8323-6a886a249dff",
"runtimeId": "135397a2-37ec-4b87-a70e-768767b3207f",
"currentTime": 1596885221922,
"address": "10.71.221.163",
"offlineManagers": [],
"onlineManagers": [
{
"id": "39df887a-b9b4-4949-b0bd-6d7c6ec14798",
"description": "Auto-paired replicator",
"certThumbprint": "SHA-256:2F:22:1F:5A:7B:6F:08:96:08:C5:76:25:30:AE:EB:B7:DF:21:EA:71:74:EE:A0:06:8B:6F:F7:45:B1:3B:F6:A3",
"owner": "*",
"apiUrl": "https://10.71.221.163:8044/",
"localUser": "[email protected]",
"localPassword": "<censored>",
"apiVersion": "4.1"
}
],
"lsError": null,
"dbError": null,
"vcError": {
"39df887a-b9b4-4949-b0bd-6d7c6ec14798": {
"94b4c496-1c11-4ee4-9197-1c96426b2412": null
}
},
"lwdError": null,
"hbrError": null,
"ntpError": null
}
],
"lsError": null,
"dbError": null,
"ntpError": null,
"localReplicatorsLsMismatch": null
},
"lsError": null,
"dbError": null,
"ntpError": null
},
"error": null,
"warnings": [],
"site": "site1"
},
"resultType": "string",
"site": "site2",
"startTime": 1499929548951,
"state": "string",
"user": "root",
"warnings": [],
"workflowInfo": {}
}integer As int64 As int64
endTime
Optional
Timestamp in msec of the completion time of the task. -1 means the task hasn't completed.
string As uuid As uuid
id
Optional
The unique identifier of the long-running task. It is unique and can be used for monitoring.
integer As int64 As int64
lastUpdated
Optional
Timestamp in msec of the last task status update.
integer As int32 As int32
progress
Optional
Percentage-based progress of the task.
string
resultType
Optional
Indicates the type of the task result. Populated only if the execution was successful.
string
site
Optional
Site on which the task runs.
integer As int64 As int64
startTime
Optional
Timestamp in msec of the creation time of the task.
string
user
Optional
The user who started the task.
401
The returned error codes include (but are not limited to): NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.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.5+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.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.5+json;charset=UTF-8
{
"args": [],
"code": "Forbidden",
"msg": "Permission denied.",
"stacktrace": "com.vmware.h4.api.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.