Skip to content
URL:
https://<root>/system/architectureprofiles/enhanced-availability
Methods:
GET
Version Introduced:
10.9

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.


Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.


Learn how to generate a token

Description

The enhanced-availability architecture profile is used in business and mission-critical production environments. This profile is designed for the highest level of availability, as it includes increased and expanded redundancy across critical pods. As a high-availability profile, enhanced-availability provides continued use and availability in the event of a failure. However, of the available profiles, it has the most hardware requirements. For more information, see Architecture profiles.

Highest replicated pods

The table below lists the pods with the highest number of replicas for the enhanced-availability profile. All other pods, which are not included in the table below, have one (1) replica. For more information about the enhanced-availability architecture profile, see the Architecture profiles topic at the link above.

PodReplica number

ingress-controller

3

rest-administrator-api

2

rest-services-api

2

private-ingress-controller

3

rest-portal-api

2

object-store-metadata

3

object-store-data

5

queue-store

2

spatiotemporal-index-store-coordinator

3

spatiotemporal-index-store-data

2

system-publishingtools-gpsyncserver

4

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the enhanced-availability profile:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/system/architectureprofiles/enhanced-availability?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
{
  "systemDefault": true,
  "deployments": [
    {
      "replicas": 3,
      "name": "ingress-controller"
    },
    {
      "replicas": 1,
      "name": "enterprise-help"
    },
    {
      "replicas": 2,
      "name": "rest-administrator-api"
    },
    {
      "replicas": 1,
      "name": "enterprise-manager"
    },
    {
      "replicas": 2,
      "name": "rest-services-api"
    },
    {
      "replicas": 1,
      "name": "service-lifecycle-manager"
    },
    {
      "replicas": 3,
      "name": "private-ingress-controller"
    },
    {
      "replicas": 2,
      "name": "rest-portal-api"
    },
    {
      "replicas": 1,
      "name": "enterprise-apps"
    },
    {
      "replicas": 1,
      "name": "enterprise-portal"
    },
    {
      "replicas": 1,
      "name": "javascript-api"
    },
    {
      "replicas": 1,
      "name": "rest-metrics-api"
    },
    {
      "replicas": 1,
      "name": "metrics-viewer"
    },
    {
      "replicas": 1,
      "name": "in-memory-store"
    },
    {
      "replicas": 3,
      "name": "object-store-metadata"
    },
    {
      "replicas": 5,
      "name": "object-store-data"
    },
    {
      "replicas": 2,
      "name": "queue-store"
    },
    {
      "replicas": 1,
      "name": "relational-store-primary"
    },
    {
      "replicas": 1,
      "name": "relational-store-standby"
    },
    {
      "replicas": 3,
      "name": "spatiotemporal-index-store-coordinator"
    },
    {
      "replicas": 2,
      "name": "spatiotemporal-index-store-data"
    },
    {
      "replicas": 1,
      "name": "system-cachingtools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "system-publishingtools-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-cachingcontrollers-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "system-featureservicetools-gpsyncserver"
    },
    {
      "replicas": 4,
      "name": "system-publishingtools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "system-synctools-gpserver"
    },
    {
      "replicas": 1,
      "name": "utilities-geocodingtools-gpserver"
    },
    {
      "replicas": 1,
      "name": "utilities-printingtools-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-featureservicetools-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-spatialanalysistools-gpserver"
    },
    {
      "replicas": 1,
      "name": "utilities-geometry-geometryserver"
    },
    {
      "replicas": 1,
      "name": "shared-mapserver"
    },
    {
      "replicas": 1,
      "name": "system-spatialanalysistools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "utilities-printingtools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "shared-tileserver"
    },
    {
      "replicas": 1,
      "name": "shared-featureserver"
    },
    {
      "replicas": 1,
      "name": "utilities-geocodingtools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "utilities-offlinepackaging-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "utilities-offlinepackaging-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-cachingcontrollers-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-cachingtools-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-synctools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "enterprise-web-style-app"
    },
    {
      "replicas": 1,
      "name": "featureserver-webhook-processor"
    },
    {
      "replicas": 1,
      "name": "gpserver-webhook-processor"
    },
    {
      "replicas": 1,
      "name": "system-reportingtools-gpserver"
    },
    {
      "replicas": 1,
      "name": "shared-imageserver"
    },
    {
      "replicas": 1,
      "name": "system-rasterprocessing-imageserver"
    },
    {
      "replicas": 1,
      "name": "system-rasteranalysistools-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-rasteranalysistools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "system-scenecachingtools-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-scenecachingtools-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "system-scenecachingcontrollers-gpserver"
    },
    {
      "replicas": 1,
      "name": "system-scenecachingcontrollers-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "utilities-rasterutilities-gpserver"
    },
    {
       "replicas": 1,
       "name": "utilities-rasterutilities-gpsyncserver"
    },
    {
      "replicas": 1,
      "name": "sampleworldcities-mapserver"
    }
  ],
  "name": "enhanced-availability",
  "id": "aofyriu4mxszwjgcxvbv3",
  "revision": 1660083664916
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.