- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Retrieves the list of TargetHttpsProxy resources available to the specified project.
HTTP request
GET https://compute.googleapis.com/compute/beta/projects/{project}/global/targetHttpsProxies
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
project
|
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults
|
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken
|
Specifies a page token to use. Set |
filter
|
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use You cannot combine constraints on multiple fields using regular expressions. |
orderBy
|
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using Currently, only sorting by |
returnPartialSuccess
|
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. |
Request body
The request body must be empty.
Response body
Contains a list of TargetHttpsProxy resources.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind" : string , "id" : string , "items" : [ { "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "description" : string , "selfLink" : string , "urlMap" : string , "sslCertificates" : [ string ] , "certificateMap" : string , "quicOverride" : enum , "sslPolicy" : string , "region" : string , "proxyBind" : boolean , "httpFilters" : [ string ] , "serverTlsPolicy" : string , "authentication" : string , "authorizationPolicy" : string , "authorization" : string , "fingerprint" : string , "httpKeepAliveTimeoutSec" : integer , "tlsEarlyData" : enum } ] , "nextPageToken" : string , "selfLink" : string , "warning" : { "code" : enum , "message" : string , "data" : [ { "key" : string , "value" : string } ] } } |
kind
string
Type of resource. Always compute#targetHttpsProxyList
for lists of target HTTPS proxies.
id
string
[Output Only] Unique identifier for the resource; defined by the server.
items[]
object
A list of TargetHttpsProxy resources.
items[].kind
string
[Output Only] Type of resource. Always compute#targetHttpsProxy
for target HTTPS proxies.
items[].id
string ( uint64
format)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
items[].creationTimestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
items[].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.
items[].description
string
An optional description of this resource. Provide this property when you create the resource.
items[].selfLink
string
[Output Only] Server-defined URL for the resource.
items[].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:
-
https://www.googleapis.compute/v1/projects/ project /global/urlMaps/ url-map
-
projects/ project /global/urlMaps/ url-map
-
global/urlMaps/ url-map
items[].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. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.
The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificateMap instead.
Currently, you may specify up to 15 Classic SSL Certificates.
Certificate Manager Certificates accepted formats are:
-
//certificatemanager.googleapis.com/projects/{ project }/locations/{ location }/certificates/{ resourceName }
. -
https://certificatemanager.googleapis.com/v1alpha1/projects/{ project }/locations/{ location }/certificates/{ resourceName }
.
items[].certificateMap
string
URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead.
If set, sslCertificates will be ignored.
Accepted format is //certificatemanager.googleapis.com/projects/{ project
}/locations/{ location
}/certificateMaps/{ resourceName
}
.
items[].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 toNONE
, Google manages whether QUIC is used. - When
quic-override
is set toENABLE
, the load balancer uses QUIC when possible. - When
quic-override
is set toDISABLE
, the load balancer doesn't use QUIC. - If the
quic-override
flag is not specified,NONE
is implied.
items[].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.
items[].region
string
[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
items[].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
.
items[].httpFilters[]
string
URLs to networkservices.HttpFilter
resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/projects/
project
/locations/ location
/httpFilters/ 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.
items[].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
or EXTERNAL
or EXTERNAL_MANAGED
. For details which ServerTlsPolicy
resources are accepted with INTERNAL_SELF_MANAGED
and which with EXTERNAL
, EXTERNAL_MANAGED
loadBalancingScheme
consult ServerTlsPolicy
documentation.
If left blank, communications are not encrypted.
items[].authentication
(deprecated)
string
[Deprecated] Use serverTlsPolicy
instead.
items[].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.
items[].authorization
(deprecated)
string
[Deprecated] Use authorizationPolicy
instead.
items[].fingerprint
string ( bytes
format)
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy
. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet
. To see the latest fingerprint, make a get()
request to retrieve the TargetHttpsProxy.
A base64-encoded string.
items[].httpKeepAliveTimeoutSec
integer
Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used.
For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds.
For classic Application Load Balancers, this option is not supported.
items[].tlsEarlyData
enum
Specifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3).
This can improve application performance, especially on networks where interruptions may be common, such as on mobile.
Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included.
Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant.
The default value is DISABLED.
nextPageToken
string
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults
, use the nextPageToken
as a value for the query parameter pageToken
in the next list request. Subsequent list requests will have their own nextPageToken
to continue paging through the results.
selfLink
string
[Output Only] Server-defined URL for this resource.
warning
object
[Output Only] Informational warning message.
warning.code
enum
[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE
if there are no results in the response.
warning.message
string
[Output Only] A human-readable description of the warning code.
warning.data[]
object
[Output Only] Metadata about this warning in key: value
format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warning.data[].key
string
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope
and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warning.data[].value
string
[Output Only] A warning data value corresponding to the key.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute.readonly
-
https://www.googleapis.com/auth/compute
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
-
compute.targetHttpsProxies.list
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .