List Kx Volumes

finspace_list_kx_volumes

R Documentation

Lists all the volumes in a kdb environment

Description

Lists all the volumes in a kdb environment.

Usage

finspace_list_kx_volumes(environmentId, maxResults, nextToken,
  volumeType)

Arguments

environmentId

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

maxResults

The maximum number of results to return in this request.

nextToken

A token that indicates where a results page should begin.

volumeType

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

Value

A list with the following syntax:

list(
  kxVolumeSummaries = list(
    list(
      volumeName = "string",
      volumeType = "NAS_1",
      status = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATED"|"UPDATE_FAILED"|"DELETING"|"DELETED"|"DELETE_FAILED",
      description = "string",
      statusReason = "string",
      azMode = "SINGLE"|"MULTI",
      availabilityZoneIds = list(
        "string"
      ),
      createdTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      lastModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_kx_volumes(
  environmentId = "string",
  maxResults = 123,
  nextToken = "string",
  volumeType = "NAS_1"
)