Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Google Cloud Load Balancing

Connection Parameters

Name
Required?
Description

Private Key JSON

Required

The contents of the private key JSON file created when setting up a service account.

Metric Collection

Controls which metrics get requested from GCP's Stackdriver API.

Projects

Required

A comma separated whitelist of project IDs. If the wildcard "*" is used, resources will be collected from all available projects.

Regional Collection

Determines if regional Forwarding Rules & Backend Services will be collected (in addition to global ones).

Regions

Required

A comma separated whitelist of regions. At least one region must be specified.

Connection Timeout

The number of seconds to allow for connecting to the target.

Metrics

Backend Bucket

Name
Description

Backend Latency (Milliseconds)

A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.

Backend Request Count (Requests per Second)

The number of requests served by backends of HTTP/S load balancer.

Backend Request Data (Bytes per Second)

The amount of data sent as requests from HTTP/S load balancer to backends.

Backend Response Data (Bytes per Second)

The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.

Bucket Name

Cloud Storage bucket name.

CDN Policy Signed URL Cache Maximum Age (Seconds)

Maximum time the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

CDN Policy Signed URL Key Names

Names of the keys for signing request URLs.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional textual description of the resource; provided by the client when the resource is created.

Enable CDN

If true, enable Cloud CDN for this BackendBucket.

Frontend Request Count (Requests per Second)

The number of requests served by HTTP/S load balancer.

Frontend Request Data (Bytes per Second)

The amount of data sent as requests from clients to HTTP/S load balancer.

Frontend Response Data (Bytes per Second)

The amount of data sent as responses from HTTP/S load balancer to clients.

Frontend RTT (Milliseconds)

A distribution of the RTT measured for each connection between client and proxy.

ID

The unique identifier for the resource. This identifier is defined by the server.

Name

The name of the backend target.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

Self Link

Server-defined URL for the resource.

Total Latency (Milliseconds)

A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Backend Service

Name
Description

Affinity Cookie TTL (Seconds)

Lifetime of cookies if sessionAffinity is GENERATED_COOKIE. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value for TTL is one day. When the load balancing scheme is INTERNAL, this field is not used.

Backend Latency (Milliseconds)

A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.

Backend Request Count (Requests per Second)

The number of requests served by backends of HTTP/S load balancer.

Backend Request Data (Bytes per Second)

The amount of data sent as requests from HTTP/S load balancer to backends.

Backend Response Data (Bytes per Second)

The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.

CDN Policy Cache Key Policy Include Host

If true, requests to different hosts will be cached separately.

CDN Policy Cache Key Policy Include Protocol

If true, http and https requests will be cached separately.

CDN Policy Cache Key Policy Include Query String

If true, include query string parameters in the cache key according to queryStringWhitelist and queryStringBlacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

CDN Policy Cache Key Policy Query String Blacklist

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

CDN Policy Cache Key Policy Query String Whitelist

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify queryStringWhitelist or queryStringBlacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.

CDN Policy Signed URL Cache Maximum Age (Seconds)

Maximum time the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

CDN Policy Signed URL Key Names

Names of the keys for signing request URLs.

Closed Connections (Connections)

Number of connections that were terminated over TCP/SSL proxy.

Connection Draining Draining Timeout (Seconds)

Time for which instance will be drained (not accept new connections, but still work to finish started).

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Egress Data (Bytes per Second)

Amount of data sent from VM to client using proxy.

Enable CDN

If true, enable Cloud CDN for this BackendService. When the load balancing scheme is INTERNAL, this field is not used.

Fingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

Frontend Request Count (Requests per Second)

The number of requests served by HTTP/S load balancer.

Frontend Request Data (Bytes per Second)

The amount of data sent as requests from clients to HTTP/S load balancer.

Frontend Response Data (Bytes per Second)

The amount of data sent as responses from HTTP/S load balancer to clients.

Frontend RTT (Milliseconds)

A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.

Health Checks

The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead.

HTTPS Frontend RTT (Milliseconds)

A distribution of the RTT measured for each connection between client and proxy.

IAP Enabled

Whether IAP is enabled.

IAP OAuth2 Client ID

The IAP OAuth2 Client ID.

IAP OAuth2 Client Secret

The IAP OAuth2 Client Secret.

IAP OAuth2 Client Secret SHA256

SHA256 hash value for the field oauth2ClientSecret above.

ID

The unique identifier for the resource. This identifier is defined by the server.

Ingress Data (Bytes per Second)

Amount of data sent from client to VM using proxy.

Internal Egress Data (Bytes per Second)

The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).

Internal Egress Packets (Packets per Second)

The number of packets sent from ILB backend to client of the flow.

Internal Ingress Data (Bytes per Second)

