/user/api/v1/serviceInstances/{id} (GET) - BlueCat DNS Edge

DNS Edge User Guide (Service Point v4)

Locale
English
Product name
BlueCat DNS Edge

Retrieves a summary of a specific service deployed to a Service Point v4 based on the ID of the service.

Request: GET https://us.fleet.bluec.at/user/api/v1/serviceInstances/{id}
Authorization: Bearer token

Path parameter

Name Description Type Required/Optional
id The service instance ID Integer Required

Successful response

200 OK
{
  "id": "bind9-1.0.113",
  "servicePointID": "service-point-yk0_htyqrt-qxvdogdoghq",
  "serviceDescriptorID": "drs-3.8.0",
  "serviceName": "drs",
  "version": "3.8.0",
  "name": "Branch 0802 DNS",
  "parameters": [
    {
      "name": "SiteID",
      "value": "28953827-8b7c-4fdf-b447-39754783cb92"
    },
    {
      "name": "DRS_ID",
      "value": "00a3872e-9750-4a4f-8ebb-a7d0c57d7fd7"
    },
    {
      "name": "RegistrationTimestamp",
      "value": "1678312860"
    }
  ],
  "ingressEndpoints": [
    {
      "portLabel": "dns",
      "addresses": [
        "10.244.149.91",
        "fda5:574d:2:1::91",
        "192.168.0.99"
      ]
    },
    {
      "portLabel": "management",
      "addresses": [
        "10.244.149.91"
      ]
    },
    {
      "portLabel": "healthcheck",
      "addresses": [
        "10.244.149.100"
      ]
    }
  ],
  "status": "UNHEALTHY",
  "errorConditions": [
    "container is not healthy: parclo-logging 1.0.0-build1583",
    "container is not healthy: dns-gateway-service 2.0.0-build3157"
  ],
  "targetVersion": "3.9.0",
  "updateStatus": "UPDATE_QUEUED"
}
Where the parameters represent the following:
  • id—the unique ID of the service
  • servicePointID—the unique ID of the service point to which the service is deployed
  • serviceName—the name of the service
  • version—the version of the service
  • name—the user-defined name of the service.
  • parameters—information about the service including the following fields:
    • name—the name of the service parameter
    • value—the value of the service parameter
  • ingressEndpoints—information about the ingress endpoints of the service including the following fields:
    • portLabel—the label for the ingress endpoint
    • addresses—the IP addresses of the service point that bind to the ingress endpoint
  • 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 software to which the service is to be updated
  • updateStatus—the last reported status of the service version update. The status can be one of the following:
    • UPDATE_QUEUED
    • UPDATE_IN_PROGRESS
    • DELETE_QUEUED
    • DELETE_IN_PROGRESS