Overview

URL:
https://<root>/overview
Methods:
GET
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
10.9

Description

The overview resource returns the persisted cache or real-time information, such as health or status information, for the overview resource types. This resource is called when the Overview page of the Enterprise Manager is updated. Whether the information is cached or returned in real time depends on the updateIntervalMin property returned by the Config resource, which specifies the interval (in minutes) at which information for each resource type is pulled and cached. Resource types that have an updateIntervalMin value of 0 will not have their information cached and, instead, will have real-time information returned when the resource is called. The update interval can me modified through the Update operation.

Request parameters

ParameterDetails

resource

Specifies the resource type (criticalLogs, dataStores, systemServices, or utilityServices) that will have their information returned. Using all as the input value will return information for all resource types.

Example
Use dark colors for code blocksCopy
1
2
3
4
5
//Information (cached or real-time) returned for all resource types
resource=all

//Information for a single resource type returned
resource=dataStores

f

The response format.

Values: json | pjson

Example usages

The following is a sample request URL for the overview resource that returns the full list of overview resource types and their cached and real-time information:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/overview?resource=all&f=pjson

Individual resources can be returned by appending the resource type to the URL:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/overview?resource=dataStores&f=pjson

JSON Response example

The following response demonstrates the full list of cached and real-time information for all overview resource types:

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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
{
  "success": true,
  "resources": {
    "dataStores": {
      "lastUpdated": 1618456283032,
      "overviewDataStoreInfos": [
        {
          "overallHealth": "Healthy",
          "dataStoreId": "7e61dda8-4f3a-4d44-ab60-5dc2b9ece410",
          "details": [
            {
              "role": "primary",
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "totalPods": 1,
              "name": "arcgis-relational-store-sqe4i-primary",
              "freeDiskSpace": 172574,
              "freeMemory": 7411,
              "isHealthy": true
            },
            {
              "role": "standby",
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "totalPods": 1,
              "name": "arcgis-relational-store-sqe4i-standby",
              "freeDiskSpace": 172574,
              "freeMemory": 7504,
              "isHealthy": false
            }
          ],
          "dataStoreType": "egdb"
        },
        {
          "overallHealth": "Healthy",
          "numOfPods": 2,
          "dataStoreId": "074f0f27-a5e4-4491-b26c-560f8095081f",
          "details": [
            {
              "name": "arcgis-object-store-ihjvd-0",
              "storage": [
                {
                  "usedDiskSpace": 241048748032,
                  "totalDiskSpace": 400545546240,
                  "freeDiskSpace": 159496798208
                },
                {
                  "usedDiskSpace": 241048748032,
                  "totalDiskSpace": 400545546240,
                  "freeDiskSpace": 159496798208
                }
              ]
            },
            {
              "name": "arcgis-object-store-ihjvd-1",
              "storage": [
                {
                  "usedDiskSpace": 241048748032,
                  "totalDiskSpace": 400545546240,
                  "freeDiskSpace": 159496798208
                },
                {
                  "usedDiskSpace": 241048748032,
                  "totalDiskSpace": 400545546240,
                  "freeDiskSpace": 159496798208
                }
              ]
            }
          ],
          "dataStoreType": "objectStore"
        },
        {
          "overallHealth": "Healthy",
          "numOfPods": 3,
          "dataStoreId": "155c5885-8269-4e78-af98-34e17796c262",
          "details": [
            {
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "name": "arcgis-spatiotemporal-index-store-snn76-coordinator-0",
              "freeDiskSpace": 172574,
              "freeMemory": 4378
            },
            {
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "name": "arcgis-spatiotemporal-index-store-snn76-coordinator-2",
              "freeDiskSpace": 172574,
              "freeMemory": 4389
            },
            {
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "name": "arcgis-spatiotemporal-index-store-snn76-coordinator-1",
              "freeDiskSpace": 172574,
              "freeMemory": 4557
            }
          ],
          "dataStoreType": "nosql"
        }
      ]
    },
    "criticalLogs": {
      "lastUpdated": 1618456308259,
      "details": [
        {
          "logLevel": "SEVERE",
          "logMessage": "Error finding address candidates",
          "logSource": "California.GeocodeServer",
          "logTime": "2021-04-15T01:23:04,716"
        },
        {
          "logLevel": "SEVERE",
          "logMessage": "ArcSoc Construction failed 'California.GeocodeServer'.",
          "logSource": "",
          "logTime": "2021-04-15T01:21:27,077"
        },
        {
          "logLevel": "SEVERE",
          "logMessage": "California failed to initialize the server object 0x8007000e: You are not licensed for StreetMap Premium North America. .",
          "logSource": "",
          "logTime": "2021-04-15T01:21:27,039"
        },
        {
          "logLevel": "SEVERE",
          "logMessage": "URL 'https://basemaps.arcgis.com/arcgis/rest/services/World_Basemap_v2/VectorTileServer/tile/3/2/6.pbf' is not accessible: Error. java.io.IOException: Broken pipe.",
          "logSource": "Sharing",
          "logTime": "2021-04-14T23:54:41,037"
        },
        {
          "logLevel": "SEVERE",
          "logMessage": "URL 'https://basemaps.arcgis.com/arcgis/rest/services/World_Basemap_v2/VectorTileServer/tile/3/3/4.pbf' is not accessible: Error. java.io.IOException: Broken pipe.",
          "logSource": "Sharing",
          "logTime": "2021-04-14T23:54:40,836"
        }
      ]
    },
    "systemServices": {
      "lastUpdated": 1618456308056,
      "details": [
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "SpatialAnalysisTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 1,
          "serviceStatus": "STARTED",
          "totalPods": 1,
          "name": "SharedMapServiceHost",
          "type": "MapServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "SyncTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "CachingTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "ReportingTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 4,
          "serviceStatus": "STARTED",
          "totalPods": 4,
          "name": "PublishingTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "CachingControllers",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "FeatureServiceTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "serviceStatus": "STOPPED",
          "name": "SceneCachingControllers",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "serviceStatus": "STOPPED",
          "name": "SceneCachingTools",
          "type": "GPServer"
        }
      ]
    },
    "utilityServices": {
      "lastUpdated": 1618456261061,
      "details": [
        {
          "healthStatus": "HEALTHY",
          "activePods": 1,
          "serviceStatus": "STARTED",
          "totalPods": 1,
          "name": "Geometry",
          "type": "GeometryServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "PrintingTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "GeocodingTools",
          "type": "GPServer"
        },
        {
          "healthStatus": "HEALTHY",
          "activePods": 2,
          "serviceStatus": "STARTED",
          "totalPods": 2,
          "name": "OfflinePackaging",
          "type": "GPServer"
        }
      ]
    }
  }
}

