@akamai/openapi-ts
    Preparing search index...

    Type Alias PutNodeBalancerData

    type PutNodeBalancerData = {
        body: {
            client_conn_throttle?: number;
            created?: string;
            hostname?: string;
            id?: number;
            ipv4?: string;
            ipv6?: string | null;
            label?: string;
            lke_cluster?:
                | { id?: string; label?: string; type?: string; url?: string }
                | null;
            region?: string;
            tags?: string[];
            transfer?: {
                in?: number | null;
                out?: number | null;
                total?: number | null;
            };
            type?: "common"
            | "premium";
            updated?: string;
        };
        path: { nodeBalancerId: number };
        query?: never;
        url: "nodebalancers/{nodeBalancerId}";
    }
    Index

    Properties

    body path query? url

    Properties

    body

    body: {
        client_conn_throttle?: number;
        created?: string;
        hostname?: string;
        id?: number;
        ipv4?: string;
        ipv6?: string | null;
        label?: string;
        lke_cluster?:
            | { id?: string; label?: string; type?: string; url?: string }
            | null;
        region?: string;
        tags?: string[];
        transfer?: {
            in?: number | null;
            out?: number | null;
            total?: number | null;
        };
        type?: "common"
        | "premium";
        updated?: string;
    }

    NodeBalancer

    Linode's load balancing solution. Can handle multiple ports, SSL termination, and any number of backends. NodeBalancer ports are configured with NodeBalancer configs, and each config is given one or more NodeBalancer nodes that accepts traffic. The traffic should be routed to the NodeBalancer's IP address, for the NodeBalancer to handle routing individual requests to backends.

    Type Declaration

    • Optionalclient_conn_throttle?: number

      Throttle TCP connections per second for TCP, HTTP, and HTTPS configurations. Set to 0 (zero) to disable throttling.

    • Optional Readonlycreated?: string

      Read-only When this NodeBalancer was created.

    • Optional Readonlyhostname?: string

      Read-only This NodeBalancer's hostname, beginning with its IP address and ending with .ip.linodeusercontent.com.

    • Optional Readonlyid?: number

      Read-only This NodeBalancer's unique ID.

    • Optional Readonlyipv4?: string

      Filterable, Read-only This NodeBalancer's public IPv4 address.

    • Optional Readonlyipv6?: string | null

      Read-only This NodeBalancer's public IPv6 address.

    • Optionallabel?: string

      Filterable This NodeBalancer's label. These must be unique on your Account.

    • Optional Readonlylke_cluster?: { id?: string; label?: string; type?: string; url?: string } | null

      Read-only This NodeBalancer's related LKE cluster, if any. The value is null if this NodeBalancer isn't related to an LKE cluster.

    • Optional Readonlyregion?: string

      Filterable, Read-only The Region where this NodeBalancer is located. NodeBalancers only support backends in the same Region.

    • Optionaltags?: string[]

      Filterable An array of Tags applied to this object. Tags are for organizational purposes only.

    • Optional Readonlytransfer?: { in?: number | null; out?: number | null; total?: number | null }

      Read-only Information about the amount of transfer this NodeBalancer has had so far this month.

      • Optional Readonlyin?: number | null

        Read-only The total outbound transfer, in MB, used for this NodeBalancer this month.

      • Optional Readonlyout?: number | null

        Read-only The total inbound transfer, in MB, used for this NodeBalancer this month.

      • Optional Readonlytotal?: number | null

        Read-only The total transfer, in MB, used by this NodeBalancer this month.

    • Optionaltype?: "common" | "premium"

      Read-only The type of NodeBalancer.

    • Optional Readonlyupdated?: string

      Read-only When this NodeBalancer was last updated.

    path: { nodeBalancerId: number }

    Type Declaration

    • nodeBalancerId: number

      The ID of the NodeBalancer.

    query?: never
    url: "nodebalancers/{nodeBalancerId}"

    Settings

    Member Visibility

    On This Page

    Properties