- [Resource: Address](https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses#Address) - [JSON representation](https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses#Address.SCHEMA_REPRESENTATION) - [Methods](https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses#METHODS_SUMMARY) ## Resource: Address Represents an IP Address resource. Google Compute Engine has two IP Address resources: - [Global (external and internal)](https://cloud.google.com/compute/docs/reference/rest/beta/globalAddresses) - [Regional (external and internal)](https://cloud.google.com/compute/docs/reference/rest/beta/addresses) For more information, see [Reserving a static external IP address](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address). | JSON representation | |---| | ``` { "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "address": string, "prefixLength": integer, "status": enum, "region": string, "selfLink": string, "users": [ string ], "networkTier": enum, "labels": { string: string, ... }, "labelFingerprint": string, "ipVersion": enum, "addressType": enum, "purpose": enum, "subnetwork": string, "network": string, "ipv6EndpointType": enum, "ipCollection": string } ``` | | Fields || |---|---| | `kind` | `string` Output only. Type of the resource. Always `compute#address` for addresses. | | `id` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. The unique identifier for the resource. This identifier is defined by the server. | | `creationTimestamp` | `string` Output only. Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) 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](https://www.ietf.org/rfc/rfc1035.txt). 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` 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.** | | `selfLink` | `string` Output only. Server-defined URL for the resource. | | `users[]` | `string` Output only. The URLs of the resources that are using this address. | | `networkTier` | `enum` 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](https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty. | | `labelFingerprint` | `string (https://developers.google.com/discovery/v1/type-format 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` The IP version that will be used by this address. Valid options are `IPV4` or `IPV6`. | | `addressType` | `enum` The type of address to reserve, either `INTERNAL` or `EXTERNAL`. If unspecified, defaults to `EXTERNAL`. | | `purpose` | `enum` 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](https://cloud.google.com/dns/docs/policies#create-in) (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](https://cloud.google.com/vpc/docs/configure-private-services-access#allocating-range). - `NAT_AUTO` for the regional external IP addresses used by Cloud NAT when allocating addresses using [automatic NAT IP address allocation](https://cloud.google.com/nat/docs/ports-and-addresses#addresses). - `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. - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP0` for addresses that can only be assigned to global external Passthrough Network Load Balancer forwarding rules, as an Availability Group 0 address. - `PASSTHROUGH_LOAD_BALANCER_AVAILABILITY_GROUP1` for addresses that can only be assigned to global external Passthrough Network Load Balancer forwarding rules, as an Availability Group 1 address.
| | `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` 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. | | `ipCollection` | `string` Reference to the source of IP addresses. It supports the following cases: - Case 1: `PublicDelegatedPrefix` (PDP) for BYOIP external addresses. If an IPv4 PDP is used, the PDP must support enhanced IPv4 allocations. If an IPv6 PDP is used, the PDP must be in `EXTERNAL_IPV6_FORWARDING_RULE_CREATION` mode. - Case 2: `Internal Range` for global internal addresses.
Use one of the following formats to specify the resource: For a Public Delegated Prefix: - Full resource URL: `https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp` - Partial URL: - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - regions/region/publicDelegatedPrefixes/pdp-name
For an Internal Range: - Full URL: `https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range` - Partial URL: `projects/project/locations/global/internalRanges/internal-range`
| | ## Methods || |---|---| | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/aggregatedList` | Retrieves an aggregated list of addresses. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/delete` | Deletes the specified address resource. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/get` | Returns the specified address resource. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/insert` | Creates an address resource in the specified project by using the data included in the request. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/list` | Retrieves a list of addresses contained within the specified region. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/move` | Moves the specified address resource. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/setLabels` | Sets the labels on an Address. | | ### `https://docs.cloud.google.com/compute/docs/reference/rest/beta/addresses/testIamPermissions` | Returns permissions that a caller has on the specified resource. |