The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).

Internal Ingress Packets (Packets per Second)

The number of packets sent from client to ILB backend.

Internal RTT Latencies (Milliseconds)

A distribution of RTT measured over TCP connections for ILB flows.

Load Balancing Scheme

Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other. Possible values are INTERNAL and EXTERNAL.

Name

The name of the backend target.

New Connections Opened (Connections)

Number of connections that were created over TCP/SSL proxy.

Open Connections (Connections)

Current number of outstanding connections through the TCP/SSL proxy.

Port Name

Name of backend port. The same name should appear in the instance groups referenced by this service. Required when the load balancing scheme is EXTERNAL. When the load balancing scheme is INTERNAL, this field is not used.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

Protocol

The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP. For internal load balancing, the possible values are TCP and UDP, and the default is TCP.

Region

The region of the backend.

Self Link

Server-defined URL for the resource.

Session Affinity

Type of session affinity to use. The default is NONE. When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or GENERATED_COOKIE. When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. When the protocol is UDP, this field is not used.

Timeout (Seconds)

How much time to wait for the backend before considering it a failed request.

Total Latency (Milliseconds)

A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Backend Service Backend

Name
Description

Backend Target Name

The name of the backend target.

Balancing Mode

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). For Internal Load Balancing, the default and only supported mode is CONNECTION.

Capacity Scaler (%)

A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). This cannot be used for internal load balancing.

Closed Connections (Connections)

Number of connections that were terminated over TCP/SSL proxy.

Description

An optional description of this resource. Provide this property when you create the resource.

Egress Data (Bytes per Second)

Amount of data sent from VM to client using proxy.

Frontend Request Count (Requests per Second)

The number of requests served by HTTP/S load balancer.

Frontend Request Data (Bytes per Second)

The amount of data sent as requests from clients to HTTP/S load balancer.

Frontend Response Data (Bytes per Second)

The amount of data sent as responses from HTTP/S load balancer to clients.

Frontend RTT (Milliseconds)

A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.

HTTPS Frontend RTT (Milliseconds)

A distribution of the RTT measured for each connection between client and proxy.

ID

The unique identifier for the resource. This identifier is defined by the server.

Ingress Data (Bytes per Second)

Amount of data sent from client to VM using proxy.

Internal Egress Data (Bytes per Second)

The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).

Internal Egress Packets (Packets per Second)

The number of packets sent from ILB backend to client of the flow.

Internal Ingress Data (Bytes per Second)

The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).

Internal Ingress Packets (Packets per Second)

The number of packets sent from client to ILB backend.

Internal RTT Latencies (Milliseconds)

A distribution of RTT measured over TCP connections for ILB flows.

Latency (Milliseconds)

A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.

Maximum Connections (Connections)

The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.

Maximum Connections Per Instance (Connections)

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.

Maximum Rate (Requests per Second)

The max request rate of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.

Maximum Rate Per Instance (Requests per Second)

The max request rate that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.

Maximum Utilization (%)

This defines the CPU utilization target for the group. Used when balancingMode is UTILIZATION. This cannot be used for internal load balancing.

Name

The name of the backend group that handled the connection.

New Connections Opened (Connections)

Number of connections that were created over TCP/SSL proxy.

Open Connections (Connections)

Current number of outstanding connections through the TCP/SSL proxy.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

Region

The region of the backend.

Request Count (Requests per Second)

The number of requests served by backends of HTTP/S load balancer.

Request Data (Bytes per Second)

The amount of data sent as requests from HTTP/S load balancer to backends.

Response Data (Bytes per Second)

The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.

Total Latency (Milliseconds)

A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Forwarding Rule

Name
Description

Backend Latency (Milliseconds)

A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.

Backend Request Count (Requests per Second)

The number of requests served by backends of HTTP/S load balancer.

Backend Request Data (Bytes per Second)

The amount of data sent as requests from HTTP/S load balancer to backends.

Backend Response Data (Bytes per Second)

The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.

Backend Service

This field is only used for INTERNAL load balancing. For internal load balancing, this field identifies the BackendService resource to receive the matched traffic.

Closed Connections (Connections)

Number of connections that were terminated over TCP/SSL proxy.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Egress Data (Bytes per Second)

Amount of data sent from VM to client using proxy.

Frontend Request Count (Requests per Second)

The number of requests served by HTTP/S load balancer.

Frontend Request Data (Bytes per Second)

The amount of data sent as requests from clients to HTTP/S load balancer.

Frontend Response Data (Bytes per Second)

The amount of data sent as responses from HTTP/S load balancer to clients.

Frontend RTT (Milliseconds)

A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.

HTTPS Frontend RTT (Milliseconds)

