REST Resource: targetHttpsProxies

Resource: TargetHttpsProxy

Represents a Target HTTPS Proxy resource.

Google Compute Engine has two Target HTTPS Proxy resources:

A target HTTPS proxy is a component of GCP HTTPS load balancers.

  • targetHttpsProxies are used by external HTTPS load balancers.
  • regionTargetHttpsProxies are used by internal HTTPS load balancers.

Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.

JSON representation 
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "urlMap": string,
  "sslCertificates": [
    string
  ],
  "quicOverride": enum,
  "sslPolicy": string,
  "region": string,
  "proxyBind": boolean,
  "httpFilters": [
    string
  ],
  "serverTlsPolicy": string,
  "authentication": string,
  "authorizationPolicy": string,
  "authorization": string,
  "kind": string
}
Fields
id

string (fixed64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
description

string

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

string

A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:

sslCertificates[]

string

URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
quicOverride

enum

Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.

  • When quic-override is set to NONE, Google manages whether QUIC is used.
  • When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
  • When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
  • If the quic-override flag is not specified, NONE is implied.
sslPolicy

string

URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
region

string

[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
proxyBind

boolean

This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.

When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

The default is false.
httpFilters[]

string

URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.

httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
serverTlsPolicy

string

Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.

serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

If left blank, communications are not encrypted.

Note: This field currently has no impact.
authentication
(deprecated)

string

[Deprecated] Use serverTlsPolicy instead.
authorizationPolicy

string

Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.

Refer to the AuthorizationPolicy resource for additional details.

authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Note: This field currently has no impact.
authorization
(deprecated)

string

[Deprecated] Use authorizationPolicy instead.
kind

string

[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.

Methods

aggregatedList

 Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.

delete

 Deletes the specified TargetHttpsProxy resource.

get

 Returns the specified TargetHttpsProxy resource.

insert

 Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

list

 Retrieves the list of TargetHttpsProxy resources available to the specified project.

setQuicOverride

 Sets the QUIC override policy for TargetHttpsProxy.

setSslCertificates

 Replaces SslCertificates for TargetHttpsProxy.

setSslPolicy

 Sets the SSL policy for TargetHttpsProxy.

setUrlMap

 Changes the URL map for TargetHttpsProxy.

testIamPermissions

 Returns permissions that a caller has on the specified resource.