finspace / Client / update_kx_volume

update_kx_volume#

finspace.Client.update_kx_volume(**kwargs)#

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

See also: AWS API Documentation

Request Syntax

response = client.update_kx_volume(
    environmentId='string',
    volumeName='string',
    description='string',
    clientToken='string',
    nas1Configuration={
        'type': 'SSD_1000'|'SSD_250'|'HDD_12',
        'size': 123
    }
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment where you created the storage volume.

  • volumeName (string) –

    [REQUIRED]

    A unique identifier for the volume.

  • description (string) – A description of the volume.

  • clientToken (string) –

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

  • 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.

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',
    'description': 'string',
    'statusReason': 'string',
    'createdTimestamp': datetime(2015, 1, 1),
    '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 where you want to update the volume.

    • volumeName (string) –

      A unique identifier for the volume that you want to update.

    • 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.

    • status (string) –

      The status of the volume.

      • 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.

    • description (string) –

      The description for the volume.

    • 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.

    • azMode (string) –

      The number of availability zones you want to assign per cluster. Currently, FinSpace only support SINGLE for volumes.

    • 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) –

      Specifies the clusters 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

  • finspace.Client.exceptions.InternalServerException

  • finspace.Client.exceptions.ThrottlingException

  • finspace.Client.exceptions.AccessDeniedException

  • finspace.Client.exceptions.LimitExceededException

  • finspace.Client.exceptions.ValidationException

  • finspace.Client.exceptions.ConflictException

  • finspace.Client.exceptions.ResourceNotFoundException