Method: targetInstances.get

Returns the specified TargetInstance resource. acceleratorTypes.get a list of available target instances by making a list() request.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/targetInstances/{resourceId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
project

string

Project ID for this request.

zone

string

Name of the zone scoping this request.

resourceId

string

Name of the TargetInstance resource to return.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "resource": {
    "id": string,
    "creationTimestamp": string,
    "name": string,
    "description": string,
    "zone": string,
    "natPolicy": enum,
    "instance": string,
    "selfLink": string,
    "kind": string
  },
}
Fields
resource

object

resource.id

string (fixed64 format)

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

resource.creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.

resource.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.

resource.description

string

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

resource.zone

string

[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

resource.natPolicy

enum

NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.

resource.instance

string

A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:

resource.selfLink

string

[Output Only] Server-defined URL for the resource.

resource.kind

string

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

  • compute.targetInstances.get

Send feedback about...

Compute Engine