Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateKxClusterDatabases

Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

Request Syntax


PUT /kx/environments/environmentId/clusters/clusterName/configuration/databases HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "databases": [ 
      { 
         "cacheConfigurations": [ 
            { 
               "cacheType": "string",
               "dataviewName": "string",
               "dbPaths": [ "string" ]
            }
         ],
         "changesetId": "string",
         "databaseName": "string",
         "dataviewConfiguration": { 
            "changesetId": "string",
            "dataviewName": "string",
            "dataviewVersionId": "string",
            "segmentConfigurations": [ 
               { 
                  "dbPaths": [ "string" ],
                  "onDemand": boolean,
                  "volumeName": "string"
               }
            ]
         },
         "dataviewName": "string"
      }
   ],
   "deploymentConfiguration": { 
      "deploymentStrategy": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

clusterName

A unique name for the cluster that you want to modify.

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$

Required: Yes

environmentId

The unique identifier of a kdb environment.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^[a-z0-9]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

databases

The structure of databases mounted on the cluster.

Type: Array of KxDatabaseConfiguration objects

Required: Yes

clientToken

A token that ensures idempotency. This token expires in 10 minutes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

deploymentConfiguration

The configuration that allows you to choose how you want to update the databases on a cluster.

Type: KxDeploymentConfiguration object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There was a conflict with this action, and it could not be completed.

HTTP Status Code: 409

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

LimitExceededException

A service limit or quota is exceeded.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400