Get Kx Volume

finspace_get_kx_volume

R Documentation

Retrieves the information about the volume

Description

Retrieves the information about the volume.

Usage

finspace_get_kx_volume(environmentId, volumeName)

Arguments

environmentId

[required] A unique identifier for the kdb environment, whose clusters can attach to the volume.

volumeName

[required] A unique identifier for the volume.

Value

A list with the following syntax:

list(
  environmentId = "string",
  volumeName = "string",
  volumeType = "NAS_1",
  volumeArn = "string",
  nas1Configuration = list(
    type = "SSD_1000"|"SSD_250"|"HDD_12",
    size = 123
  ),
  status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATED"|"UPDATE_FAILED"|"DELETING"|"DELETED"|"DELETE_FAILED",
  statusReason = "string",
  createdTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  description = "string",
  azMode = "SINGLE"|"MULTI",
  availabilityZoneIds = list(
    "string"
  ),
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  attachedClusters = list(
    list(
      clusterName = "string",
      clusterType = "HDB"|"RDB"|"GATEWAY"|"GP"|"TICKERPLANT",
      clusterStatus = "PENDING"|"CREATING"|"CREATE_FAILED"|"RUNNING"|"UPDATING"|"DELETING"|"DELETED"|"DELETE_FAILED"
    )
  )
)

Request syntax

svc$get_kx_volume(
  environmentId = "string",
  volumeName = "string"
)