Interface Backend

interface Backend {
    createdAt?: Date;
    failoverHost?: string;
    forwardPort: number;
    forwardPortAlgorithm: ForwardPortAlgorithm;
    forwardProtocol: Protocol;
    healthCheck?: HealthCheck;
    id: string;
    ignoreSslServerVerify?: boolean;
    lb?: Lb;
    maxConnections?: number;
    maxRetries?: number;
    name: string;
    onMarkedDownAction: OnMarkedDownAction;
    pool: string[];
    proxyProtocol: ProxyProtocol;
    redispatchAttemptCount?: number;
    sendProxyV2?: boolean;
    sslBridging?: boolean;
    stickySessions: StickySessionsType;
    stickySessionsCookieName: string;
    timeoutConnect?: string;
    timeoutQueue?: string;
    timeoutServer?: string;
    timeoutTunnel?: string;
    updatedAt?: Date;
}

Properties

createdAt? failoverHost? forwardPort forwardPortAlgorithm forwardProtocol healthCheck? id ignoreSslServerVerify? lb? maxConnections? maxRetries? name onMarkedDownAction pool proxyProtocol redispatchAttemptCount? sendProxyV2? sslBridging? stickySessions stickySessionsCookieName timeoutConnect? timeoutQueue? timeoutServer? timeoutTunnel? updatedAt?

Properties

OptionalcreatedAt

createdAt?: Date

Date at which the backend was created.

OptionalfailoverHost

failoverHost?: string

Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.

forwardPort

forwardPort: number

Port used by the backend when forwarding traffic to backend servers.

forwardPortAlgorithm

forwardPortAlgorithm: ForwardPortAlgorithm

Load balancing algorithm to use when determining which backend server to forward new traffic to.

forwardProtocol

forwardProtocol: Protocol

Protocol used by the backend when forwarding traffic to backend servers.

OptionalhealthCheck

healthCheck?: HealthCheck

Object defining the health check to be carried out by the backend when checking the status and health of backend servers.

id

id: string

Backend ID.

OptionalignoreSslServerVerify

ignoreSslServerVerify?: boolean

Defines whether the server certificate verification should be ignored.

Optionallb

lb?: Lb

Load Balancer the backend is attached to.

OptionalmaxConnections

maxConnections?: number

Maximum number of connections allowed per backend server.

OptionalmaxRetries

maxRetries?: number

Number of retries when a backend server connection failed.

name

name: string

Name of the backend.

onMarkedDownAction

onMarkedDownAction: OnMarkedDownAction

Action to take when a backend server is marked as down.

pool

pool: string[]

List of IP addresses of backend servers attached to this backend.

proxyProtocol

proxyProtocol: ProxyProtocol

Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.

OptionalredispatchAttemptCount

redispatchAttemptCount?: number

Whether to use another backend server on each attempt.

OptionalsendProxyV2

sendProxyV2?: boolean

Deprecated

Deprecated in favor of proxy_protocol field.

OptionalsslBridging

sslBridging?: boolean

Defines whether to enable SSL bridging between the Load Balancer and backend servers.

stickySessions

stickySessions: StickySessionsType

Defines whether sticky sessions (binding a particular session to a particular backend server) are activated and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.

stickySessionsCookieName

stickySessionsCookieName: string

Cookie name for cookie-based sticky sessions.

OptionaltimeoutConnect

timeoutConnect?: string

Maximum allowed time for establishing a connection to a backend server.

OptionaltimeoutQueue

timeoutQueue?: string

Maximum time for a request to be left pending in queue when max_connections is reached.

OptionaltimeoutServer

timeoutServer?: string

Maximum allowed time for a backend server to process a request.

OptionaltimeoutTunnel

timeoutTunnel?: string

Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout).

OptionalupdatedAt

updatedAt?: Date

Date at which the backend was updated.

Settings

On This Page

Properties