Get ESP servers in a deployment

get/deployments/{deploymentId}/server

Returns a list of ESP servers associated with this deployment.

Request Samples

Response Samples

1{
2  "accept": "application/json",
3  "count": 1,
4  "items": [
5    {
6      "adminPort": 7010,
7      "autoRegistered": false,
8      "clusterServer": false,
9      "combinedWindows": [],
10      "equipment": {
11        "diskSpace": 0,
12        "friendlyName": "espServer1",
13        "health": 0,
14        "hostName": "esp-server01.sas.com",
15        "id": "-1358091958",
16        "ipAddress": "esp-server01.sas.com",
17        "memoryUse": 0
18      },
19      "espServerId": "fba3b637-c55c-4ddb-91f5-f5635adfcb13",
20      "friendlyName": "ESPServer1",
21      "health": true,
22      "hostName": "esp-server01.sas.com",
23      "httpPort": 7010,
24      "id": "-1358091958",
25      "ipAddress": "esp-server01.sas.com",
26      "kerberosEnabled": false,
27      "memoryUsage": 0,
28      "metering": false,
29      "parameters": [],
30      "projects": [],
31      "pubSubPort": 7010,
32      "residentMemoryUsage": 0,
33      "ssl": false,
34      "state": "AVAILABLE",
35      "useAuthzHeader": false,
36      "version": "2022.12(7.32#2731)",
37      "virtualMemoryUsage": 0
38    }
39  ],
40  "limit": 50,
41  "name": "items",
42  "start": 0,
43  "version": 2
44}

Path Parameters

deploymentId
string<uuid>
true

The identifier of the deployment.

Query Parameters

excludeClusterServers
boolean
false

When set to true, only ESP servers that are not running in a cluster are returned.

Default:
false
limit
integer<int32>
false

The maximum number of records to be returned.

>= 1<= 10000
Default:
50
noDetails
boolean
false

When set to true, details of ESP servers and projects are not included.

Default:
false
start
integer<int64>
false

The number of the first record to be returned.

>= 0
Default:
0
suitableFor
string
false

When this parameter is set to removal, only ESP servers that do not have projects are returned.

Default:

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema
400Bad Request

The request was invalid. Additional information is available in the application logs if the environment variable LOGGING_LEVEL_ORG_SPRINGFRAMEWORK is set to DEBUG.

Schema
404Not Found

No resource exists at the requested path.

Schema