finspace / Client / list_kx_cluster_nodes

list_kx_cluster_nodes#

finspace.Client.list_kx_cluster_nodes(**kwargs)#

Lists all the nodes in a kdb cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_kx_cluster_nodes(
    environmentId='string',
    clusterName='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    A unique identifier for the kdb environment.

  • clusterName (string) –

    [REQUIRED]

    A unique name for the cluster.

  • nextToken (string) – A token that indicates where a results page should begin.

  • maxResults (integer) – The maximum number of results to return in this request.

Return type:

dict

Returns:

Response Syntax

{
    'nodes': [
        {
            'nodeId': 'string',
            'availabilityZoneId': 'string',
            'launchTime': datetime(2015, 1, 1),
            'status': 'RUNNING'|'PROVISIONING'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • nodes (list) –

      A list of nodes associated with the cluster.

      • (dict) –

        A structure that stores metadata for a kdb node.

        • nodeId (string) –

          A unique identifier for the node.

        • availabilityZoneId (string) –

          The identifier of the availability zones where subnets for the environment are created.

        • launchTime (datetime) –

          The time when a particular node is started. 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.

        • status (string) –

          Specifies the status of the cluster nodes.

          • RUNNING – The node is actively serving.

          • PROVISIONING – The node is being prepared.

    • nextToken (string) –

      A token that indicates where a results page should begin.

Exceptions