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

    Type Alias GetNodeBalancerNodeResponses

    type GetNodeBalancerNodeResponses = {
        "200":
            | {
                address?: string;
                config_id?: number;
                id?: number;
                label?: string;
                mode?: "accept"
                | "reject"
                | "drain"
                | "backup";
                nodebalancer_id?: number;
                status?: "Unknown" | "UP" | "DOWN";
                vpc_config_id?: number | null;
                weight?: number;
            }
            | {
                address?: string;
                config_id?: number;
                id?: number;
                label?: string;
                mode?: "none";
                nodebalancer_id?: number;
                status?: "Unknown"
                | "UP"
                | "DOWN";
                vpc_config_id?: number | null;
                weight?: number;
            };
    }
    Index

    Properties

    200

    Properties

    "200":
        | {
            address?: string;
            config_id?: number;
            id?: number;
            label?: string;
            mode?: "accept"
            | "reject"
            | "drain"
            | "backup";
            nodebalancer_id?: number;
            status?: "Unknown" | "UP" | "DOWN";
            vpc_config_id?: number | null;
            weight?: number;
        }
        | {
            address?: string;
            config_id?: number;
            id?: number;
            label?: string;
            mode?: "none";
            nodebalancer_id?: number;
            status?: "Unknown"
            | "UP"
            | "DOWN";
            vpc_config_id?: number | null;
            weight?: number;
        }

    A NodeBalancer node represents a single backend serving requests for a single port on a NodeBalancer. Nodes are tied to NodeBalancer configurations, and serve traffic over their private IPv4 address, IPv6 address, or VPC IPv4 address. If the same Linode is serving traffic for more than one port on the same NodeBalancer, one NodeBalancer node is required for each config (port) it should serve requests on. For example, if you have four backends, and each should respond to both HTTP and HTTPS requests, you will need two NodeBalancer configs (port 80 and port 443) and four backends each, one for each of the Linodes serving requests for that port.

    Type Declaration

    • {
          address?: string;
          config_id?: number;
          id?: number;
          label?: string;
          mode?: "accept" | "reject" | "drain" | "backup";
          nodebalancer_id?: number;
          status?: "Unknown" | "UP" | "DOWN";
          vpc_config_id?: number | null;
          weight?: number;
      }
      • Optionaladdress?: string

        The address and port where this backend can be reached: either the Linode’s private IPv4, public IPv6, or the VPC's IPv4 address.

      • Optional Readonlyconfig_id?: number

        Read-only The NodeBalancer Config ID that this Node belongs to.

      • Optional Readonlyid?: number

        Read-only This node's unique ID.

      • Optionallabel?: string

        The label for this node. This is for display purposes only.

      • Optionalmode?: "accept" | "reject" | "drain" | "backup"

        The mode this NodeBalancer should use when sending traffic to this backend.

        • If set to accept this backend is accepting traffic.
        • If set to reject this backend will not receive traffic.
        • If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it.
        • If set to backup, this backend will only receive traffic if all accept nodes are down.
      • Optional Readonlynodebalancer_id?: number

        Read-only The NodeBalancer ID that this Node belongs to.

      • Optionalstatus?: "Unknown" | "UP" | "DOWN"

        Read-only The current status of this node, based on the configured checks of its NodeBalancer Config.

      • Optional Readonlyvpc_config_id?: number | null

        Read-only For VPC backends, you can use the vpc_config_id to get VPC IDs and VPC subnet IDs. Returns a null value if the backend is not a VPC node. Included only in {apiVersion} v4beta.

      • Optionalweight?: number

        Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.

    • {
          address?: string;
          config_id?: number;
          id?: number;
          label?: string;
          mode?: "none";
          nodebalancer_id?: number;
          status?: "Unknown" | "UP" | "DOWN";
          vpc_config_id?: number | null;
          weight?: number;
      }
      • Optionaladdress?: string

        The address and port where this backend can be reached: either the Linode’s private IPv4, public IPv6, or the VPC's IPv4 address.

      • Optional Readonlyconfig_id?: number

        Read-only The NodeBalancer Config ID that this Node belongs to.

      • Optional Readonlyid?: number

        Read-only This node's unique ID.

      • Optionallabel?: string

        The label for this node. This is for display purposes only.

      • Optionalmode?: "none"

        Read-only The mode this NodeBalancer should use when sending traffic to this backend. For backend nodes with a UDP config, the mode doesn't apply, so the value is none.

      • Optional Readonlynodebalancer_id?: number

        Read-only The NodeBalancer ID that this Node belongs to.

      • Optionalstatus?: "Unknown" | "UP" | "DOWN"

        Read-only The current status of this node, based on the configured checks of its NodeBalancer config.

      • Optional Readonlyvpc_config_id?: number | null

        Read-only For VPC backends, the vpc_config_id can be used to get VPC IDs and VPC subnet IDs. Returns a null value if the backend is not a VPC node. Included only when the apiVersion is v4beta.

      • Optionalweight?: number

        Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic.

    Settings

    Member Visibility

    On This Page

    Properties