Health Info

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



The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.

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 C4ApiTask_of_CloudHealthInfo 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": "84815423-65e9-4c9e-8435-5295a13881e7",
        "user": "root",
        "workflowInfo": {
            "type": "health",
            "resourceType": "CLOUD",
            "resourceId": null,
            "resourceName": null
        },
        "progress": 100,
        "state": "SUCCEEDED",
        "lastUpdated": -1,
        "startTime": 1684738292714,
        "endTime": 1684738293254,
        "resultType": "CloudHealthInfo",
        "result": {
            "productName": "VMware Cloud Director Availability Cloud Service",
            "buildVersion": "4.6.0.6689753-8554b3d026",
            "buildDate": 1684512489298,
            "instanceId": "6959cd85-5bd9-47a2-886b-3d938e3c0856",
            "runtimeId": "6bf29550-b1c0-4654-ab89-06aa0b044d59",
            "currentTime": 1684738293253,
            "address": "10.71.251.95",
            "tunnelConnectivity": [
                {
                    "tunnelService": {
                        "id": "93117800-9c9e-4a9b-873f-2902cdf91021",
                        "url": "https://10.71.251.95:8047/",
                        "certificate": "MIIDbTCCAlWgAwIBAgIJAM/dLZoZzM0YMA0GCSqGSIb3DQEBCwUAMDgxEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xEjAQBgNVBAMTCXR1bm5lbC52bTAeFw0yMzA1MjIwNjA3MjJaFw0yNDA1MjEwNjA3MjJaMDgxEDAOBgNVBAoTB1Vua25vd24xEDAOBgNVBAsTB1Vua25vd24xEjAQBgNVBAMTCXR1bm5lbC52bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMADIXrx5lcclF0Pk3Ru1mJy0IlIIPDocJ+hw2Ck/JJIEhrJTsyZ2isYtONzHqRVUAztEzO1BZB0jLX7G0ccgtJ7ny6m/t8SzlAHbS/xeipjCYR2vmtg0He1DhHiY3/xt09mskoaJGq3TIFMY/R1QJlinEL6TZ0VpBULJKPbsS27Sc/QlkZXI2UDI6NUUkS60j+5MUdq/mqHJz05BND9kQMceFUI6RjWAIyEmtUOF+6ihzt7nvgqeNyf14XQAclwDR6lJ6ayQV0l9JcK6isCpkU8D0MmhPS6s/XnMaeV7IpbFF+xAw1CA9QOu+7QZNRvBE6YEfjgCXmgseyhqXacruMCAwEAAaN6MHgwHQYDVR0OBBYEFEGoJheD1NFAyrXPwsSNkVY+EnKUMEIGA1UdEQQ7MDmCMXRuLWRjMGViMmY5LWQ1ZjEtNDUzOS1iY2MwLTQxNjgyZGQ5NmM3NS50bmV4dXMuaW+HBApH+18wEwYDVR0lBAwwCgYIKwYBBQUHAwEwDQYJKoZIhvcNAQELBQADggEBAG2yUO756qH7+kbXF4oyFHlh1QVULQY8vc83rtEt17G/Edx4X2GUjaesFm1sNLhOr03kmoE1aoPeDFFnVyz1nKFG9oHf9nfHK5qihgbc18CADDX8pOLLmbtZsdrHeqaDR7r+/muGBiNoMwrgSXVJ8qSnCzABXwp43HfYcl9zV6Ed0iVEKJXda09cn6aJtFunXhc/MawNnqUCAzxwgIpmAKa58+cx0Ovbeu5T8EBrFLS6SAeIQVqYeX+/w4JYPPwIbQqexXwX26iVnxl+onCbvdPmH9qEkOxw/V74AyUkCRP0fnR6RUINbUNHMKKdHCD+ODC7iSl2WuTxGa+loN783pQ="
                    },
                    "error": null
                }
            ],
            "vcdError": null,
            "managerError": null,
            "managerHealth": {
                "productName": "VMware Cloud Director Availability Manager Service",
                "buildVersion": "4.6.0.6689753-8554b3d026",
                "buildDate": 1684512489298,
                "instanceId": "abf6f282-236b-4d80-aec9-2d99b2299a4a",
                "runtimeId": "35249b41-8598-48a7-905f-51f8b520ca1e",
                "currentTime": 1684738293242,
                "address": "10.71.251.95",
                "offlineReplicators": [],
                "onlineReplicators": [
                    {
                        "id": "21683d52-21da-420f-81b8-319578d8f3d0",
                        "owner": "*",
                        "site": "site1",
                        "description": "Auto-paired appliance local replicator 10.71.251.95 at site site1",
                        "apiUrl": "https://10.71.251.95:8043",
                        "certThumbprint": "SHA-256:E9:42:0B:5F:17:EF:1B:B0:CC:B9:2B:CA:B4:0C:10:93:B1:64:9D:98:F4:30:7E:66:12:78:4E:F2:91:08:8E:8F",
                        "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.251.95:44045",
                        "buildVersion": "4.6.0.6689753-8554b3d026"
                    }
                ],
                "localReplicatorsHealth": [
                    {
                        "productName": "VMware Cloud Director Availability Replicator Service",
                        "buildVersion": "4.6.0.6689753-8554b3d026",
                        "buildDate": 1684512489298,
                        "instanceId": "21683d52-21da-420f-81b8-319578d8f3d0",
                        "runtimeId": "c1205483-c5fc-4a59-9850-693ff5db976d",
                        "currentTime": 1684738293185,
                        "address": "10.71.251.95",
                        "offlineManagers": [],
                        "onlineManagers": [
                            {
                                "id": "abf6f282-236b-4d80-aec9-2d99b2299a4a",
                                "description": "Auto-paired appliance local replicator 10.71.251.95 at site site1",
                                "certThumbprint": "SHA-256:2C:BF:3C:37:BD:A1:50:AE:B3:3F:F9:13:22:A6:2A:71:BE:AD:8F:2E:FC:EE:6B:2F:C3:17:74:F0:42:DE:47:8F",
                                "owner": "*",
                                "apiUrl": "https://10.71.251.95:8044/",
                                "localUser": "[email protected]",
                                "localPassword": "<censored>",
                                "apiVersion": "4.6",
                                "isLocal": true
                            }
                        ],
                        "lsError": null,
                        "dbError": null,
                        "vcError": {
                            "abf6f282-236b-4d80-aec9-2d99b2299a4a": {
                                "6553e0f1-5573-44c4-8f54-be44ad5a7699": null
                            }
                        },
                        "lwdError": null,
                        "hbrError": null,
                        "h4dmError": null,
                        "ntpError": null,
                        "diskUsage": {
                            "total": 10448273408,
                            "usable": 8950378496,
                            "free": 9503236096
                        },
                        "serviceBootTimestamp": 1684735750014,
                        "applianceBootTimestamp": 1684735614000
                    }
                ],
                "lsError": null,
                "dbError": null,
                "ntpError": null,
                "localReplicatorsLsMismatch": null,
                "diskUsage": {
                    "total": 10448273408,
                    "usable": 8950407168,
                    "free": 9503264768
                },
                "ssoAdminError": null,
                "serviceBootTimestamp": 1684735726362,
                "applianceBootTimestamp": 1684735614000,
                "tunnelConnectivity": []
            },
            "lsError": null,
            "dbError": null,
            "ntpError": null,
            "diskUsage": {
                "total": 10448273408,
                "usable": 8950398976,
                "free": 9503256576
            },
            "serviceBootTimestamp": 1684735786046,
            "applianceBootTimestamp": 1684735614000
        },
        "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 indicates that the task did not complete yet.

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.

result
Optional

result

string
resultType
Optional

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

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.

state
Optional

state

string
user
Optional

The user who started the task.

warnings
Optional

Warnings, which occurred during the task execution.

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.