finspace / Client / list_kx_clusters

list_kx_clusters#

finspace.Client.list_kx_clusters(**kwargs)#

Returns a list of clusters.

Request Syntax

response = client.list_kx_clusters(
    environmentId='string',
    clusterType='HDB'|'RDB'|'GATEWAY',
    maxResults=123,
    nextToken='string'
)

Parameters:

environmentId (string) –
[REQUIRED]

A unique identifier for the kdb environment.
clusterType (string) –
Specifies the type of KDB database that is being created. The following types are available:
- HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
- RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
- GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
maxResults (integer) – The maximum number of results to return in this request.
nextToken (string) – A token that indicates where a results page should begin.

Return type:

dict

Returns:

Response Syntax

{
    'kxClusterSummaries': [
        {
            'status': 'PENDING'|'CREATING'|'CREATE_FAILED'|'RUNNING'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
            'statusReason': 'string',
            'clusterName': 'string',
            'clusterType': 'HDB'|'RDB'|'GATEWAY',
            'clusterDescription': 'string',
            'releaseLabel': 'string',
            'initializationScript': 'string',
            'executionRole': 'string',
            'azMode': 'SINGLE'|'MULTI',
            'availabilityZoneId': 'string',
            'lastModifiedTimestamp': datetime(2015, 1, 1),
            'createdTimestamp': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- kxClusterSummaries (list) –
  
  Lists the cluster details.
  - (dict) –
    
    The details of a kdb cluster.
    - status (string) –
      
      The status of a 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.
    - statusReason (string) –
      
      The error message when a failed state occurs.
    - clusterName (string) –
      
      A unique name for the cluster.
    - clusterType (string) –
      
      Specifies the type of KDB database that is being created. The following types are available:
      - HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
      - RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the savedownStorageConfiguration parameter.
      - GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
    - clusterDescription (string) –
      
      A description of the cluster.
    - releaseLabel (string) –
      
      A version of the FinSpace managed kdb to run.
    - initializationScript (string) –
      
      Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example, somedir/init.q.
    - executionRole (string) –
      
      An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
    - azMode (string) –
      
      The number of availability zones assigned per cluster. This can be one of the following:
      - SINGLE – Assigns one availability zone per cluster.
      - MULTI – Assigns all the availability zones per cluster.
    - availabilityZoneId (string) –
      
      The availability zone identifiers for the requested regions.
    - lastModifiedTimestamp (datetime) –
      
      The last time that the cluster was modified. 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.
    - createdTimestamp (datetime) –
      
      The timestamp at which the cluster 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.
- nextToken (string) –
  
  A token that indicates where a results page should begin.

Exceptions

finspace.Client.exceptions.InternalServerException
finspace.Client.exceptions.ValidationException
finspace.Client.exceptions.ThrottlingException
finspace.Client.exceptions.AccessDeniedException
finspace.Client.exceptions.LimitExceededException
finspace.Client.exceptions.ConflictException
finspace.Client.exceptions.ResourceNotFoundException