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

ListKxClusters

Returns a list of clusters.

Request Syntax


GET /kx/environments/environmentId/clusters?clusterType=clusterType&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

clusterType

Specifies the type of KDB database that is being created. The following types are available:

HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only SINGLE AZ mode.
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.

Valid Values: HDB | RDB | GATEWAY | GP | TICKERPLANT

environmentId

A unique identifier for the kdb environment.

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

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

Required: Yes

maxResults

The maximum number of results to return in this request.

Valid Range: Minimum value of 0. Maximum value of 100.

nextToken

A token that indicates where a results page should begin.

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

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "kxClusterSummaries": [ 
      { 
         "availabilityZoneId": "string",
         "azMode": "string",
         "clusterDescription": "string",
         "clusterName": "string",
         "clusterType": "string",
         "createdTimestamp": number,
         "executionRole": "string",
         "initializationScript": "string",
         "lastModifiedTimestamp": number,
         "releaseLabel": "string",
         "status": "string",
         "statusReason": "string",
         "volumes": [ 
            { 
               "volumeName": "string",
               "volumeType": "string"
            }
         ]
      }
   ],
   "nextToken": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

kxClusterSummaries

Lists the cluster details.

Type: Array of KxCluster objects

nextToken

A token that indicates where a results page should begin.

Type: String

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

Pattern: .*

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