The following response is returned when a single resource type (dataStores) is specified in the request URL:

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
{
  "success": true,
  "resources": {
    "dataStores": {
      "lastUpdated": 1618458421739,
      "overviewDataStoreInfos": [
        {
          "overallHealth": "Healthy",
          "dataStoreId": "7e61dda8-4f3a-4d44-ab60-5dc2b9ece410",
          "details": [
            {
              "role": "primary",
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "totalPods": 1,
              "name": "arcgis-relational-store-sqe4i-primary",
              "freeDiskSpace": 172539,
              "freeMemory": 7426,
              "isHealthy": true
            },
            {
              "role": "standby",
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "totalPods": 1,
              "name": "arcgis-relational-store-sqe4i-standby",
              "freeDiskSpace": 172539,
              "freeMemory": 7501,
              "isHealthy": false
            }
          ],
          "dataStoreType": "egdb"
        },
        {
          "overallHealth": "Healthy",
          "numOfPods": 2,
          "dataStoreId": "074f0f27-a5e4-4491-b26c-560f8095081f",
          "details": [
            {
              "name": "arcgis-object-store-ihjvd-0",
              "storage": [
                {
                  "usedDiskSpace": 241085448192,
                  "totalDiskSpace": 400544497664,
                  "freeDiskSpace": 159459049472
                },
                {
                  "usedDiskSpace": 241085448192,
                  "totalDiskSpace": 400544497664,
                  "freeDiskSpace": 159459049472
                }
              ]
            },
            {
              "name": "arcgis-object-store-ihjvd-1",
              "storage": [
                {
                  "usedDiskSpace": 241085448192,
                  "totalDiskSpace": 400544497664,
                  "freeDiskSpace": 159459049472
                },
                {
                  "usedDiskSpace": 241085448192,
                  "totalDiskSpace": 400544497664,
                  "freeDiskSpace": 159459049472
                }
              ]
            }
          ],
          "dataStoreType": "objectStore"
        },
        {
          "overallHealth": "Healthy",
          "numOfPods": 3,
          "dataStoreId": "155c5885-8269-4e78-af98-34e17796c262",
          "details": [
            {
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "name": "arcgis-spatiotemporal-index-store-snn76-coordinator-0",
              "freeDiskSpace": 172539,
              "freeMemory": 4376
            },
            {
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "name": "arcgis-spatiotemporal-index-store-snn76-coordinator-2",
              "freeDiskSpace": 172539,
              "freeMemory": 4397
            },
            {
              "totalMemory": 8192,
              "totalDiskSpace": 402456,
              "name": "arcgis-spatiotemporal-index-store-snn76-coordinator-1",
              "freeDiskSpace": 172539,
              "freeMemory": 4556
            }
          ],
          "dataStoreType": "nosql"
        }
      ]
    }
  }
}

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