Health Info

Health Info

This request returns the following health information about the Manager service:

  • whether the Manager Service can access its database

  • whether the Manager Service can communicate with the vCenter Server Lookup service

  • whether the Manager Service can communicate with the Tunnel Service. This also applies on the appliances for vSphere DR and migration

  • whether the Manager Service can communicate with the Replicator Service instances

  • a list of the Replicator Service instances that the Manager Service cannot communicate with

Request
URI
POST
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
202

Accepted

Returns ApiTask_of_ManagerHealthInfo of type(s) application/vnd.vmware.h4-v4.7+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": "6f012b33-b048-4588-b2a6-165609c0c937",
        "user": "System",
        "workflowInfo": {
            "type": "health",
            "resourceType": "MANAGER",
            "resourceId": null,
            "resourceName": null
        },
        "progress": 100,
        "state": "SUCCEEDED",
        "lastUpdated": -1,
        "startTime": 1684737716252,
        "endTime": 1684737717033,
        "resultType": "ManagerHealthInfo",
        "result": {
            "productName": "VMware Cloud Director Availability Manager Service",
            "buildVersion": "4.6.0.balachb-b12e9fb604",
            "buildDate": 1684335015558,
            "instanceId": "b8676d0f-b339-4cf3-a2f1-7da20e49a7bb",
            "runtimeId": "6c339019-2558-4094-9b72-12da343ec77f",
            "currentTime": 1684737717031,
            "address": "10.71.216.112",
            "offlineReplicators": [],
            "onlineReplicators": [
                {
                    "id": "935ab38f-bcbc-4eba-aedb-d5da86cd0c1c",
                    "owner": "*",
                    "site": "site1-CD",
                    "description": "Auto-paired replicator",
                    "apiUrl": "https://10.71.216.112:8043",
                    "certThumbprint": "SHA-256:3A:6A:AF:8A:A1:6A:5E:A0:2C:E5:B4:C6:24:64:56:99:FD:16:28:94:99:E2:50:99:9E:B2:0B:47:50:DD:9C:EA",
                    "pairingCookie": null,
                    "state": {
                        "incomingCommError": {
                            "code": "Forbidden",
                            "msg": "Permission denied.",
                            "args": [],
                            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
                        },
                        "outgoingCommError": {
                            "code": "Forbidden",
                            "msg": "Permission denied.",
                            "args": [],
                            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
                        }
                    },
                    "isInMaintenanceMode": false,
                    "apiVersion": "4.6",
                    "dataAddress": "lwd://10.71.216.112:44045",
                    "buildVersion": "4.6.0.balachb-b12e9fb604"
                },
                {
                    "id": "3297973b-963f-404e-8acc-790533a4457e",
                    "owner": "*",
                    "site": "site2-xv",
                    "description": "Auto-paired replicator",
                    "apiUrl": "https://tn-3297973b-963f-404e-8acc-790533a4457e.tnexus.io:8048",
                    "certThumbprint": "SHA-256:38:70:B9:8F:36:D5:70:27:F7:78:E7:4C:B5:A6:8A:57:27:D6:66:33:D9:E3:0A:02:E4:34:7F:F6:36:3F:B6:25",
                    "pairingCookie": null,
                    "state": {
                        "incomingCommError": {
                            "code": "Forbidden",
                            "msg": "Permission denied.",
                            "args": [],
                            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
                        },
                        "outgoingCommError": {
                            "code": "Forbidden",
                            "msg": "Permission denied.",
                            "args": [],
                            "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
                        }
                    },
                    "isInMaintenanceMode": false,
                    "apiVersion": "4.6",
                    "dataAddress": "lwd://10.71.216.75:44045",
                    "buildVersion": "4.6.0.6667376-045989aa57"
                }
            ],
            "localReplicatorsHealth": [
                {
                    "productName": "VMware Cloud Director Availability Replicator Service",
                    "buildVersion": "4.6.0.balachb-b12e9fb604",
                    "buildDate": 1684335015558,
                    "instanceId": "935ab38f-bcbc-4eba-aedb-d5da86cd0c1c",
                    "runtimeId": "288eaff7-d805-4ca6-9371-42824b51f660",
                    "currentTime": 1684737717008,
                    "address": "10.71.216.112",
                    "offlineManagers": [],
                    "onlineManagers": [
                        {
                            "id": "b8676d0f-b339-4cf3-a2f1-7da20e49a7bb",
                            "description": "Auto-paired replicator",
                            "certThumbprint": "SHA-256:83:9B:D0:DD:6C:5B:3B:82:E2:95:04:E6:B0:C9:B0:BB:D8:14:91:51:E6:56:76:6C:38:C6:A8:21:1B:ED:77:CF",
                            "owner": "*",
                            "apiUrl": "https://10.71.216.112:8044/",
                            "localUser": "[email protected]",
                            "localPassword": "<censored>",
                            "apiVersion": "4.6",
                            "isLocal": true
                        },
                        {
                            "id": "c40f4ae8-b734-4007-b4b3-787f04378c0d",
                            "description": "Auto-paired replicator",
                            "certThumbprint": "SHA-256:04:86:2E:95:2D:80:A4:C5:50:BF:1C:0A:D3:21:8C:63:C6:26:A2:A7:DD:13:36:9F:05:7B:67:58:B4:CD:52:D9",
                            "owner": "*",
                            "apiUrl": "https://tn-c40f4ae8-b734-4007-b4b3-787f04378c0d.tnexus.io:8048/",
                            "localUser": "[email protected]",
                            "localPassword": "<censored>",
                            "apiVersion": "4.6",
                            "isLocal": false
                        }
                    ],
                    "lsError": null,
                    "dbError": null,
                    "vcError": {
                        "c40f4ae8-b734-4007-b4b3-787f04378c0d": {
                            "139841ac-af8d-42ca-a5ce-5480b4d88e05": null
                        },
                        "b8676d0f-b339-4cf3-a2f1-7da20e49a7bb": {
                            "139841ac-af8d-42ca-a5ce-5480b4d88e05": null
                        }
                    },
                    "lwdError": null,
                    "hbrError": null,
                    "h4dmError": null,
                    "ntpError": null,
                    "diskUsage": {
                        "total": 10448273408,
                        "usable": 8925089792,
                        "free": 9477947392
                    },
                    "serviceBootTimestamp": 1684475115837,
                    "applianceBootTimestamp": 1684390250000
                }
            ],
            "lsError": null,
            "dbError": null,
            "ntpError": null,
            "localReplicatorsLsMismatch": null,
            "diskUsage": {
                "total": 10448273408,
                "usable": 8925114368,
                "free": 9477971968
            },
            "ssoAdminError": null,
            "serviceBootTimestamp": 1684475117541,
            "applianceBootTimestamp": 1684390250000,
            "tunnelConnectivity": [
                {
                    "tunnelService": {
                        "id": "3c70de9a-4bec-478a-b568-44b6366687c5",
                        "url": "https://127.0.0.1:8047",
                        "certificate": "MIIDbTCCAlWgAwIBAgIJAKMGsKZbGnmvMA0GCSqGSIb3DQEBCwUAMDgxEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xEjAQBgNVBAMTCXR1bm5lbC52bTAeFw0yMzA1MTgwNjA5MjBaFw0yNDA1MTcwNjA5MjBaMDgxEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xEjAQBgNVBAMTCXR1bm5lbC52bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALgHe46aDI78AjfAJ9wye+pJ5u7p0+6hkTd/5reL00ppzEx5jSr1dsl+rWt4PIsrwFciqIfSx8VkyyBoqKNQ2r7RIKwvq6N/6jm7+4vVJdKwxcFsRRHpnVOYtHX/KROZNTXYFLjOcRPtTpdWz7yVsaF15m1/D3DzxZKcL3B4E9EyM81S2KWXpKv+G91G3bIYXFm/tkFzQO7xddJwA5gkYsqJz0p0Gc/i3c3+M+StXMNlgoVYp14ovYYZZSvb+97z/3dX981JruoJ6taD38tFcBWsscjyVdF4D+R0C05fHn5u2DCZi5RJ8EeArA6FlS4GyAsU5DlVdZKSf1ouPCJcLG8CAwEAAaN6MHgwHQYDVR0OBBYEFHFUGmKD1fKt1F8aklc/kcz7KiqiMEIGA1UdEQQ7MDmCMXRuLTNjNzBkZTlhLTRiZWMtNDc4YS1iNTY4LTQ0YjYzNjY2ODdjNS50bmV4dXMuaW+HBApH2HAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwDQYJKoZIhvcNAQELBQADggEBACBQx2BQuVrWgAX8cctfNpnRrriSQKeD6pjzAzKqQh6A/8IMHiXvt727+QreFEGDW0dzXBLE/4U0QRZ6PrQ1ZnJZbyBaiyHyVUUTlmQKdouCEG67mr/jJg4OMvFVjcLgIRSvOadGCvzNXjgjfEqN65h4+LrCaJWl3Yh2xCD57RVZWuWLiN7dQlkDKgwEyYg7CBBb/ML0Q5MiHPpi3utwyJIrVdYS6ZI0vmZ1k1ucwetjan04lr64ek9Dh7C+D3xwumHWLvG+nn9oIqajbbdWnvzGpyvaw1lFVTUvJ86LLS8iNwbi4SqNZzgeKM6O4AlvpCBJuXrIEDxvahO6bBwmQpU="
                    },
                    "error": null
                }
            ]
        },
        "error": null,
        "warnings": [],
        "site": "site1-CD"
    },
    "resultType": "string",
    "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 indicates that the task did not complete yet.

ApiError
error
Optional

error

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.

ManagerHealthInfo
result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populates only when the execution succeeds.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+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.7+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.7+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.


On This Page
Diagnostics Operations
GET
About Info
DELETE
Delete
GET
Download
POST
Generate
POST
Generate With Id
POST
Health Info
GET
List