A distribution of the RTT measured for each connection between client and proxy.

ID

The unique identifier for the resource. This identifier is defined by the server.

Ingress Data (Bytes per Second)

Amount of data sent from client to VM using proxy.

Internal Egress Data (Bytes per Second)

The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).

Internal Egress Packets (Packets per Second)

The number of packets sent from ILB backend to client of the flow.

Internal Ingress Data (Bytes per Second)

The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).

Internal Ingress Packets (Packets per Second)

The number of packets sent from client to ILB backend.

Internal RTT Latencies (Milliseconds)

A distribution of RTT measured over TCP connections for ILB flows.

IP Address

The IP address that this forwarding rule is serving on behalf of.

IP Protocol

The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. When the load balancing scheme is INTERNAL_SELF_MANAGED, only TCPis valid.

IP Version

The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.

Load Balancing Scheme

This signifies what the ForwardingRule will be used for and can only take the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The value of INTERNAL means that this will be used for Internal Network Load Balancing (TCP, UDP). The value of INTERNAL_SELF_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy).

Name

The name of the forwarding rule.

Network

Identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.

Network Tier

This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM , STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.

New Connections Opened (Connections)

Number of connections that were created over TCP/SSL proxy.

Open Connections (Connections)

Current number of outstanding connections through the TCP/SSL proxy.

Port Range

This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.

Ports

This field is used along with the backendService field for internal load balancing.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

Region

The region on which the forwarding rule is applied, such as 'global' or 'us-central1'. Various other objects are defined per that locality.

Self Link

Server-defined URL for the resource.

Subnetwork

Identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. This field is only used for INTERNAL load balancing.

Target

The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED" load balancing, only HTTP and HTTPS targets are valid.

Total Latency (Milliseconds)

A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Health Check

Name
Description

Check Interval (Seconds)

How often to send a health check.

Creation Timestamp

Creation timestamp in 3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Healthy Threshold

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Http Health Check Host

The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

Http Health Check Port

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

Http Health Check Port Name

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

Http Health Check Proxy Header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Http Health Check Request Path

The request path of the HTTP health check request. The default value is /.

Https Health Check Host

The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.

Https Health Check Port

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

Https Health Check Port Name

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

Https Health Check Proxy Header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

Https Health Check Request Path

The request path of the HTTPS health check request. The default value is /.

ID

The unique identifier for the resource. This identifier is defined by the server.

Name

Name of the resource.

Project ID

The project ID in which this resource was created.

Self Link

Server-defined URL for the resource.

SSL Health Check Port

The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.

SSL Health Check Port Name

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

SSL Health Check Proxy Header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

SSL Health Check Request

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

SSL Health Check Response

The data to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

TCP Health Check Port

The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.

TCP Health Check Port Name

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

TCP Health Check Proxy Header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

TCP Health Check Request

The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

TCP Health Check Response

The data to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Timeout (Seconds)

How long to wait before claiming failure.

Type

Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

Unhealthy Threshold

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HTTP Health Check

Name
Description

Check Interval (Seconds)

How often to send a health check.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Healthy Threshold

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Host

The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

ID

The unique identifier for the resource. This identifier is defined by the server.

Name

Name of the resource.

Port

The TCP port number for the HTTP health check request. The default value is 80.

Project ID

The project ID in which this resource was created.

Request Path

The request path of the HTTP health check request. The default value is /.

Self Link

Server-defined URL for the resource.

Timeout (Seconds)

How long to wait before claiming failure.

Unhealthy Threshold

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

HTTPS Health Check

Name
Description

Check Interval (Seconds)

How often to send a health check.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Healthy Threshold

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Host

The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

ID

The unique identifier for the resource. This identifier is defined by the server.

Name

Name of the resource.

Port

The TCP port number for the HTTPS health check request. The default value is 443.

Project ID

The project ID in which this resource was created.

Request Path

The request path of the HTTPS health check request. The default value is "/".

Self Link

Server-defined URL for the resource.

Timeout (Seconds)

How long to wait before claiming failure.

Unhealthy Threshold

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Load Balancer

Name
Description

Egress Data (Bytes per Second)

