Retrieve detailed diagnostics information about the Service Point v4 instance.
Request: GET http://<spv4_ip_address>:8083/api/v1/diagnosticsSuccessful response
200 OK
{
"addresses": [
{
"ipAddress": "10.10.10.27",
"type": "PRIMARY"
},
{
"inUseByServiceInstanceId": "fba58f44b1bc45918ffda0a61ff2e24d",
"interfaceName": "lo:1",
"ipAddress": "192.168.0.72",
"isUp": false
}
],
"anycastStatus": {
"protocol": "ospf",
"status": "enabled"
},
"services": [
{
"diagnostics": {
"backendResponse": "Praqma Network MultiTool (with NGINX) - 0cff205a2746 - 172.17.1.6/24",
"frontendResponse": "backend-multi-tool-backend@172.17.1.6:8088",
"id": 4
},
"id": "a2c59291-2b20-42d4-91e2-9ad89a52de6c",
"name": "bind9",
"serviceName": "DNS nameserver",
"status": "HEALTHY",
"version": "1.0.116"
}
],
"connectionStatus": "CONNECTED",
"corporateHttpProxy": {
"host": "10.10.10.154",
"port": "8888",
"proxyPasswordIsSet": true,
"scheme": "http",
"user": "user"
}
"dnsServers": [
"8.8.8.8",
"1.1.1.1"
],
"id": "sp1-cluster-shjea2iztkkk9xhnjy9jla",
"networkConnectivity": {
"fleetMgmtEndpointErrorMessage": "",
"fleetMgmtEndpointStatus": 200,
"internetHttpStatus": 200,
"internetPingStatus": "OK",
"localIpStatus": "OK",
"localNetworkStatus": "OK"
},
"ntpStatus": {
"stratum": "16",
"synchronized": false
},
"originalVersion": "4.5.0",
"platform": "vmware",
"registrationStatus": {
"details": "",
"state": "REGISTERED"
},
"status": "HEALTHY",
"updateStatus": "OK",
"version": "4.5.0"
}Where the fields represent the following:
- addresses—a list of IP addresses. The list of IP addresses includes the
following information:
- ipAddress—the IPv4 or IPv6 address.
- type—the type of IP address. The type can be one of the
following:
- PRIMARY
- ANYCAST
- ALIAS
- interfaceName—the interface configured with the Anycast IP address. This field is only included if the type is ANYCAST.
- isUseByAppId—the ID of the service using the Anycast IP address. This field is only included if the type is ANYCAST.
- isUp—indicates whether the Anycast IP address is up. This field is only included if the type is ANYCAST.
- anycastStatus—the Anycast status of the service point. The Anycast status
section includes the following information:
- status—indicates whether the Anycast service is enabled.
- protocol—the protocol used for the Anycast service
- services—the services deployed to the service point. The services field
includes the following information:
- diagnostics—the diagnostic information about the service deployed to the service point.
- id—the unique ID of service
- serviceName—the name of the service
- name—the user-defined name of the service.
- version—the version of the service
- status—the status of the service. The status can be one of the
following:
- HEALTHY
- UNHEALTHY
- DEPLOYING
- DEPLOY_FAILED
- DELETED
- errorConditions—a list of error conditions if the service is not healthy
- targetVersion—the version of the service software to which the service is to be updated
- updateStatus—the last reported status of the service update. The
status can be one of the following:
- UPDATE_QUEUED
- UPDATE_IN_PROGRESS
- DELETE_QUEUED
- DELETE_IN_PROGRESS
- connectionStatus—indicates whether the service point is connected.
- corporateHttpProxy—the proxy configuration of the service point. The
proxy configuration section includes the following information:
- host—the hostname of the proxy that the service point uses.
- port—the port that the service point uses to connect to the proxy.
- proxyPasswordIsSet—indicates whether a proxy password is configured.
- scheme—the scheme of the proxy.
- user—the username that is used to authenticate against the proxy server.
- networkConnectivity—the network connectivity of the service point. The
network connectivity section includes the following information:
- fleetMgmtEndpointErrorMessage—error messages related to the fleetMgmtEndpointStatus test.
- fleetMgmtEndpointStatus—the status code returned from checking if the service point can connect to the Fleet Management Ingress API gateway.
- internetHttpStatus—checks if an HTTP request to
google.comreturns a response.Note: This check might fail depending on the environment in which the service point is provisioned. - internetPingStatus—checks if ping requests to
8.8.8.8return a response.Note: This check might fail depending on the environment in which the service point is provisioned. - localIpStatus—checks if the local network interface is functioning correctly.
- localNetworkStatus—checks if ping requests to the default IPv4
gateway return a response.Note: This check might fail depending on the environment in which the service point is provisioned.
- registrationStatus—the registration status of the service point. The
registration status section includes the following information:
- details—the details related to the registration status of the service point.
- state—the registration state of the service point.
- ntpStatus—the NTP status of the service point. The NTP status section
includes the following information:
- stratum—the stratum of the NTP server.
- synchronized—indicates whether the service point is synchronized with the configured NTP server.
- id—the unique ID of the service point.
- originalVersion—the original Service Point v4 version configured on the service point.
- platform—the host platform that the service point is provisioned on.
- registrationStatus—the registration status of the service point. The
registration status includes the following information:
- details—details related to the state of the registration.
- state—indicates whether the service point has successfully registered.
- status—the health status of the service point.
- updateStatus—the status of the Service Point v4 update.
- version—the Service Point v4 version that is running on the service point.