Type Alias ListNodesRequest

ListNodesRequest: {
    clusterId: string;
    name?: string;
    orderBy?: ListNodesRequestOrderBy;
    page?: number;
    pageSize?: number;
    poolId?: string;
    region?: Region;
    status?: NodeStatus;
}

Type declaration

  • clusterId: string

    Cluster ID from which the nodes will be listed from.

  • Optionalname?: string

    Name to filter on, only nodes containing this substring in their name will be returned.

  • OptionalorderBy?: ListNodesRequestOrderBy

    Sort order of the returned nodes.

  • Optionalpage?: number

    Page number for the returned nodes.

  • OptionalpageSize?: number

    Maximum number of nodes per page.

  • OptionalpoolId?: string

    Pool ID on which to filter the returned nodes.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionalstatus?: NodeStatus

    Status to filter on, only nodes with this status will be returned.

Settings