Datastore

• URL:https://<root>/data/<datastoreID>
  
• Operations:Switch Role, Reset Standby
• Child Resources:Status, Config
• Required Capability:Default administrator role | Publisher role
• Version Introduced:10.9

Description

The datastore resource lists the properties of both system- and user-managed data stores registered with an ArcGIS Enterprise on Kubernetes deployment.

Request parameters

Parameter	Details
f	The response format. The default response format is html. Values: html | json | pjson

Example usage

The following is a sample request URL used to access the datastore resource:

https://organization.domain.com/context/admin/data/2eca8ba5-ad4e-4798-bbe5-ea27db7e04e84?f=pjson

JSON Response example

The following is a sample JSON response returned for a system-managed data store:

{
  "systemManaged": true,
  "description": "Relational store provides storage for hosted feature data and administrative aspects such as customization and configuration settings. Two relational stores are required for deployment.",
  "encryptAttributes": [
    "info.JDBCConnection.username",
    "info.JDBCConnection.password"
  ],
  "type": "egdb",
  "encryptedAttributes": [],
  "revision": "3",
  "path": "/enterpriseDatabases/b15a6a4d41324cf9a1f0375ab46a4da3",
  "provider": "ArcGIS Data Store",
  "purposes": [
    "configure",
    "feature"
  ],
  "meta": {
    "created": 1636413981,
    "modified": 1636417552
  },
  "name": "relational-store-fjzdg",
  "id": "b15a6a4d41324cf9a1f0375ab46a4da3",
  "info": {
    "isManagedData": true,
    "connectionString": "ENCRYPTED_PASSWORD=...;SERVER=relational-store-fjzdg-primary,relational-store-fjzdg-standby;INSTANCE=sde:postgresql:relational-store-fjzdg-primary,7654;DBCLIENT=postgresql;DB_CONNECTION_PROPERTIES=relational-store-fjzdg-primary,7654;DATABASE=hgdb_fjzdg;USER=mu_b438q;VERSION=sde.DEFAULT;AUTHENTICATION_MODE=DBMS",
    "factory": "egdb",
    "dataStoreConnectionType": "serverOnly",
    "implementation": "PostgreSQL",
    "systemManaged": true,
    "dbType": "managedPostgres",
    "datastoreName": "fjzdg",
    "clusterID": "fjzdg",
    "isManaged": true,
    "provider": "ArcGIS Data Store",
    "purposes": [
      "configure",
      "feature"
    ],
    "dsFeature": "relational",
    "machines": [
      {
        "dbPort": 7654,
        "role": "PRIMARY",
        "name": "relational-store-fjzdg-primary",
        "platform": "Linux"
      },
      {
        "dbPort": 7654,
        "role": "STANDBY",
        "name": "relational-store-fjzdg-standby",
        "platform": "Linux"
      }
    ],
    "category": "database",
    "JDBCConnection": {
      "factory": "org.apache.tomcat.jdbc.pool.DataSourceFactory",
      "minIdle": 0,
      "validationQuery": "SELECT 1",
      "initialSize": 0,
      "url": "jdbc:postgresql://relational-store-fjzdg-primary:7654/hgdb_fjzdg",
      "password": "{crypt}...",
      "testOnBorrow": true,
      "timeBetweenEvictionRunsMillis": 10000,
      "minEvictableIdleTimeMillis": 20000,
      "name": "PostgreSQLon-relational-store-fjzdg-primary",
      "driverClassName": "org.postgresql.Driver",
      "username": "{crypt}...",
      "initSQL": "SET TIME ZONE 'UTC'"
    },
    "connectionStringHA": "ENCRYPTED_PASSWORD=...;SERVER=fjzdg;INSTANCE=\"sde:postgresql:DSID=fjzdg\";DBCLIENT=postgresql;DATABASE=hgdb_fjzdg;USER=mu_b438q;VERSION=sde.DEFAULT;AUTHENTICATION_MODE=DBMS"
  }
}

The following is a sample JSON response returned for a user-managed data store:

{
  "path": "/fileShares/_net_qalinux",
  "provider": "UserManaged",
  "meta": {
    "created": 1618051320,
    "modified": 1618052850
  },
  "name": "fileShares-net-qalinux",
  "description": "Pre-registered Folder Path during Org creation",
  "encryptAttributes": [],
  "id": "26f568e816b64ee3b398701cef31f757",
  "type": "folder",
  "encryptedAttributes": [],
  "info": {
    "path": "/net/qalinux",
    "dataStoreConnectionType": "shared",
    "portalProperties": {"itemID": "26f568e816b64ee3b398701cef31f757"}
  },
  "revision": "2"
}