Inspect a Gateway cluster

GET

https://flowai.uat.itential.io/gateway_manager/v1/gateway/:clusterId/:target

GET

/gateway_manager/v1/gateway/:clusterId/:target

$ curl https://flowai.uat.itential.io/gateway_manager/v1/gateway/clusterId/target \
>      -u "<username>:<password>"

1 {
2   "cluster_id": "cluster_1",
3   "components": {
4     "controller": {
5       "nodes": [
6         {
7           "hostname": "string",
8           "status": "active"
9         }
10       ]
11     },
12     "gateway_manager": {
13       "address": "string",
14       "status": "connected",
15       "type": "wss"
16     },
17     "runner": {
18       "nodes": [
19         {
20           "address": "string",
21           "status": "reachable",
22           "type": "embedded"
23         }
24       ]
25     },
26     "store": {
27       "backend": "etcd",
28       "nodes": [
29         {
30           "address": "string",
31           "status": "healthy"
32         }
33       ]
34     }
35   },
36   "healthy": true
37 }

Runs a named inspection operation against the specified gateway cluster. Use ‘health’ to get per-component health status, or ‘activity’ to get running and recently completed work across all runner nodes.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

clusterIdstringRequired

The cluster Id of the target gateway

targetstringRequired

The inspection target to run against the cluster

Response

The result of the inspection operation. Shape varies by target.

healthobject

Returned when target is 'health'. Use the healthy boolean to determine if the cluster can accept work.

activityobject

Returned when target is 'activity'.

Errors

500

Internal Server Error