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

/user/api/v1/servicePoints/{id} (GET) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide

Locale

English

Product name

BlueCat Edge

Version

Service Point v4.x.x

Returns information about a specific Service Point v4 that has been registered based on the ID of the service point.

Request: GET https://<us|eu>.fleet.bluec.at/user/api/v1/servicePoints/{id}
Authorization: Bearer token

Path parameter

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

Successful response

200 OK
{
    "id": "test_fsp_1-a9kf321st-abc2bcnab5pq",
    "name": "test_fsp_1",
    "description": "sp1 demo",
    "version": "4.5.0",
    "targetVersion": "4.6.0",
    "originalVersion": "4.4.0",
    "platform": "vmware",
    "lastSeen": 1660667769314,
    "status": "HEALTHY",
    "connectionStatus": "CONNECTED",
    "updateStatus": "OK",
    "anycastStatus": {
        "status": "enabled",
        "protocol": "ospf"
    },
    "ntpConfiguration": {
        "servers": [
            "0.debian.pool.ntp.org",
            "192.168.1.1"
        ],
        "clientNetworks": [
            "192.0.2.0/24",
            "fd00::1/64"
        ]
    },
    "ntpStatus": {
        "synchronized": true,
        "stratum": "3"
    },
    "hostname": "testfsp1",
    "ipv4CIDRAddress": "1.2.3.22/24",
    "ipv4GatewayAddress": "1.2.3.1",
    "ipv6CIDRAddress": "",
    "ipv6GatewayAddress": "",
    "addresses": [
        {
            "type": "ANYCAST",
            "ipAddress": "172.31.53.223",
            "interfaceName": "lo:1",
            "inUseByServiceInstanceId": "1531c09582404d68ada340e7d73f064b",
            "isUp": true
        }
    ],
    "httpProxySettings": {
        "host": "proxy.blue.cat",
        "scheme": "http",
        "port": "443",
        "user": "proxy"
    },
    "dnsServers": [
        "8.8.8.8"
    ],
    "errorConditions": [],
    "applications": [
        {
            "id": "cb40b217-8c2e-4958-b1ec-36a0c821bee7",
            "name": "dns-resolver-service",
            "version": "3.5.1",
            "status": "HEALTHY",
            "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"
        }
    ],
    "resources": {
        "size": "medium",
        "cpu": {
            "cores": 3,
            "frequencyMHz": 2400,
            "idlePercent": 85
        },
        "memory": {
            "totalMB": 4933,
            "freeMB": 1706
        },
        "disk": {
            "varTotalMB": 30581,
            "varFreeMB": 27711,
            "unallocatedMB": 26751
        }
    }
}

Where the fields represent the following:

id—the unique ID of the service point
name—the name of the service point
description—the description of the service point
version—the Service Point v4 version that is running on the service point
targetVersion—the Service Point v4 version to which the service point is to be updated
originalVersion—the Service Point v4 version that the service point was initially deployed with
platform—the platform that the service point is provisioned on
lastSeen—a timestamp representing the last time the management layer received a status update from the service point. If no timestamp is recorded, the value of this field is 0. The format of the field in a Unix timestamp in milliseconds elapsed since January 1, 1970 (UTC).
status—the status of the service point. The status can be one of the following:
- WAITING_FOR_PROVISIONING
- HEALTHY
- UNHEALTHY
- EXPIRED
connectionStatus—the connection status of the service point. The value can be one of the following:
- CONNECTED
- NOT_CONNECTED
updateStatus—the last reported status of the Service Point v4 update. The status can be one of the following:
- OK
- UPDATE_QUEUED
- UPDATE_RUNNING
- UPDATE_FAILED
anycastStatus—the status of the anycast service on the service point. The status includes the following information:
- status—indicates whether anycast service is enabled or disabled
- protocol—the routing protocol used for anycast. The routing protocol can be one of the following:
  - ospf
  - bgp
ntpConfiguration—the updated NTP configuration. The NTP configuration can only be retrieves from Service Point v4.7.0 and greater. The NTP configuration fields include the following:
- servers—a list of NTP servers that the service point synchronizes with. The value can be an IPv4 or IPv6 address, or an FQDN.
- clientNetworks—a list of IPv4 or IPv6 addresses or subnets that are allowed to access NTP service on the service point.
ntpStatus—the status of NTP on the service point. The status includes the following information:
- synchronized—indicates whether NTP has been synchronized
- protocol—the NTP stratum level, indicating the distance from the reference clock
hostname—the hostname of the device that the Service Point v4 is provisioned on
ipv4CIDRAddress—the IPv4 CIDR address of the service point
ipv4GatewayAddress—the IPv4 gateway address of the service point
ipv6CIDRAddress—the IPv6 CIDR address of the service point
ipv6GatewayAddress—the IPv6 gateway address of the service point
addresses—a list of IP addresses. The list includes the following information:
- type—the type of IP address. The type can be one of the following:
  - PRIMARY
  - ALIAS
  - ANYCAST
  - DSR
- ipAddress—the IPv4 or IPv6 address
- interfaceName—the interface using the IP address
- inUseByServiceInstanceId—the ID of the application using the IP address
- isUp—indicates whether the IP address is up
httpProxySettings—the HTTP proxy settings of the service point. The settings include the following information:
- host—the hostname of the HTTP proxy server
- scheme—the scheme of the HTTP proxy URL
- port—the port number used to connect to the proxy server
- user—the username used to authenticate with the proxy server
dnsServers—the list of DNS servers that the service point uses for resolution
errorConditions—a list of error conditions if the service point is not healthy
services—the services deployed to the service point. The services field includes the following information:
- id—the unique ID of service
- name—the name given to the service
- serviceName—the 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
resources—the resources consumed by the service point. The resources include the following:
- size—the size of the service point. The size can be one of the following:
  - small
  - medium
- cpu—the CPU information of the service point. The CPU information includes the following:
  - cores—the number of CPU cores on the service point
  - frequencyMHz—the CPU frequency, in megahertz (MHz)
  - idlePercent—the CPU idle percentage
- memory—the memory information of the service point. The memory information includes the following:
  - totalMB—the total amount of memory allocated to the service point, in megabytes (MB)
  - freeMB—the amount of available memory on the service point, in megabytes (MB)
- disk—the disk information of the service point. The disk information includes the following:
  - varTotalMB—the total amount of disk space in the /var partition of the service point, in megabytes (MB)
  - varFreeMB—the total amount of available disk space in the /var partition of the service point, in megabytes (MB)
  - unallocatedMB—the total amount of unallocated disk space on the service point, in megabytes (MB)

Possible error codes

401 Unauthorized
500 Internal Server Error