Method: targetTcpProxies.get

Returns the specified TargetTcpProxy resource.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/global/targetTcpProxies/{targetTcpProxy}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
targetTcpProxy

string

Name of the TargetTcpProxy resource to return.

Request body

The request body must be empty.

Response body

Represents a Target TCP Proxy resource.

A target TCP proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target TCP proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "service": string,
  "proxyHeader": enum,
  "proxyBind": boolean,
  "region": string
}
Fields
kind

string

[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
id

string (uint64 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.
service

string

URL to the BackendService resource.
proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
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.
region

string

[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.

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.targetTcpProxies.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.