FinSpace User Environment Management service

Deletes the specified nodes from a cluster.

See also: AWS API Documentation

Request Syntax

client.delete_kx_cluster_node(
    environmentId='string',
    clusterName='string',
    nodeId='string'
)

type environmentId

string

param environmentId

[REQUIRED]

A unique identifier for the kdb environment.

type clusterName

string

param clusterName

[REQUIRED]

The name of the cluster, for which you want to delete the nodes.

type nodeId

string

param nodeId

[REQUIRED]

A unique identifier for the node that you want to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

{'nodes': {'status': 'RUNNING | PROVISIONING'}}

Lists all the nodes in a kdb cluster.

See also: AWS API Documentation

Request Syntax

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

type environmentId

string

param environmentId

[REQUIRED]

A unique identifier for the kdb environment.

type clusterName

string

param clusterName

[REQUIRED]

A unique name for the cluster.

type nextToken

string

param nextToken

A token that indicates where a results page should begin.

type maxResults

integer

param maxResults

The maximum number of results to return in this request.

rtype

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.