Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
addresses

Creates an address resource in the specified project by using the data included in the request.

post/projects/{project}/regions/{region}/addresses

Path parameters

projectstring required

Project ID for this request.

regionstring required

Name of the region for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

addressType'EXTERNAL' | 'INTERNAL' | 'UNSPECIFIED_TYPE'

The type of address to reserve, either INTERNAL orEXTERNAL. If unspecified, defaults to EXTERNAL.

ipVersion'IPV4' | 'IPV6' | 'UNSPECIFIED_VERSION'

The IP version that will be used by this address. Valid options areIPV4 or IPV6.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

labelsobject

Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

labelFingerprintstring byte

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an Address.

descriptionstring

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

regionstring

Output only. [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.

ipv6EndpointType'NETLB' | 'VM'

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.

kindstring

Output only. [Output Only] Type of the resource. Always compute#address for addresses.

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

idstring uint64

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

usersstring[]

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

networkTier'FIXED_STANDARD' | 'PREMIUM' | 'STANDARD' | 'STANDARD_OVERRIDES_FIXED_STANDARD'

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM orSTANDARD. 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.

prefixLengthinteger

The prefix length if the resource represents an IP range.

purpose'DNS_RESOLVER' | 'GCE_ENDPOINT' | 'IPSEC_INTERCONNECT' | 'NAT_AUTO' | 'PRIVATE_SERVICE_CONNECT' | 'SERVERLESS' | 'SHARED_LOADBALANCER_VIP' | 'VPC_PEERING'

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

The static IP address represented by this resource.

status'IN_USE' | 'RESERVED' | 'RESERVING'

Output only. [Output Only] The status of the address, which can be one ofRESERVING, 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.

networkstring

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

selfLinkstring

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

subnetworkstring

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 aGCE_ENDPOINT or DNS_RESOLVER purpose.

ipCollectionstring

Reference to the source of IP addresses.

It supports the following cases:

  • Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 addresses. The PDP must support enhanced IPv4 allocations.
  • 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:

Response

Successful response