Edit (Data Store Configuration)

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

Description

This operation updates the resource allocation (cpuMin , cpuMax , memoryMin , and memoryMax ) for only the relational data store. Once complete, the updates will be reflected on the config resource page.

Request parameters

Parameter Details

Parameter	Details
`config`	A JSON object containing the currently configured resource allocation for the relational data store. Currently, this operation only supports updating the values for `cpuMin` , `cpuMax` , `memMax` , and `memMin` . Note The value for `numOfStandby` must always be 1. As well, this property must be included in the JSON object. Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 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 relational data store. Currently, this operation only supports updating the values for cpuMin , cpuMax , memMax , and memMin .

Use dark colors for code blocksCopy
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

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.domain.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.domain.com/context/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"
}