The amount of data sent from ILB backend to client (for TCP flows it's counting data on application stream only).

Egress Packets (Packets per Second)

The number of packets sent from ILB backend to client of the flow.

Ingress Data (Bytes per Second)

The amount of data sent from client to ILB backend (for TCP flows it's counting data on application stream only).

Ingress Packets (Packets per Second)

The number of packets sent from client to ILB backend.

Name

The name of the load balancer.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

RTT Latencies (Milliseconds)

A distribution of RTT measured over TCP connections for ILB flows.

Target Pool

Name
Description

Backup Pool

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Failover Ratio

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].

Health Checks

The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.

ID

The unique identifier for the resource. This identifier is defined by the server.

Instances

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

Name

Name of the resource.

Project ID

The project ID in which this resource was created.

Region

The region in which this resource is located.

Self Link

Server-defined URL for the resource.

Session Affinity

Sesssion affinity option.

Target Proxy

Name
Description

Backend Latency (Milliseconds)

A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.

Backend Request Count (Requests per Second)

The number of requests served by backends of HTTP/S load balancer.

Backend Request Data (Bytes per Second)

The amount of data sent as requests from HTTP/S load balancer to backends.

Backend Response Data (Bytes per Second)

The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.

Closed Connections (Connections)

Number of connections that were terminated over TCP/SSL proxy.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Description

An optional description of this resource. Provide this property when you create the resource.

Egress Data (Bytes per Second)

Amount of data sent from VM to client using proxy.

Frontend Request Count (Requests per Second)

The number of requests served by HTTP/S load balancer.

Frontend Request Data (Bytes per Second)

The amount of data sent as requests from clients to HTTP/S load balancer.

Frontend Response Data (Bytes per Second)

The amount of data sent as responses from HTTP/S load balancer to clients.

Frontend RTT (Milliseconds)

A distribution of the smoothed RTT measured by the proxy's TCP stack, each minute application layer bytes pass from proxy to client.

HTTPS Frontend RTT (Milliseconds)

A distribution of the RTT measured for each connection between client and proxy.

ID

The unique identifier for the resource. This identifier is defined by the server.

Ingress Data (Bytes per Second)

Amount of data sent from client to VM using proxy.

Name

The name of the target proxy.

New Connections Opened (Connections)

Number of connections that were created over TCP/SSL proxy.

Open Connections (Connections)

Current number of outstanding connections through the TCP/SSL proxy.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

Proxy Header

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.

QUIC Override

Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.

Self Link

Server-defined URL for the resource.

Service

URL to the BackendService resource.

SSL Certificates

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.

SSL Policy

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.

Total Latency (Milliseconds)

A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

Type

The type of Target Proxy (HTTP, HTTPS, TCP, SSL).

URL Map

A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService.

URL Map

Name
Description

Backend Latency (Milliseconds)

A distribution of the latency calculated from when the request was sent by the proxy to the backend until the proxy received from the backend the last byte of response.

Backend Request Count (Requests per Second)

The number of requests served by backends of HTTP/S load balancer.

Backend Request Data (Bytes per Second)

The amount of data sent as requests from HTTP/S load balancer to backends.

Backend Response Data (Bytes per Second)

The amount of data sent as responses from backends (or cache) to HTTP/S load balancer.

Creation Timestamp

Creation timestamp in RFC3339 text format.

Default Service

The URL of the BackendService resource if none of the hostRules match.

Description

An optional description of this resource. Provide this property when you create the resource.

Fingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

Frontend Request Count (Requests per Second)

The number of requests served by HTTP/S load balancer.

Frontend Request Data (Bytes per Second)

The amount of data sent as requests from clients to HTTP/S load balancer.

Frontend Response Data (Bytes per Second)

The amount of data sent as responses from HTTP/S load balancer to clients.

Frontend RTT (Milliseconds)

A distribution of the RTT measured for each connection between client and proxy.

ID

The unique identifier for the resource. This identifier is defined by the server.

Name

The name of the URL Map.

Project ID

The identifier of the GCP project associated with this resource, such as "my-project".

Self Link

Server-defined URL for the resource.

Total Latency (Milliseconds)

A distribution of the latency calculated from when the request was received by the proxy until the proxy got ACK from client on last response byte.

URL Map Host Rule

Name
Description

Description

An optional description of this resource. Provide this property when you create the resource.

Hosts

The list of host patterns to match. They must be valid hostnames, except will match any string of ([a-z0-9-.]). In that case, * must be the first character and must be followed in the pattern by either - or ..

Path Matcher

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

Project ID

The project ID in which this resource was created.

URL Map Name

Name of the URL Map.

URL Map Path Matchers

Name
Description

Default Service

The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion.

Description

An optional description of this resource. Provide this property when you create the resource.

Name

The name to which this PathMatcher is referred by the HostRule.

Path Rules Service

The URL of the BackendService resource if this rule is matched.

Project ID

The project ID in which this resource was created.

URL Map Name

Name of the URL Map.

URL Map Test

Name
Description

Description

Description of this test case.

Host

Host portion of the URL.

Path

Path portion of the URL.

Project ID

The project ID in which this resource was created.

Service

Expected BackendService resource the given URL should be mapped to.

URL Map Name

Name of the URL Map.