Edit (Data Store Configuration) | ArcGIS REST APIs

URL:: https://<root>/data/<datastoreID>/config/edit
Methods:: POST
Version Introduced:: 10.9.1

Access requirements

Required privileges

The Enterprise 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.

Publisher role

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The edit operation updates the resource allocation (cpuMin, cpuMax, memoryMin, and memoryMax) for a data store. Once complete, the updates will be reflected on the config resource page. This operation supports editing the relational data store. Starting at ArcGIS Enterprise on Kubernetes 12.0, this operation also supports editing the spatiotemporal, index, and object data stores.

Request parameters

Parameter Details

Parameter	Details
`config`	A JSON object containing the currently configured resource allocation for the data store. For more information about the values that can be modified for each data store type, see the Data store configuration properties section below. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 // Relational data store config={ "deployment": { "numOfStandby": 1, "resources": { "cpuMin": "1", "cpuMax": "5", "memMax": "8Gi", "memMin": "2Gi" } } }`
`async`	This parameter specifies whether the operation will run synchronously or asynchronously. If `false`, the operation is run synchronously. If `true`, the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is `false`. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

config

A JSON object containing the currently configured resource allocation for the data store. For more information about the values that can be modified for each data store type, see the Data store configuration properties section below.

Example
Use dark colors for code blocksCopy
// Relational data store
config={
  "deployment": {
    "numOfStandby": 1,
    "resources": {
      "cpuMin": "1",
      "cpuMax": "5",
      "memMax": "8Gi",
      "memMin": "2Gi"
    }
  }
}

async

This parameter specifies whether the operation will run synchronously or asynchronously. If false, the operation is run synchronously. If true, the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is false.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

Data store configuration properties

Starting at 12.0, this operation can edit configurations for data stores other than the relational data store. The properties of the config parameter depend on the kind of data store they apply to and are described below:

The properties that can be updated for the relational data store configuration are cpuMin, cpuMax, memMax, and memMin.

Example
Use dark colors for code blocksCopy
config={
  "deployment": {
    "numOfStandby": 1,
    "resources": {
      "cpuMin": "1",
      "cpuMax": "5",
      "memMax": "8Gi",
      "memMin": "2Gi"
    }
  }
}

The properties that can be updated for the spatiotemporal and index data store configurations are cpuMin, cpuMax, memMax, memMin, and numOfCoordinatorNodes.

Example
Use dark colors for code blocksCopy
config={
  "deployment": {
    "coordinatorNodeResources": {
      "mainContainer": {
        "cpuMin": "0.5",
        "cpuMax": "4",
        "memMax": "8Gi",
        "memMin": "8Gi"
      },
      "fluentbit": {
        "cpuMin": "0.05",
        "cpuMax": "0.25",
        "memMax": "150Mi",
        "memMin": "32Mi"
      }
    },
    "numOfCoordinatorNodes": 3
  }
}

The properties that can be updated for the object data store configuration are cpuMin, cpuMax, memMax, memMin, and numOfCoordinatorNodes.

Example
Use dark colors for code blocksCopy
config={
  "deployment": {
    "coordinatorNodeResources": {
      "mainContainer": {
        "cpuMin": "0.5",
        "cpuMax": "4",
        "memMax": "8Gi",
        "memMin": "8Gi"
      },
      "fluentbit": {
        "cpuMin": "0.05",
        "cpuMax": "0.25",
        "memMax": "150Mi",
        "memMin": "32Mi"
      }
    },
    "numOfCoordinatorNodes": 4
  }
}

Example usage

The following is a sample POST request for the edit operation, formatted for readability:

Use dark colors for code blocksCopy
POST /<context>/admin/admin/data/b15a6a4d41324cf9a1f0375ab46a4da3/config/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

config={
  "deployment": {
    "numOfStandby": 1,
    "resources": {
      "cpuMin": "1",
      "cpuMax": "5",
      "memMax": "8Gi",
      "memMin": "2Gi"
    }
  }
}&async=false&f=pjson&token=B4SGXu8PifZbfOJxpbr-i3X66FvpOuDtp4UdaBqmodRHAxxI-El280UH26TsC9YBct-6TJ_6wYH8iJB39SCwJIB6Vl8_DXmhvROZxjWMk_boLq6J-hurAvVdsOwYLlE7uy7j5t7lpQBAOqvnXS1lxGCy1vwnr3OPLoKmOWY8S8dxP1ZNrRx_SlTSfshlnMP7yoYIArLIylO0Gga9gcyDa3DYsDeTKU8uKbkUQ6LEwo93g1cU9zAxFnxhlBdHw-9U

JSON Response example

If async is false, the following response is returned:

Use dark colors for code blocksCopy
{"status": "success"}

If async is true, the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it's been submitted. For more information, see the Job resource topic.

Use dark colors for code blocksCopy
{
  "jobsUrl": "https://organization.example.com/<context>/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"
}