Service point diagnostics API - BlueCat DNS Edge

DNS Edge API Guide

Locale
English (United States)
Product name
BlueCat DNS Edge

Use this API for troubleshooting a service point. Returns overall health status of the service point, the service point ID, each service's status and service version, configured forwarder IPs, the current local time and time zone, and policy details.

Current

Request: GET http://<sp-ip-address>:80/v1/status/spDiagnostics

Replace the IP address with the IP address of the service point.

Successful response

200 OK
{
  "spStatus": "GOOD",
  "spId": "12345678-6fee-4e63-9b79-b6b519dbe7d8",
  "currentVersion": "3.5.2",
  "desiredVersion": "3.5.2",
  "spStatusTimestamp": 1650638336374,
  "spServicesStatuses": {
    "dns-gateway-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638336082,
      "serviceVersion": "2.0.0-build3219",
      "additionalDetails": {
        "settingsDiagnostics": {
          "id": "1eda9c03347bf7d4ad0b84756eec532b58712772",
          "lastSettingsPollingTimestamp": 1650638336080,
          "lastSuccessfulSettingsUpdateTimestamp": 1650638336080,
          "lastSettingsPollingStatusReason": "Site settings parcel was too large to parse or store" |
                                             "Umbrella API credentials were invalid for the umbrella device" |
                                             "Failed to get umbrella device registration or to register umbrella device" |
                                             "An internal error occurred generating the site settings parcel"

          "namespaceDetails": [
            {
              "id": "4e411b9a-770e-48d1-85b9-2c604873fb64",
              "name": "External",
              "forwarders": [
                "8.8.8.8"
              ],
              "matchListsDomainCount": 0,
              "exceptionListsDomainCount": 0,
              "matchesAllDomains": true,
              "matchCidrCount": 0,
              "exceptionCidrCount": 0,
              "ttl": -1,
              "staleCacheEntriesTTL": 3600,
              "umbrellaConfiguration": null,
              "ecsConfiguration": null,
              "dohEnabled": false,
              "retryRCodes": [
                3
              ]
            }
          ]
        },
        "policyDiagnostics": {
          "id": "-949894288",
          "policyEventTimestamp": 1650638336080,
          "lastUpdateTimestamp": 1650638336080,
          "lastPolicyEventResult": "UNCHANGED",
          "policyDetails": [
            {
              "policyName": "Monitor Google",
              "policyId": "1638212014942-34ab7714-c138-4a68-9eeb-f71248a7644e",
              "numberDomains": 1,
              "numberExceptions": 0,
              "policyAction": "monitor"
            }
          ]
        },
        "timeZone": "America/Toronto"
      },
      "resources": [
        {
          "id": "namespace-4e411b9a-770e-48d1-85b9-2c604873fb64",
          "type": "namespace",
          "status": "GOOD",
          "info": [
            {
              "name": "responses",
              "value": 0
            },
            {
              "name": "servfail-responses",
              "value": 0
            },
            {
              "name": "queries",
              "value": 0
            },
            {
              "name": "frontend-nxdomain",
              "value": 0
            },
            {
              "name": "frontend-servfail",
              "value": 0
            },
            {
              "name": "frontend-noerror",
              "value": 0
            },
            {
              "name": "acl-drops",
              "value": 0
            },
            {
              "name": "rule-drop",
              "value": 0
            },
            {
              "name": "rule-nxdomain",
              "value": 0
            },
            {
              "name": "rule-refused",
              "value": 0
            },
            {
              "name": "rule-servfail",
              "value": 0
            },
            {
              "name": "rule-truncated",
              "value": 0
            },
            {
              "name": "self-answered",
              "value": 0
            },
            {
              "name": "downstream-timeouts",
              "value": 0
            },
            {
              "name": "downstream-send-errors",
              "value": 0
            },
            {
              "name": "trunc-failures",
              "value": 0
            },
            {
              "name": "no-policy",
              "value": 0
            },
            {
              "name": "latency0-1",
              "value": 0
            },
            {
              "name": "latency1-10",
              "value": 0
            },
            {
              "name": "latency10-50",
              "value": 0
            },
            {
              "name": "latency50-100",
              "value": 0
            },
            {
              "name": "latency100-1000",
              "value": 0
            },
            {
              "name": "latency-slow",
              "value": 0
            },
            {
              "name": "latency-avg100",
              "value": 0
            },
            {
              "name": "latency-avg1000",
              "value": 0
            },
            {
              "name": "latency-avg10000",
              "value": 0
            },
            {
              "name": "latency-avg1000000",
              "value": 0
            },
            {
              "name": "uptime",
              "value": 163143
            },
            {
              "name": "real-memory-usage",
              "value": 39202816
            },
            {
              "name": "udp-in-errors",
              "value": 0
            },
            {
              "name": "udp-noport-errors",
              "value": 0
            },
            {
              "name": "udp-recvbuf-errors",
              "value": 0
            },
            {
              "name": "udp-sndbuf-errors",
              "value": 0
            },
            {
              "name": "tcp-listen-overflows",
              "value": 0
            },
            {
              "name": "noncompliant-queries",
              "value": 0
            },
            {
              "name": "noncompliant-responses",
              "value": 0
            },
            {
              "name": "proxy-protocol-invalid",
              "value": 0
            },
            {
              "name": "rdqueries",
              "value": 0
            },
            {
              "name": "empty-queries",
              "value": 0
            },
            {
              "name": "cache-hits",
              "value": 0
            },
            {
              "name": "cache-misses",
              "value": 0
            },
            {
              "name": "cpu-iowait",
              "value": 87515
            },
            {
              "name": "cpu-steal",
              "value": 0
            },
            {
              "name": "cpu-sys-msec",
              "value": 69334
            },
            {
              "name": "cpu-user-msec",
              "value": 141869
            },
            {
              "name": "fd-usage",
              "value": 44
            },
            {
              "name": "dyn-blocked",
              "value": 0
            },
            {
              "name": "dyn-block-nmg-size",
              "value": 0
            },
            {
              "name": "security-status",
              "value": 0
            },
            {
              "name": "doh-query-pipe-full",
              "value": 0
            },
            {
              "name": "doh-response-pipe-full",
              "value": 0
            },
            {
              "name": "latency-sum",
              "value": 0
            },
            {
              "name": "latency-count",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "namespace-4e411b9a-770e-48d1-85b9-2c604873fb64-forwarder-0",
          "type": "forwarder",
          "status": "GOOD",
          "info": [
            {
              "name": "reuseds",
              "value": 0
            },
            {
              "name": "tcpAvgConnectionDuration",
              "value": 0
            },
            {
              "name": "tcpAvgQueriesPerConnection",
              "value": 0
            },
            {
              "name": "sendErrors",
              "value": 0
            },
            {
              "name": "tcpDiedReadingResponse",
              "value": 0
            },
            {
              "name": "tcpMaxConcurrentConnections",
              "value": 0
            },
            {
              "name": "queries",
              "value": 0
            },
            {
              "name": "tcpReusedConnections",
              "value": 0
            },
            {
              "name": "tcpWriteTimeouts",
              "value": 0
            },
            {
              "name": "address",
              "value": "8.8.8.8:53"
            },
            {
              "name": "tcpReadTimeouts",
              "value": 0
            },
            {
              "name": "latency",
              "value": 0
            },
            {
              "name": "weight",
              "value": 1
            },
            {
              "name": "tcpConnectTimeouts",
              "value": 0
            },
            {
              "name": "dropRate",
              "value": 0
            },
            {
              "name": "outstanding",
              "value": 0
            },
            {
              "name": "order",
              "value": 1
            },
            {
              "name": "name",
              "value": "8.8.8.8:53"
            },
            {
              "name": "tcpGaveUp",
              "value": 0
            },
            {
              "name": "tcpNewConnections",
              "value": 0
            },
            {
              "name": "id",
              "value": 0
            },
            {
              "name": "pools",
              "value": []
            },
            {
              "name": "qps",
              "value": 0
            },
            {
              "name": "qpsLimit",
              "value": 0
            },
            {
              "name": "responses",
              "value": 0
            },
            {
              "name": "tcpCurrentConnections",
              "value": 0
            },
            {
              "name": "tcpDiedSendingQuery",
              "value": 0
            },
            {
              "name": "state",
              "value": "up"
            }
          ],
          "errors": []
        }
      ]
    },
    "naming-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638336351,
      "serviceVersion": "1.0.0-build637"
    },
    "status-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638336353,
      "serviceVersion": "2.0.0-build578"
    },
    "sp-proxy": {
      "status": "GOOD",
      "statusTimestamp": 1650638336141,
      "serviceVersion": "1.0.0-build352",
      "additionalDetails": {
        "databaseConnectionStatus": "GOOD",
        "certificateInfo": {
          "certificatesExpired": false,
          "certificateExpiryTime": 1669484719000
        },
        "proxyStatus": "Running"
      }
    },
    "monitoring-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638336103,
      "serviceVersion": "1.0.0-build740",
      "resourceDetails": {
        "cloudwatch-metrics-status": "GOOD"
      },
      "additionalDetails": {
        "cloudwatch-metrics-success-count": 5,
        "cloudwatch-metrics-failure-count": 0
      }
    },
    "update-controller-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638336123,
      "serviceVersion": "1.0.0-build1148",
      "additionalDetails": {
        "spCertificateDiagnostics": {
          "certificateInformation": {
            "certificates": {
              "clientCertificates": [
                {
                  "validFrom": 1643901207000,
                  "validTo": 1738595607000,
                  "identifier": "550CB02C3466B5062659669FC1090EE22F5264A288533148D2ADFEC3E4080B41"
                }
              ],
              "caCertificates": [
                {
                  "validFrom": 1497966500000,
                  "validTo": 1529502500000,
                  "identifier": "3AA889286E2C25EE4BF536389AC2258E9204221C21E3C12E38CA62DBDE2FE383"
                },
                {
                  "validFrom": 1518205817000,
                  "validTo": 1549741817000,
                  "identifier": "FF4EBA18C3D6DE60D6863E3FA31A3BA04FCF9180BB463E3F70D3C90D8EC408CE"
                },
                {
                  "validFrom": 1518211597000,
                  "validTo": 1549747597000,
                  "identifier": "E48FBA33CE85EEAE60D255BD4E0880AA84542832A2CE6462CC6CD2695D524A37"
                },
                {
                  "validFrom": 1518446563000,
                  "validTo": 1549982563000,
                  "identifier": "0C6E7F743B462460ECF12706E9D67386FE298BB2692A33C9F35A64D7AF4EFB14"
                },
                {
                  "validFrom": 1518457858000,
                  "validTo": 1549993858000,
                  "identifier": "426E2592CD526EBFC4D22CD89869E1A63693544394B06769785B5770D5BC4082"
                },
                {
                  "validFrom": 1555099682000,
                  "validTo": 1649794082000,
                  "identifier": "9C0DBA361AECD2CF2D050594B711D4F13C46703DB45C5DEED2899FC58FB676DC"
                },
                {
                  "validFrom": 1643901207000,
                  "validTo": 1738595607000,
                  "identifier": "8DF035132375B3295C58DABB9E92FC02AD09AE876506A6A21F77CDDC7C768A8E"
                }
              ]
            },
            "certificateUpdateTimestamp": 1643901411565
          },
          "updateStatusInformation": {
            "certificateUpdateStatus": "COMPLETE",
            "lastUpdateTime": 1643901411568
          }
        }
      }
    },
    "routing-controller-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638336177,
      "serviceVersion": "1.0.0-build742",
      "additionalDetails": {
        "routingDaemonServiceInfo": {
          "status": "GOOD",
          "serviceVersion": "1.0.0-build48",
          "routingDaemons":{ 
              "zebra":{ 
                  "status": "running"| "not running" | "off" | "suspended"
              },
              "ospf":{ 
                  "status":"running"| "not running" | "off" | "suspended"
              },
              "bgp":{ 
                  "status":"running"| "not running" | "off" | "suspended"
            }
          }
        },
        "dnsHealthMonitorInterval": 30000
      }
    },
    "sp-logspout": {
      "status": "GOOD",
      "statusTimestamp": 1650638336333
    },
    "sp-controller-service": {
      "status": "GOOD",
      "statusTimestamp": 1650638335915,
      "serviceVersion": "1.0.0-build1003",
      "resourceDetails": {
        "customer-instance-connection": "GOOD"
      },
      "additionalDetails": {
        "dns-resolving-responses": {
          "rootNSQuery": "NOERROR",
          "edgeCloudEndpoint": "NOERROR"
        }
      },
      "resources": [
        {
          "id": "customerInstanceConnection",
          "type": "customerInstanceConnection",
          "status": "GOOD",
          "info": [],
          "errors": []
        },
        {
          "id": "dnsResolvingResponses",
          "type": "dnsResolvingResponses",
          "status": "GOOD",
          "info": [
            {
              "name": "rootNSQuery",
              "value": "NOERROR"
            },
            {
              "name": "edgeCloudEndpoint",
              "value": "NOERROR"
            }
          ],
          "errors": []
        },
        {
          "id": "certificates",
          "type": "certificates",
          "status": "GOOD",
          "info": [
            {
              "name": "clientCertificateExpiration",
              "value": 1738595607000
            },
            {
              "name": "caCertificateExpiration",
              "value": 1738595607000
            }
          ],
          "errors": []
        }
      ]
    },
    "parclo-logging": {
      "status": "GOOD",
      "statusTimestamp": 1650638336055,
      "serviceVersion": "1.0.0-build1629",
      "resourceDetails": {
        "kinesis-stream-status": "GOOD"
      },
      "additionalDetails": {
        "custom-logging-endpoint": {
          "url": "",
          "header-names": [],
          "sha256-fingerprint": ""
        },
        "stored-offline-queries-bytes": 0,
        "kinesis-put_success": 0,
        "logging-endpoint-dropped-count": 0,
        "logging-endpoint-put-success-count": 0,
        "incoming-dns-events-dropped-count": 0,
        "logging-to-edge-cloud-console": true,
        "kinesis-put_fail": 0,
        "logging-to-custom-logging-endpoint": false,
        "logging-endpoint-put-failed-count": 0
      },
      "resources": [
        {
          "id": "unlogged-queries",
          "type": "unlogged-queries",
          "status": "N/A",
          "info": [
            {
              "name": "stored-offline-queries-bytes",
              "value": 0
            },
            {
              "name": "incoming-dns-events-dropped-count",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "logging-endpoint",
          "type": "logging-endpoint",
          "status": "N/A",
          "info": [
            {
              "name": "logging-endpoint-dropped-count",
              "value": 0
            },
            {
              "name": "logging-endpoint-put-success-count",
              "value": 0
            },
            {
              "name": "logging-endpoint-put-failed-count",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "kinesis-stream",
          "type": "kinesis-stream",
          "status": "GOOD",
          "info": [
            {
              "name": "kinesis-put_success",
              "value": 0
            },
            {
              "name": "kinesis-put_fail",
              "value": 0
            }
          ],
          "errors": []
        },
        {
          "id": "firehose-credentials",
          "type": "firehose-credentials",
          "status": "GOOD",
          "info": [
            {
              "name": "firehose-credential-expiration",
              "value": 1650638948000
            }
          ],
          "errors": []
        }
      ]
    }
  },
  "additionalDetails": {
    "nameservers": [
      "1.2.3.9"
    ],
    "currentLocalTime": "2022-04-22 10:38:56",
    "networkConfiguration": {
      "spInterfaces": [
        {
          "name": "lo",
          "ipAddress": "127.0.0.1/8",
          "macAddress": "00:00:00:00:00:00",
          "inet6": "::1/128"
        },
        {
          "name": "ens192",
          "ipAddress": "1.2.3.4/24",
          "macAddress": "00:50:56:9b:4a:c5",
          "inet6": "fe80::250:56ff:fe9b:4ac5/64"
        },
        {
          "name": "br-113cd176083e",
          "ipAddress": "247.127.128.1/24",
          "macAddress": "02:42:05:9f:8f:68",
          "inet6": "fe80::42:5ff:fe9f:8f68/64"
        },
        {
          "name": "docker0",
          "ipAddress": "247.127.127.1/24",
          "macAddress": "02:42:3e:3c:66:ab",
          "inet6": "fe80::42:3eff:fe3c:66ab/64"
        },
        {
          "name": "vethef612d0@if7",
          "ipAddress": null,
          "macAddress": "fa:f9:ae:09:f5:91",
          "inet6": "fe80::f8f9:aeff:fe09:f591/64"
        },
        {
          "name": "vethd2b8e11@if9",
          "ipAddress": null,
          "macAddress": "de:0b:71:05:80:c5",
          "inet6": "fe80::dc0b:71ff:fe05:80c5/64"
        },
        {
          "name": "veth3b7bd3f@if11",
          "ipAddress": null,
          "macAddress": "4a:b2:3c:c2:d2:f4",
          "inet6": "fe80::48b2:3cff:fec2:d2f4/64"
        },
        {
          "name": "veth2639953@if13",
          "ipAddress": null,
          "macAddress": "5e:d1:bc:5b:f0:2c",
          "inet6": "fe80::5cd1:bcff:fe5b:f02c/64"
        },
        {
          "name": "veth9f98a96@if17",
          "ipAddress": null,
          "macAddress": "0e:8b:b0:f4:ab:27",
          "inet6": "fe80::c8b:b0ff:fef4:ab27/64"
        },
        {
          "name": "vethab3a5b9@if21",
          "ipAddress": null,
          "macAddress": "3a:4a:17:ec:48:15",
          "inet6": "fe80::384a:17ff:feec:4815/64"
        },
        {
          "name": "vethb1c6f4e@if23",
          "ipAddress": null,
          "macAddress": "de:31:11:0a:dd:2b",
          "inet6": "fe80::dc31:11ff:fe0a:dd2b/64"
        },
        {
          "name": "vethee2b3d6@if33",
          "ipAddress": null,
          "macAddress": "52:4d:65:c2:c8:78",
          "inet6": "fe80::504d:65ff:fec2:c878/64"
        },
        {
          "name": "veth35bb48d@if35",
          "ipAddress": null,
          "macAddress": "26:d2:6f:e2:81:98",
          "inet6": "fe80::24d2:6fff:fee2:8198/64"
        },
        {
          "name": "vethe2273ce@if39",
          "ipAddress": null,
          "macAddress": "de:77:ab:f0:ce:83",
          "inet6": "fe80::dc77:abff:fef0:ce83/64"
        },
        {
          "name": "veth5fdaf7d@if43",
          "ipAddress": null,
          "macAddress": "5e:8f:ae:fa:7c:9e",
          "inet6": "fe80::5c8f:aeff:fefa:7c9e/64"
        },
        {
          "name": "veth7ef952c@if47",
          "ipAddress": null,
          "macAddress": "72:17:bc:eb:a5:ae",
          "inet6": "fe80::7017:bcff:feeb:a5ae/64"
        },
        {
          "name": "veth8ad2d7e@if55",
          "ipAddress": null,
          "macAddress": "3e:7a:c8:81:fc:91",
          "inet6": "fe80::3c7a:c8ff:fe81:fc91/64"
        },
        {
          "name": "veth8cdd4b6@if57",
          "ipAddress": null,
          "macAddress": "2a:df:4c:51:ad:4e",
          "inet6": "fe80::28df:4cff:fe51:ad4e/64"
        },
        {
          "name": "veth428b34b@if59",
          "ipAddress": null,
          "macAddress": "da:92:48:05:d2:27",
          "inet6": "fe80::d892:48ff:fe05:d227/64"
        },
        {
          "name": "vethf6a4495@if65",
          "ipAddress": null,
          "macAddress": "92:d3:45:29:df:00",
          "inet6": "fe80::90d3:45ff:fe29:df00/64"
        },
        {
          "name": "veth1350f76@if67",
          "ipAddress": null,
          "macAddress": "c6:ce:5a:37:1c:d7",
          "inet6": "fe80::c4ce:5aff:fe37:1cd7/64"
        },
        {
          "name": "vethd9e041c@if71",
          "ipAddress": null,
          "macAddress": "6a:a2:fa:65:9d:40",
          "inet6": "fe80::68a2:faff:fe65:9d40/64"
        },
        {
          "name": "veth700bc99@if73",
          "ipAddress": null,
          "macAddress": "0e:39:90:1f:3b:61",
          "inet6": "fe80::c39:90ff:fe1f:3b61/64"
        },
        {
          "name": "veth385c5dc@if85",
          "ipAddress": null,
          "macAddress": "de:65:17:e4:0b:8f",
          "inet6": "fe80::dc65:17ff:fee4:b8f/64"
        },
        {
          "name": "veth55181bb@if87",
          "ipAddress": null,
          "macAddress": "56:25:84:b6:bf:3b",
          "inet6": "fe80::5425:84ff:feb6:bf3b/64"
        },
        {
          "name": "veth1ae80e0@if89",
          "ipAddress": null,
          "macAddress": "8a:3f:ec:68:82:88",
          "inet6": "fe80::883f:ecff:fe68:8288/64"
        },
        {
          "name": "vethe7b563e@if91",
          "ipAddress": null,
          "macAddress": "be:4b:71:df:3c:83",
          "inet6": "fe80::bc4b:71ff:fedf:3c83/64"
        },
        {
          "name": "veth0cbbbc0@if93",
          "ipAddress": null,
          "macAddress": "f6:7e:30:40:c0:89",
          "inet6": "fe80::f47e:30ff:fe40:c089/64"
        },
        {
          "name": "vethd29f9f4@if95",
          "ipAddress": null,
          "macAddress": "fe:cd:0d:f6:9a:36",
          "inet6": "fe80::fccd:dff:fef6:9a36/64"
        }
      ],
      "spRoutingTable": [
        {
          "destination": "0.0.0.0",
          "gateway": "1.2.3.1",
          "genmask": "0.0.0.0",
          "flags": "UG",
          "metric": "1024",
          "ref": "0",
          "use": "0",
          "iface": "ens192"
        },
        {
          "destination": "1.2.3.0",
          "gateway": "0.0.0.0",
          "genmask": "255.255.255.0",
          "flags": "U",
          "metric": "0",
          "ref": "0",
          "use": "0",
          "iface": "ens192"
        },
        {
          "destination": "1.2.3.4",
          "gateway": "0.0.0.0",
          "genmask": "255.255.255.255",
          "flags": "UH",
          "metric": "1024",
          "ref": "0",
          "use": "0",
          "iface": "ens192"
        },
        {
          "destination": "247.127.127.0",
          "gateway": "0.0.0.0",
          "genmask": "255.255.255.0",
          "flags": "U",
          "metric": "0",
          "ref": "0",
          "use": "0",
          "iface": "docker0"
        },
        {
          "destination": "247.127.128.0",
          "gateway": "0.0.0.0",
          "genmask": "255.255.255.0",
          "flags": "U",
          "metric": "0",
          "ref": "0",
          "use": "0",
          "iface": "br-113cd176083e"
        }
      ]
    },
    "timeSynchronization": {
      "status": "Synchronized to time server for the first time 1.2.3.4:123 (1.2.3.4).",
      "servers": []
    },
    "sshStatus": {
      "numberOfKeys": 1,
      "configStatus": "CONFIGURED" | "NOT_CONFIGURED" | "INVALID",
      "errors": []
    },
    "timeZone": "America/Toronto",
    "hostManager": "BLUECAT",
    "proxyConfiguration": {
      "configured": false,
      "protocol": null,
      "port": null,
      "host": null,
      "authenticationEnabled": null
    },
    "dns-resolving-responses": {
      "rootNSQuery": "NOERROR",
      "edgeCloudEndpoint": "NOERROR"
    }
  },
  "registration": {
    "registered": "true",
    "timestamp": 1637949186310,
    "siteId": "12345678-9870-98ef-85dc-34faaca80643",
    "customerId": "12345678-abcd-12ab-7890-acb9a5a1eg2",
    "registrationStatus": SUCCESSFUL |
                          FINISHED_STARTING_SERVICES |
                          STARTING_SERVICES |
                          FINISHED_GENERATING_SERVICE_POINT_PROPERTIES |
                          GENERATING_SERVICE_POINT_PROPERTIES |
                          REGISTERED_WITH_CLOUD |
                          REGISTERING_WITH_CLOUD |
                          NOT_REGISTERED |
                          FAILED_REGISTRATION_WITH_CLOUD |
                          FAILED_STARTING_SERVICES |
                          FAILED_GENERATING_SERVICE_POINT_PROPERTIES,
    "registrationFailureReason": "Failed to load configuration data" |
                                 "Failed to resolve Edge cloud endpoint hostname" |
                                 "Timed out connecting to Edge cloud endpoint" |
                                 "Error response from Edge cloud endpoint" |
                                 "Failed to load certificates" |
                                 "Failed to store certificates" |
                                 "SSL error occurred while trying to contact Edge cloud endpoint" |
                                 "SSL error: Client certificate expired" |
                                 "SSL error: Server does not trust client certificate" |
                                 "SSL error: Client does not trust server certificate" |
                                 "Failed to pull image" |
                                 "Failed to check status" |
                                 "Failed to start service" |
                                 "Failed to stop service" |
                                 "Failed to switch service" |
                                 "Failed to tag image" |
                                 "Failed to update rns" |
                                 "Failed to write to system file" |
                                 "Unexpected error",        
  },
  "updates": [
    {
      "serviceId": "sp-controller-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "parclo-logging",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "dns-gateway-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "monitoring-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "update-controller-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "routing-controller-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "sp-logspout",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "naming-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "remote-naming-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "routing-daemon-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    },
    {
      "serviceId": "status-service",
      "state": "FINISHED",
      "task": "UPGRADING"
    }
  ]
}

Namespace details

Under settingsDiagnostics, nameSpaceDetails, the parameter matchListDomainCount returns the total count of domains in the match lists attached to the namespace. However, "." represents all domains, but is counted as a single domain in the context of the domain list count. As a result, the parameter matchesAllDomains returns true or false in the following situations:
  • When one domain list is provided and contains "." as a domain, then matchesAllDomains will be true, but matchListDomainCount is 1.
  • If more than 1 domain list is provided, but any list contains "." as a domain, then the flag will be true and the "matchListDomainCount" reflects the count of domains across all domain lists (counting "." as one domain).
  • If no domain list is provided, then matchesAllDomains is true, but matchListDomainCount is 0.
  • If a domain list is provided with domains other than "." then matchesAllDomains is false, and matchListDomainCount reflects the count of domains in that list.

The exceptionsListDomainCount parameter is the total count of domains in the exception domain lists attached to the namespace.

Daemons Status

In the routing-controller-service section, the status for the zebra, OSPF, and BGP can be reported as:
  • running: The daemon is running with no issues.
  • not running: The daemon is enabled but isn't running.
  • suspended: The daemon failed the health check, and the service point was removed from the Anycast pool.
  • off: The daemon isn't enabled.

Update information

In the updates section, the task field will display UPGRADING regardless of whether the service point is upgrading to a newer service point software version or downgrading to an older software version.

Registration information

The field registrationFailureReason is only returned when the registration status is FAILED. If the registration state can't be determined, the status returned is N/A.