- URL:
- https://<root>/data/items/enterpriseDatabases/<datastoreItem>/machines/<machine>/validate
- Methods:
POST
- Required Capability:
- Access allowed with either the "Update", "Delete", "Security and Infrastructure", or "Servers" privileges
- Version Introduced:
- 10.3
Description
The validate
operation checks the status of ArcGIS Data Store and provides a health check response.
Request parameters
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
Example usage
The following are sample POST requests for the validate
operation that demonstrate different types of data stores provided with ArcGIS Data Store. Data store names, such as myhfs
, are specific to your ArcGIS Data Store.
Example one: validate a relational data store
POST /webadaptor/admin/data/items/enterpriseDatabases/myhfsDataStore/machines/myhfsDataStore/validate HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson
Example two: validate a tile cache data store
POST /webadaptor/admin/data/items/nosqlDatabases/AGSDataStore_nosql_mysceneDataStore/machines/mysceneDataStore/validate HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson
Example three: validate a spatiotemporal big data store
POST /webadaptor/admin/data/items/nosqlDatabases/AGSDataStore_bigdata_mystbDataStore/machines/mystbDataStore/validate HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson
JSON Response examples
The following examples are JSON responses for each type of data store in different situations.
Example one: Single-machine relational data store
Example two: Multimachine tile cache data store when all machines are accessible
Example three: Tile cache data store that has one inaccessible machine
Example four: Spatiotemporal big data store when all machines are available
Example five: Spatiotemporal big data store when one machine is unavailable
Example one
Response for a functioning single-machine relational data store
{
"datastore.release": "11.0.0.35046",
"datastore.name": "ds_d0hv9sqh",
"datastore.replmethod": "ASYNC",
"datastore.isConfigured": "true",
"machines": [
{
"machine.overallhealth": "Healthy",
"datastore.release": "11.0.0.35046",
"datastore.release.configstore": "1.5",
"platform": "Windows",
"machine.isReachable": "true",
"hostip": "10.44.9.21",
"name": "MACHINE.DOMAIN.COM",
"role": "PRIMARY",
"dbport": 9876,
"initstarttime": 1658691914117,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE.DOMAIN.COM:2443/arcgis/datastoreadmin/",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isInRecovery": "false",
"db.ActiveReplMethod": "NONE",
"db.isManagedUserConnValid": "true",
"datastore.release.pg": "12.4",
"datastore.release.sde": "11.0.0",
"datastore.release.geometry": "1.30.4.10",
"datastore.release.geometrylib": "1.30.4.10",
"db.isSiteConnValid": "true"
}
],
"datastore.release.configstore": "1.5",
"datastore.release.geometry": "1.30.4.10",
"datastore.release.geometrylib": "1.30.4.10",
"datastore.release.sde": "11.0.0",
"datastore.release.pg": "12.4",
"datastore.layer.extent.updated": false,
"datastore.status": "Started",
"datastore.isActiveHA": "false",
"datastore.overallhealth": "Healthy",
"datastore.lastfailover": -1,
"datastore.lastbackup": 1658732403060,
"datastore.isRegistered": "true",
"datastore.hasValidServerConnection": "true",
"datastore.validServerMachinesList": [
{
"machineName": "MACHINE.DOMAIN.COM",
"adminURL": "https://MACHINE.DOMAIN.COM:6443/arcgis/admin"
}
],
"owningSystemUrl": "https://MACHINE.DOMAIN.COM/server",
"status": "success"
}
Example two
Response for a multimachine tile cache data store when all machines are accessible
{
"datastore.release": "10.8.0.0",
"datastore.name": "tcs_zyxwvu7x",
"sharedbkloc": "//FILESHARE.DOMAIN.COM/share/bkup/tile/",
"datastore.isConfigured": "true",
"machines": [
{
"machine.overallhealth": "Healthy",
"datastore.release": "10.8.0.0",
"datastore.release.configstore": "1.4",
"platform": "Windows",
"machine.isReachable": "true",
"hostip": "10.20.20.40",
"name": "MACHINE1.DOMAIN.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571091475452,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE1.DOMAIN.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
},
{
"machine.overallhealth": "Healthy",
"datastore.release": "10.8.0.0",
"datastore.release.configstore": "1.4",
"platform": "Windows",
"machine.isReachable": "true",
"hostip": "10.10.11.11",
"name": "MACHINE2.DOMAIN.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571089621447,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE2.DOMAIN.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
}
{
"machine.overallhealth": "Healthy",
"datastore.release": "10.8.0.0",
"datastore.release.configstore": "1.4",
"platform": "Windows",
"machine.isReachable": "true",
"hostip": "10.10.10.10",
"name": "MACHINE3.DOMAIN.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571089621447,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE3.DOMAIN.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
}
],
"datastore.isRegistered": "true",
"datastore.hasValidServerConnection": "true",
"datastore.validServerMachinesList": [{
"machineName": "GISSERVER.DOMAIN.COM",
"adminURL": "https://GISSERVER.DOMAIN.COM:6443/arcgis/admin"
}],
"owningSystemUrl": "https://GISSERVER.DOMAIN.COM:6443/arcgis/admin",
"datastore.overallhealth": "Healthy"
}
Example three
Response for a tile cache data store that has one inaccessible machine
{
"datastore.release": "10.8.0.0",
"datastore.name": "tcs_abcdef8x",
"sharedbkloc": "//FILESHARE.DOMAIN.COM/share/bkup/tile/",
"datastore.isConfigured": "true",
"machines": [{
"machine.overallhealth": "Healthy",
"datastore.release": "10.8.0.0",
"datastore.release.configstore": "1.4",
"platform": "Windows",
"machine.isReachable": "true",
"hostip": "10.11.12.13",
"name": "MACHINE1.DOMAIN.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571091475452,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE1.DOMAIN.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
},
{
"machine.overallhealth": "Healthy",
"datastore.release": "10.8.0.0",
"datastore.release.configstore": "1.4",
"platform": "Windows",
"machine.isReachable": "true",
"hostip": "10.90.80.71",
"name": "MACHINE2.DOMAIN.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571089621447,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE2.DOMAIN.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
}],
"unavailableMachines": ["MACHINE3.DOMAIN.COM"],
"datastore.isRegistered": "true",
"datastore.hasValidServerConnection": "true",
"datastore.validServerMachinesList": [{
"machineName": "GISSERVER.DOMAIN.COM",
"adminURL": "https://GISSERVER.DOMAIN.COM:6443/arcgis/admin"
}],
"owningSystemUrl": "https://GISSERVER.DOMAIN.COM:6443/arcgis/admin",
"datastore.overallhealth": "Healthy"
}
Example four
Response for a spatiotemporal big data store when all machines are available
{
"datastore.name": "bds_123e45vf",
"clusterStatus": "GREEN",
"datastore.overallhealth": "Healthy",
"isHealthy": true,
"numOfNodes": 3,
"numOfPendingTasks": 0,
"activeShards": 22,
"activePrimaryShards": 11,
"relocatingShards": 0,
"initializingShards": 0,
"unassigned_shards": 0,
"nodes": [
{
"name": "MACHINE1.DOMAIN.COM",
"heapSize": 17179869184
},
{
"name": "MACHINE2.DOMAIN.COM",
"heapSize": 14004781056
}
{
"name": "MACHINE3.DOMAIN.COM",
"heapSize": 14004781056
}
]
}
Example five
Response for a spatiotemporal big data store when one machine is unavailable
{
"datastore.name": "bds_123e45vf",
"clusterStatus": "GREEN",
"datastore.overallhealth": "Healthy",
"isHealthy": true,
"numOfNodes": 3,
"numOfPendingTasks": 0,
"activeShards": 22,
"activePrimaryShards": 11,
"relocatingShards": 0,
"initializingShards": 0,
"unassigned_shards": 0,
"nodes": [
{
"name": "MACHINE1.DOMAIN.COM",
"heapSize": 17179869184
},
{
"name": "MACHINE3.DOMAIN.COM",
"heapSize": 14004781056
}
],
"unavailableNodes": ["MACHINE2.DOMAIN.COM"]
}