- URL:
- https://<root>/data/items/enterpriseDatabases/<datastoreItem>/machines/<machine>/validate
- Methods:
POST- Version Introduced:
- 10.3
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
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 /<context>/admin/data/items/enterpriseDatabases/myhfsDataStore/machines/myhfsDataStore/validate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonExample two: validate a tile cache data store
POST /<context>/admin/data/items/nosqlDatabases/AGSDataStore_nosql_mysceneDataStore/machines/mysceneDataStore/validate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonExample three: validate a spatiotemporal big data store
POST /<context>/admin/data/items/nosqlDatabases/AGSDataStore_bigdata_mystbDataStore/machines/mystbDataStore/validate HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON 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.EXAMPLE.COM",
"role": "PRIMARY",
"dbport": 9876,
"initstarttime": 1658691914117,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE.EXAMPLE.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.EXAMPLE.COM",
"adminURL": "https://MACHINE.EXAMPLE.COM:6443/arcgis/admin"
}
],
"owningSystemUrl": "https://MACHINE.EXAMPLE.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.EXAMPLE.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": "MACHINE.EXAMPLE.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571091475452,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE.EXAMPLE.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.EXAMPLE.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571089621447,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE2.EXAMPLE.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.EXAMPLE.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571089621447,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE3.EXAMPLE.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
}
],
"datastore.isRegistered": "true",
"datastore.hasValidServerConnection": "true",
"datastore.validServerMachinesList": [{
"machineName": "GISSERVER.EXAMPLE.COM",
"adminURL": "https://GISSERVER.EXAMPLE.COM:6443/arcgis/admin"
}],
"owningSystemUrl": "https://GISSERVER.EXAMPLE.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.EXAMPLE.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": "MACHINE.EXAMPLE.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571091475452,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE.EXAMPLE.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.EXAMPLE.COM",
"role": "CLUSTER_MEMBER",
"dbport": 29081,
"initstarttime": 1571089621447,
"healthcheck.enable": "true",
"status": "Started",
"adminurl": "https://MACHINE2.EXAMPLE.COM:2443/arcgis/datastoreadmin",
"db.isactive": "true",
"db.isAccepting": "true",
"db.isSiteConnValid": "true"
}],
"unavailableMachines": ["MACHINE3.EXAMPLE.COM"],
"datastore.isRegistered": "true",
"datastore.hasValidServerConnection": "true",
"datastore.validServerMachinesList": [{
"machineName": "GISSERVER.EXAMPLE.COM",
"adminURL": "https://GISSERVER.EXAMPLE.COM:6443/arcgis/admin"
}],
"owningSystemUrl": "https://GISSERVER.EXAMPLE.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": "MACHINE.EXAMPLE.COM",
"heapSize": 17179869184
},
{
"name": "MACHINE2.EXAMPLE.COM",
"heapSize": 14004781056
}
{
"name": "MACHINE3.EXAMPLE.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": "MACHINE.EXAMPLE.COM",
"heapSize": 17179869184
},
{
"name": "MACHINE3.EXAMPLE.COM",
"heapSize": 14004781056
}
],
"unavailableNodes": ["MACHINE2.EXAMPLE.COM"]
}