Skip To Content

ArcGIS Data Store REST commands

When you configure ArcGIS Data Store, you associate it with the GIS Server site that serves as your portal's hosting server. Actions that change or check the status of the data store are performed from the ArcGIS Server Administrator Directory. (The URL format is https://gisserver.domain.com:6443/arcgis/admin.) You can also remove a standby machine from a relational data store and the GIS Server site in the ArcGIS Server Administrator Directory. The following sections summarize these operations and link to the ArcGIS API documentation.

The following are the paths in the ArcGIS Server Administrator Directory that you need to follow to access operations for each type of data store:

  • Relational data store: data > items > enterpriseDatabases > <data store name> > machines > <machine name>
  • Spatiotemporal big data store: data > items > nosqlDatabases > AGSDataStore_bigdata_<data store name> > machines > <machine name>
  • Tile cache data store: data > items > nosqlDatabases > AGSDataStore_nosql_<data store name> > machines > <machine name>

Change the status of a data store machine

You can stop and restart individual machines in a data store. You can also promote a standby relational data store machine to be the primary.

Stopping the primary relational data store machine does not cause the data store to fail over in an on-premises deployment, as you may not want to fail over if you are performing a maintenance task, such as temporarily taking the data store offline.

For example, you change data store machine status as part of the following upgrade scenario:

  • Stop the standby machine.
  • Upgrade the standby.
  • Start the standby.
  • Promote the standby to primary using the makePrimary command.
  • Stop the former primary machine.
  • Upgrade the former primary.
  • Start the former primary.
  • Add the former primary machine back to the data store as the standby machine.

Log in to the ArcGIS Server Administrator Directory for the hosting server as the ArcGIS Server site administrator and go to a specific machine to use any of the following commands to change the status of a data store machine:

Validate the data store

You can check the status of the machines in a data store using the validate ArcGIS Server REST command.

Log in to the ArcGIS Server Administrator Directory as the ArcGIS Server site administrator, go to one of the machines in the specific data store type you want to check, and click validate to see information related to that data store. Important information related to a data store's status includes the following:

  • overallhealth—Values are either Healthy or Unhealthy. A data store is considered unhealthy if more than half the machines in it are inaccessible ("datastore.overallhealth": "Unhealthy"). A machine is considered unhealthy if it is inaccessible ("machine.overallhealth": "Unhealthy").
  • status—For relational or tile cache data stores, possible values are Started or Stopped. When stopped, you cannot publish hosted feature layers or hosted scene layers to your portal.

    For spatiotemporal big data stores, statuses are as follows:

    • green—All data is available
    • yellow—The data is available, but some or all replica copies of the data are not available and your spatiotemporal big data store is not currently highly available. You will always see this status if you configured a single-machine spatiotemporal big data store. You could also see this status if machines are rebalancing data, or one or more of the machines in your spatiotemporal big data store are inaccessible. If you have a multimachine spatiotemporal big data store and see a yellow status, confirm all machines are still available by validating each machine. If they are available, wait several hours and check again. If the status is still yellow, examine the ArcGIS Server logs for errors.
    • red—Some or all of the data is inaccessible. Examine the logs and correct errors.

  • role—This applies to machines in a relational data stores only and indicates whether the machine is the primary or standby machine.
  • messages—You will see warning and error messages related to the data store status here. For example, if you validate a multimachine tile cache data store, you will receive a message if scene cache data is not currently highly available (in other words, there is only one copy of one or more of the scene caches).

You might validate the data store to confirm a machine has been stopped or started, to confirm the standby was made primary after you used the makePrimary command, to identify if your tile cache data store is in a highly available state, or as an initial troubleshooting step if hosted feature or scene layers cannot be published or accessed or you cannot run GeoAnalytics Tools.

Remove a standby machine

You can remove a standby machine from a relational data store using the remove ArcGIS Server REST command. For example, if you want to use a different computer for the standby, you could remove the old standby machine from the data store, install ArcGIS Data Store on the new machine, and configure the new machine as the standby.

Log in to the ArcGIS Server Administrator Directory for the hosting server as the ArcGIS Server site administrator to use the remove command.