Skip to content

List Kx Clusters

finspace_list_kx_clusters R Documentation

Returns a list of clusters

Description

Returns a list of clusters.

Usage

finspace_list_kx_clusters(environmentId, clusterType, maxResults,
  nextToken)

Arguments

environmentId

[required] A unique identifier for the kdb environment.
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.
maxResults

The maximum number of results to return in this request.
nextToken

A token that indicates where a results page should begin.

Value

A list with the following syntax:

list(
  kxClusterSummaries = list(
    list(
      status = "PENDING"|"CREATING"|"CREATE_FAILED"|"RUNNING"|"UPDATING"|"DELETING"|"DELETED"|"DELETE_FAILED",
      statusReason = "string",
      clusterName = "string",
      clusterType = "HDB"|"RDB"|"GATEWAY"|"GP"|"TICKERPLANT",
      clusterDescription = "string",
      releaseLabel = "string",
      volumes = list(
        list(
          volumeName = "string",
          volumeType = "NAS_1"
        )
      ),
      initializationScript = "string",
      executionRole = "string",
      azMode = "SINGLE"|"MULTI",
      availabilityZoneId = "string",
      lastModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      createdTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_kx_clusters(
  environmentId = "string",
  clusterType = "HDB"|"RDB"|"GATEWAY"|"GP"|"TICKERPLANT",
  maxResults = 123,
  nextToken = "string"
)