/api/v1/fleetInstances/{id}/applications (GET) - BlueCat DNS Edge

DNS Edge User Guide (Fleet Service Point)

Locale
English
Product name
BlueCat DNS Edge

Retrieves a list of services, such as DNS resolver service, deployed to a specified Fleet Service Point based on the ID of the Fleet Service Point.

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

Path parameter

Name Description Type Required/Optional
id The Fleet Service Point ID Integer Required

Successful response

200 OK
{
  "nextToken": "string",
  "data": [
    {
      "id": "cb40b217-8c2e-4958-b1ec-36a0c821bee7",
      "name": "dns-resolver-service",
      "version": "3.5.1",
      "status": "UNHEALTHY",
      "errorConditions": [
        "service is not healthy: parclo-logging 1.0.0-build1583",
        "service is not healthy: dns-gateway-service 2.0.0-build3157"
      ],
      "targetVersion": "3.5.3",
      "updateStatus": "UPDATE_QUEUED",
      "application": {
        "applicationName": "string",
        "version": "string",
        "services": [
          {
            "serviceID": "string",
            "memoryMB": 1,
            "internalPorts": [
              {
                "port": 65435,
                "label": "string"
              }
            ],
            "externalPorts": [
              {
                "port": 65535,
                "protocol": "tcp",
                "label": "string",
                "ipAddresses": [
                  "10.1.1.1"
                ]
              }
            ],
            "version": "string",
            "endpointDependencies": [],
            "envVars": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "volume": {
              "enabled": true,
              "sizeMB": 0
            },
            "health": {
              "type": "http",
              "portLabel": "string",
              "path": "string",
              "timeout": "string"
            },
            "metrics": {
              "portLabel": "string",
              "path": "string"
            }
          }
        ]
      }
    }
  ]
}
Where the parameters represent the following:
  • id—the unique ID of the application
  • name—the name of the application
  • version—the version of the application
  • status—the status of the application. The status can be one of the following:
    • HEALTHY
    • UNHEALTHY
    • DEPLOYING
    • DEPLOY_FAILED
    • DELETED
  • errorConditions—a list of error conditions if the is not healthy
  • targetVersion—the version of the application software to which the application is to be updated
  • updateStatus—the last reported status of the application update. The status can be one of the following:
    • UPDATE_QUEUED
    • UPDATE_IN_PROGRESS
    • DELETE_QUEUED
    • DELETE_IN_PROGRESS
  • application—information about the application including the following fields:
    • applicationName—the name of the application
    • version—the version of the application
    • services—the services of the application. The services include the following information:
      • serviceId—the ID of the service
      • memoryMB—the amount of memory assigned to the service, in megabytes
      • internalPorts—a list of internal ports used for services using TCP. The list of internal ports includes the following information:
        • port—the port of the internal service
        • label—a label for the internal service port usage
      • externalPorts—a list of external ports used for services using TCP or UDP. The list of external ports includes the following information:
        • port—the port of the external service
        • protocol—the protocol used by the external service. The protocol can be one of the following:
          • tcp
          • dns
        • label—a label for the external service port usage
        • ipAddresses—a list of IPv4 or IPv6 addresses that the Fleet Service Point load balancers will be configured to bind to when forwarding traffic to this application. Valid IP addresses are the primary IPv4 or IPv6 address, any IP aliases, or any unused anycast IP addresses configured on the Fleet Service Point.
      • version—the version of the service
      • endpointDependencies—a list of dependencies for an internal port of another service within the same application. The list of dependencies includes the following information:
        • serviceId—the ID of the service
        • label—a label for the service
      • envVars—a list of environment variables associated with the service
      • volume—the data volume attached to the service. The volume includes the following information:
        • enabled—indicates whether to attach a data volume to the service
        • sizeMB—the size of the data volume attached to the service, in megabytes
      • health—a script or HTTP-based health check for the service. Healthy services return 0 for script-based health checks and return an HTTP status code of 200 for HTTP-based health checks. The health configuration includes the following information:
        • type—the type of health check for the service. The type can be one of the following:
          • http
          • script
        • portLabel—the label for either an external or internal port
        • path—the absolute script path for script-based health checks or HTTP endpoint for HTTP-based health checks
        • timeout—the health check timeout. The value is a string denoted by 's' for seconds, 'm' for minutes, and 'h' for hours.
      • metrics—the HTTP-based metrics endpoint. The metrics endpoint includes the following information:
        • portLabel—the label for either an external or internal port
        • path—the path to reach the metrics endpoint.