REST Resource: addresses

Resource: Address

Represents an IP Address resource.

Google Compute Engine has two IP Address resources:

For more information, see Reserving a static external IP address.

JSON representation 
{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "address": string,
  "prefixLength": integer,
  "status": enum (Status),
  "region": string,
  "selfLink": string,
  "users": [
    string
  ],
  "networkTier": enum (NetworkTier),
  "labels": {
    string: string,
    ...
  },
  "labelFingerprint": string,
  "ipVersion": enum (IpVersion),
  "addressType": enum (Type),
  "purpose": enum (Purpose),
  "subnetwork": string,
  "network": string,
  "ipv6EndpointType": enum (IPv6EndpointType)
}
Fields
kind

string

[Output Only] Type of the resource. Always

compute#address

for addresses.
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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
description

string

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

string

The static IP address represented by this resource.
prefixLength

integer

The prefix length if the resource represents an IP range.
status

enum (Status)

[Output Only] The status of the address, which can be one of

RESERVING

,

RESERVED

, or

IN_USE

. An address that is

RESERVING

is currently in the process of being reserved. A

RESERVED

address is currently reserved and available to use. An

IN_USE

address is currently being used by another resource and is not available.
region

string

[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.
users[]

string

[Output Only] The URLs of the resources that are using this address.
networkTier

enum (NetworkTier)

This signifies the networking tier used for configuring this address and can only take the following values:

PREMIUM

or

STANDARD

. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier.

If this field is not specified, it is assumed to be

PREMIUM

.
labels

map (key: string, value: string)

Labels for this resource. These can only be added or modified by the

setLabels

method. Each label key/value pair must comply with RFC1035. Label values may be empty.
labelFingerprint

string (bytes format)

A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error

412 conditionNotMet

.

To see the latest fingerprint, make a

get()

request to retrieve an Address.

A base64-encoded string.
ipVersion

enum (IpVersion)

The IP version that will be used by this address. Valid options are

IPV4

or

IPV6

.
addressType

enum (Type)

The type of address to reserve, either

INTERNAL

or

EXTERNAL

. If unspecified, defaults to

EXTERNAL

.
purpose

enum (Purpose)

The purpose of this resource, which can be one of the following values:

  • GCE_ENDPOINT

    for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.

  • DNS_RESOLVER

    for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network)

  • VPC_PEERING

    for global internal IP addresses used for private services access allocated ranges.

  • NAT_AUTO

    for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation.

  • IPSEC_INTERCONNECT

    for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.

  • SHARED_LOADBALANCER_VIP for an internal IP address that is assigned to multiple internal forwarding rules.
  • PRIVATE_SERVICE_CONNECT for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.
subnetwork

string

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with

INTERNAL

type with a

GCE_ENDPOINT

or

DNS_RESOLVER

purpose.
network

string

The URL of the network in which to reserve the address. This field can only be used with

INTERNAL

type with the

VPC_PEERING

purpose.
ipv6EndpointType

enum (IPv6EndpointType)

The endpoint type of this address, which should be

VM

or

NETLB

. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.

Status

Enums
RESERVING Address is being reserved.
RESERVED Address is reserved and available to use.
IN_USE Address is being used by another resource and is not available.

IpVersion

Enums
UNSPECIFIED_VERSION
IPV4
IPV6

Type

Enums
UNSPECIFIED_TYPE
EXTERNAL A publicly visible external IP address.
INTERNAL A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.

IPv6EndpointType

Enums
VM Reserved IPv6 address can be used on VM.
NETLB Reserved IPv6 address can be used on network load balancer.

Methods

aggregatedList

 The method compute.v1.RegionAddressesService.AggregatedList is not available in this (s3nsapis.fr) universe.

delete

 The method compute.v1.RegionAddressesService.Delete is not available in this (s3nsapis.fr) universe.

get

 The method compute.v1.RegionAddressesService.Get is not available in this (s3nsapis.fr) universe.

insert

 The method compute.v1.RegionAddressesService.Insert is not available in this (s3nsapis.fr) universe.

list

 The method compute.v1.RegionAddressesService.List is not available in this (s3nsapis.fr) universe.

move

 The method compute.v1.RegionAddressesService.Move is not available in this (s3nsapis.fr) universe.

setLabels

 The method compute.v1.RegionAddressesService.SetLabels is not available in this (s3nsapis.fr) universe.