finspace / Client / get_kx_volume

get_kx_volume

finspace.Client.get_kx_volume(**kwargs)

Retrieves the information about the volume.

See also: AWS API Documentation

Request Syntax

response = client.get_kx_volume(
    environmentId='string',
    volumeName='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

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

  • volumeName (string) –

    [REQUIRED]

    A unique identifier for the volume.

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string',
    'volumeName': 'string',
    'volumeType': 'NAS_1',
    'volumeArn': 'string',
    'nas1Configuration': {
        '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': datetime(2015, 1, 1),
    'description': 'string',
    'azMode': 'SINGLE'|'MULTI',
    'availabilityZoneIds': [
        'string',
    ],
    'lastModifiedTimestamp': datetime(2015, 1, 1),
    'attachedClusters': [
        {
            'clusterName': 'string',
            'clusterType': 'HDB'|'RDB'|'GATEWAY'|'GP'|'TICKERPLANT',
            'clusterStatus': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED'
        },
    ]
}

Response Structure

  • (dict) –

    • environmentId (string) –

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

    • volumeName (string) –

      A unique identifier for the volume.

    • volumeType (string) –

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

    • volumeArn (string) –

      The ARN identifier of the volume.

    • nas1Configuration (dict) –

      Specifies the configuration for the Network attached storage (NAS_1) file system volume.

      • type (string) –

        The type of the network attached storage.

      • size (integer) –

        The size of the network attached storage. For storage type SSD_1000 and SSD_250 you can select the minimum size as 1200 GB or increments of 2400 GB. For storage type HDD_12 you can select the minimum size as 6000 GB or increments of 6000 GB.

    • status (string) –

      The status of volume creation.

      • CREATING – The volume creation is in progress.

      • CREATE_FAILED – The volume creation has failed.

      • ACTIVE – The volume is active.

      • UPDATING – The volume is in the process of being updated.

      • UPDATE_FAILED – The update action failed.

      • UPDATED – The volume is successfully updated.

      • DELETING – The volume is in the process of being deleted.

      • DELETE_FAILED – The system failed to delete the volume.

      • DELETED – The volume is successfully deleted.

    • statusReason (string) –

      The error message when a failed state occurs.

    • createdTimestamp (datetime) –

      The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • description (string) –

      A description of the volume.

    • azMode (string) –

      The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

    • availabilityZoneIds (list) –

      The identifier of the availability zones.

      • (string) –

    • lastModifiedTimestamp (datetime) –

      The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

    • attachedClusters (list) –

      A list of cluster identifiers that a volume is attached to.

      • (dict) –

        The structure containing the metadata of the attached clusters.

        • clusterName (string) –

          A unique name for the attached cluster.

        • clusterType (string) –

          Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

        • clusterStatus (string) –

          The status of the attached cluster.

          • PENDING – The cluster is pending creation.

          • CREATING – The cluster creation process is in progress.

          • CREATE_FAILED – The cluster creation process has failed.

          • RUNNING – The cluster creation process is running.

          • UPDATING – The cluster is in the process of being updated.

          • DELETING – The cluster is in the process of being deleted.

          • DELETED – The cluster has been deleted.

          • DELETE_FAILED – The cluster failed to delete.

Exceptions