Get Kx Cluster

finspace_get_kx_cluster

R Documentation

Retrieves information about a kdb cluster

Description

Retrieves information about a kdb cluster.

Usage

finspace_get_kx_cluster(environmentId, clusterName)

Arguments

environmentId

[required] A unique identifier for the kdb environment.

clusterName

[required] The name of the cluster that you want to retrieve.

Value

A list with the following syntax:

list(
  status = "PENDING"|"CREATING"|"CREATE_FAILED"|"RUNNING"|"UPDATING"|"DELETING"|"DELETED"|"DELETE_FAILED",
  statusReason = "string",
  clusterName = "string",
  clusterType = "HDB"|"RDB"|"GATEWAY"|"GP"|"TICKERPLANT",
  tickerplantLogConfiguration = list(
    tickerplantLogVolumes = list(
      "string"
    )
  ),
  volumes = list(
    list(
      volumeName = "string",
      volumeType = "NAS_1"
    )
  ),
  databases = list(
    list(
      databaseName = "string",
      cacheConfigurations = list(
        list(
          cacheType = "string",
          dbPaths = list(
            "string"
          ),
          dataviewName = "string"
        )
      ),
      changesetId = "string",
      dataviewName = "string",
      dataviewConfiguration = list(
        dataviewName = "string",
        dataviewVersionId = "string",
        changesetId = "string",
        segmentConfigurations = list(
          list(
            dbPaths = list(
              "string"
            ),
            volumeName = "string",
            onDemand = TRUE|FALSE
          )
        )
      )
    )
  ),
  cacheStorageConfigurations = list(
    list(
      type = "string",
      size = 123
    )
  ),
  autoScalingConfiguration = list(
    minNodeCount = 123,
    maxNodeCount = 123,
    autoScalingMetric = "CPU_UTILIZATION_PERCENTAGE",
    metricTarget = 123.0,
    scaleInCooldownSeconds = 123.0,
    scaleOutCooldownSeconds = 123.0
  ),
  clusterDescription = "string",
  capacityConfiguration = list(
    nodeType = "string",
    nodeCount = 123
  ),
  releaseLabel = "string",
  vpcConfiguration = list(
    vpcId = "string",
    securityGroupIds = list(
      "string"
    ),
    subnetIds = list(
      "string"
    ),
    ipAddressType = "IP_V4"
  ),
  initializationScript = "string",
  commandLineArguments = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  code = list(
    s3Bucket = "string",
    s3Key = "string",
    s3ObjectVersion = "string"
  ),
  executionRole = "string",
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  savedownStorageConfiguration = list(
    type = "SDS01",
    size = 123,
    volumeName = "string"
  ),
  azMode = "SINGLE"|"MULTI",
  availabilityZoneId = "string",
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  scalingGroupConfiguration = list(
    scalingGroupName = "string",
    memoryLimit = 123,
    memoryReservation = 123,
    nodeCount = 123,
    cpu = 123.0
  )
)

Request syntax

svc$get_kx_cluster(
  environmentId = "string",
  clusterName = "string"
)