Skip to main content

ArcGIS Data Store REST commands

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

If you are not the ArcGIS Server administrator for the hosting server, work with that person to complete the tasks described here.

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

  • Relational store—Click data > items > enterpriseDatabases > <data store name> > machines > <machine name>.

  • Spatiotemporal big data store—Click data > items > nosqlDatabases > AGSDataStore_bigdata_<data store name> > machines > <machine name>.

  • Graph store—Click data > items > nosqlDatabases > AGSDataStore_graph_<data store name> > machines > <machine name>.

  • Object store—Click data > items > cloudStores > <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 store machine to be the primary machine.

Stopping the primary 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.

Sign 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:

  • stop

  • start

  • makePrimary (standby machines in a relational store)

Validate the data store

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

Sign in to the ArcGIS Server Administrator Directory for the hosting server 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 as follows:

    • Healthy—All the components on all the member machines are reachable and working.

    • HealthyWithWarning—This state applies to relational stores, object stores, and graph stores only. One or more components are not available, but the data store is still usable. This value is returned for the relational store when the primary machine is healthy but the standby machine is not available. The relational store is not highly available at this point. For object stores or graph stores running in cluster mode, the data store may not be highly available.

    • 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 stores, possible values are Started or Stopped. When stopped, you cannot publish hosted feature layers or hosted 3D layers to your portal.

  • clusterStatus—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 may 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 that 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—For machines in a relational store, this indicates whether the machine is the primary or standby machine. For the object store and the graph store, the role will be primary for a single instance, and cluster_member when deployed in cluster mode.

  • messages—You will see warning and error messages related to the data store status here.

You can use validation for the following:

  • Confirm a data store machine has been stopped or started.

  • Confirm that the makePrimary command promoted the standby machine to the primary machine.

  • As an initial troubleshooting step if hosted layers cannot be published or accessed, or if you cannot create or access a knowledge graph.

Remove a standby machine

You can remove a standby machine from a relational store using the remove ArcGIS Server REST command. For example, if you want to use a different computer for the standby, you can 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.

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

Manage query response caches

Organization administrators and owners of feature layers and map image layers can enable query response caching on individual layers to help improve query performance. These query responses are cached in the object store. Depending on how long caches are stored (the cache expiration policy) and how much disk space is available on the machine or machines where the object store is running, the object store may fill up and stop functioning.

As the ArcGIS Data Store administrator, you must do the following if the ArcGIS Enterprise deployment uses an ArcGIS Data Store object store:

  • Configure the object store on machines that have ample disk space available to store these caches along with the other data stored in the object store.

  • Monitor the ArcGIS Data Store logs to detect when the object store is nearing capacity. You can validate the object store to determine what percentage of disk space is in use on the object store machines. If necessary, work with the ArcGIS Server administrator to change the cache expiration policy or to delete large layer caches by disabling response caching for those feature layers.

  • Periodically run the maintaindatastore utility to clear expired caches from the object store.

For information about query response caches, when to use them, and how to enable them, see Enable response caching.

For instructions to alter the expiration policy, see Update Definition in the ArcGIS REST API help.