Reserve a static external IP address

You can reserve static external IP addresses. You can also list and release your reserved static external IP addresses. To assign a static external IP address to a virtual machine (VM) instance, see Configure static external IP addresses .

External IP addresses can be static or ephemeral . If a VM requires a fixed external IP address that does not change, you can obtain a static external IP address. You can reserve new external IP addresses or promote existing ephemeral external IP addresses.

If you require a static internal IP address, see Reserve a static internal IP address instead.

Before you begin

Read about IP addresses .
Read about quotas and limits for static external IP addresses .
Read about external IP address pricing .
If you haven't already, set up authentication. Authentication is the process by which your identity is verified for access to Google Cloud services and APIs. To run code or samples from a local development environment, you can authenticate as follows.
Select the tab for how you plan to use the samples on this page:
Console

When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud

Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
```
gcloud  
init
```
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity .

Note:If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update .
Terraform

To use the Terraform samples on this page in a local development environment, install and initialize the gcloud CLI, and then set up Application Default Credentials with your user credentials.
For more information, see Set up ADC for a local development environment in the Google Cloud authentication documentation.
REST

To use the REST API samples on this page in a local development environment, you use the credentials you provide to the gcloud CLI.
For more information, see Authenticate for using REST in the Google Cloud authentication documentation.

Required roles

To get the permissions that you need to reserve and manage static IP addresses, ask your administrator to grant you the Compute Network Admin ( roles/compute.networkAdmin ) IAM role on your project. For more information about granting roles, see Manage access to projects, folders, and organizations .

This predefined role contains the permissions required to reserve and manage static IP addresses. To see the exact permissions that are required, expand the Required permissionssection:

Required permissions

The following permissions are required to reserve and manage static IP addresses:

compute.addresses.create on the IP address
compute.addresses.createInternal on the IP address
compute.networks.list on the network
compute.subnetworks.use on the subnet
compute.subnetworks.list on the subnet

You might also be able to get these permissions with custom roles or other predefined roles .

About static external IP addresses

A static external IP address is the IP address that is reserved for your resource until you decide to release it . If you have an IP address that your customers or users rely on to access your service, you can reserve that IP address so that only your resource can use it. You can also promote an ephemeral external IP address to a static external IP address.

For more information, see IP addresses .

The following table lists the static external IP addresses supported by Google Cloud.

IP address type	Resource	IP range	Source	Associated with
Regional external IPv4 addresses	VMs and regional load balancers	`/32`	Google's pool of external IP addresses	Project
Regional external IPv6 addresses	VMs and supported regional load balancers	`/96`	Subnet's external IPv6 address range	Subnet
Global external IPv4 addresses	Global load balancers	`/32`	Google's pool of external IP addresses	Project
Global external IPv6 addresses	Global load balancers	`/64`	Google's pool of external IP addresses	Project

For a list of regional and global load balancers, see the Summary of load balancer types .

Assigned external IP addresses exist on the same physical host as the VM and exist in the same region as the VM for all purposes, including routing, latency, and pricing. This is true regardless of internet geolocation lookup information.

Limitations

Only one resource at a time can use a static external IP address.
There is no way to check whether an IP address is static or ephemeral after it has been assigned to a resource. You can compare the IP address against the list of static external IP addresses reserved to that project. Use the gcloud compute addresses list sub-command to see a list of static external IP addresses available to the project.
Each VM can have multiple network interfaces, and each interface can have the following IP addresses assigned according to its stack type :
- IPv4-only interfaces:
  - An internal IPv4 address (required)
  - An external IPv4 address (optional)
- Dual-stack (IPv4 and IPv6) interfaces:
  - An internal IPv4 address (required)
  - An external IPv4 address (optional)
  - A /96 IPv6 address range, either internal or external, but not both (required)
- IPv6-only interfaces:
  - A /96 IPv6 address range, either internal or external, but not both (required)
You can't unassign or change the external IPv6 address of a VM with an IPv6-only network interface. You can, however, promote an ephemeral external IP address of a resource to a static external IP address so that the address remains reserved even after the resource is deleted.
You cannot change the name of a static IP address.

Note: Network interfaces can receive traffic from multiple forwarding rules , which might serve other external IP addresses. Any number of external IP addresses can reference a network interface through these forwarding rules, but each network interface can be assigned only one external IPv4 address and one external /96 IPv6 address range.

For more information about load balancing and forwarding rules, read the load balancing documentation.

Reserve a new static external IP address

After reserving the address, assign it to a new VM while creating it or to an existing VM .

Console

In the Google Cloud console, go to the IP addressespage.
Go to IP addresses
Click Reserve external static IP address.
In the Namefield, enter an IP address name.
Specify whether the network service tier is Premiumor Standard. IPv6 static address reservation is supported only in the Premium tier.
Specify whether it is an IPv4or IPv6address.
Specify whether this IP address is Regionalor Global.
- If you are reserving a static IP address for a global load balancer, choose Globaland then click Reserve.
- If you are reserving a static IP address for a VM or for a regional load balancer, choose Regional, and then select the region to create the address in.
If you are reserving a regional external IPv6 address, then also choose the following:
- Network: the VPC network
- Subnetwork: the subnet from which to assign the static regional IPv6 address
- Endpoint type: choose VM instanceor Network Load Balancer
Optional: If you are reserving the static external IP address for a VM, then in the Attached tolist, select a VM to attach the IP address to.
Click Reserveto reserve the IP address.

gcloud

To reserve a static external IP address, use the gcloud compute addresses create command .

Use the following instructions to reserve a static external IPv4 or IPv6 address:

Global IP address

To reserve a global IP address:

gcloud compute addresses create ADDRESS_NAME 
\
      --global \
      --ip-version= IP_VERSION

Regional external IPv4 address

To reserve a regional external IPv4 address:

gcloud compute addresses create ADDRESS_NAME 
\
       --region= REGION

Regional external IPv6 address

To reserve a regional external IPv6 address:

gcloud compute addresses create ADDRESS_NAME 
\
       --region= REGION 
\
       --subnet= SUBNET_NAME 
\
       --ip-version=IPV6 \
       --endpoint-type= ENDPOINT_TYPE

Replace the following:

ADDRESS_NAME : the name that you want to associate with this address.
REGION : for regional external IP addresses, specify a region for the IP address.
SUBNET_NAME : for regional external IPv6 addresses, specify the subnet to assign the static regional IPv6 address from. The subnet must have an assigned external IPv6 address range .
IP_VERSION : for global IP addresses, specify the IP version, either IPv4 or IPv6 .
ENDPOINT_TYPE : for regional external IPv6 addresses, specify the endpoint type, either VM or NETLB .

To view the result, use the gcloud compute addresses describe command :

gcloud compute addresses describe ADDRESS_NAME

Terraform

You can use the google_compute_address resource to create a regional external IP address.

 resource "google_compute_address" "default" {
  name   = "my-test-static-ip-address"
  region = "us-central1"
}

The following sample shows how to use the google_compute_global_address resource to create a global external IPv6 address:

 resource "google_compute_global_address" "default" {
  project      = var.project_id # Replace this with your service project ID in quotes
  name         = "ipv6-address"
  address_type = "EXTERNAL"
  ip_version   = "IPV6"
}

API

To create a regional IPv4 address, call the regional addresses.insert method :
```
POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/addresses
```
Your request body should contain the following:
```
{
  "name": " ADDRESS_NAME 
"
}
```
Replace the following:
- PROJECT_ID : the project ID for this request
- REGION : the name of the region for this request
- ADDRESS_NAME : the name that you want to associate with the address

For global static IPv4 addresses, call the globalAddresses.insert method :

POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/addresses

Your request body should contain the following:

{
  "name": " ADDRESS_NAME 
"
}

For global static IPv6 addresses, call the globalAddresses.insert method :
```
POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/addresses
```
Your request body should contain the following:
```
{
  "name": " ADDRESS_NAME 
",
  "ipVersion": "IPV6"
}
```
To see the result, use the addresses.get method .

For regional static IPv6 addresses, call the addresses.insert method :

POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/addresses

Your request body should contain the following:

{
  "name": " ADDRESS_NAME 
",
  "ipVersion": "IPV6",
  "ipv6EndpointType": "VM|LB",
  "networkTier": "PREMIUM",
  "subnetwork": " SUBNET 
"
}

Replace SUBNET with the subnet for this project.

To see the result, use the addresses.get method .

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
 ) 
 // reserveNewRegionalExternal reserves a new regional external IP address in Google Cloud Platform. 
 func 
  
 reserveNewRegionalExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 region 
 , 
  
 addressName 
  
 string 
 , 
  
 isPremium 
  
 bool 
 ) 
  
 ( 
 * 
 computepb 
 . 
 Address 
 , 
  
 error 
 ) 
  
 { 
  
 // projectID := "your_project_id" 
  
 // region := "europe-central2" 
  
 // addressName := "your_address_name" 
  
 // isPremium := true 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 networkTier 
  
 := 
  
 computepb 
 . 
  AccessConfig_STANDARD 
 
 . 
 String 
 () 
  
 if 
  
 isPremium 
  
 { 
  
 networkTier 
  
 = 
  
 computepb 
 . 
  AccessConfig_PREMIUM 
 
 . 
 String 
 () 
  
 } 
  
 address 
  
 := 
  
& computepb 
 . 
 Address 
 { 
  
 Name 
 : 
  
& addressName 
 , 
  
 NetworkTier 
 : 
  
& networkTier 
 , 
  
 } 
  
 client 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 InsertAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Region 
 : 
  
 region 
 , 
  
 AddressResource 
 : 
  
 address 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 client 
 . 
 Insert 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to reserve regional address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "waiting for the regional address reservation operation to complete: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 addressResult 
 , 
  
 err 
  
 := 
  
 client 
 . 
 Get 
 ( 
 ctx 
 , 
  
& computepb 
 . 
 GetAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Region 
 : 
  
 region 
 , 
  
 Address 
 : 
  
 addressName 
 , 
  
 }) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to get reserved regional address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Regional address %v reserved: %v" 
 , 
  
 addressName 
 , 
  
 addressResult 
 . 
 GetAddress 
 ()) 
  
 return 
  
 addressResult 
 , 
  
 err 
 } 
 // reserveNewGlobalExternal reserves a new global external IP address in Google Cloud Platform. 
 func 
  
 reserveNewGlobalExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 addressName 
  
 string 
 , 
  
 isV6 
  
 bool 
 ) 
  
 ( 
 * 
 computepb 
 . 
 Address 
 , 
  
 error 
 ) 
  
 { 
  
 // projectID := "your_project_id" 
  
 // addressName := "your_address_name" 
  
 // isV6 := false 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 ipVersion 
  
 := 
  
 computepb 
 . 
  Address_IPV4 
 
 . 
 String 
 () 
  
 if 
  
 isV6 
  
 { 
  
 ipVersion 
  
 = 
  
 computepb 
 . 
  Address_IPV6 
 
 . 
 String 
 () 
  
 } 
  
 address 
  
 := 
  
& computepb 
 . 
 Address 
 { 
  
 Name 
 : 
  
& addressName 
 , 
  
 IpVersion 
 : 
  
& ipVersion 
 , 
  
 } 
  
 client 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewGlobalAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewGlobalAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 InsertGlobalAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 AddressResource 
 : 
  
 address 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 client 
 . 
 Insert 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to reserve global address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "waiting for the global address reservation operation to complete: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 addressResult 
 , 
  
 err 
  
 := 
  
 client 
 . 
 Get 
 ( 
 ctx 
 , 
  
& computepb 
 . 
 GetGlobalAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Address 
 : 
  
 addressName 
 , 
  
 }) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to get reserved global address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Global address %v reserved: %v" 
 , 
  
 addressName 
 , 
  
 addressResult 
 . 
 GetAddress 
 ()) 
  
 return 
  
 addressResult 
 , 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. Address 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Address 
. AddressType 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Address 
.IpVersion 
 ; 
 import 
  
 com.google.cloud.compute.v1. Address 
.NetworkTier 
 ; 
 import 
  
 com.google.cloud.compute.v1. AddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. GlobalAddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InsertAddressRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InsertGlobalAddressRequest 
 
 ; 
 import 
  
 com.google.common.collect.Lists 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.List 
 ; 
 import 
  
 java.util.UUID 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 ReserveNewExternalAddress 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // Project ID or project number of the Google Cloud project you want to use. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 // Address name you want to use. 
  
 String 
  
 addressName 
  
 = 
  
 "your-address-name" 
 ; 
  
 // 'IPV4' or 'IPV6' depending on the IP version. IPV6 if True. 
  
 boolean 
  
 ipV6 
  
 = 
  
 false 
 ; 
  
 // 'STANDARD' or 'PREMIUM' network tier. Standard option available only in regional ip. 
  
 boolean 
  
 isPremium 
  
 = 
  
 false 
 ; 
  
 // region (Optional[str]): The region to reserve the IP address in, if regional. 
  
 // Must be None if global. 
  
 String 
  
 region 
  
 = 
  
 null 
 ; 
  
 reserveNewExternalIpAddress 
 ( 
 projectId 
 , 
  
 addressName 
 , 
  
 ipV6 
 , 
  
 isPremium 
 , 
  
 region 
 ); 
  
 } 
  
 // Reserves a new external IP address in the specified project and region. 
  
 public 
  
 static 
  
 List<Address> 
  
 reserveNewExternalIpAddress 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 addressName 
 , 
  
 boolean 
  
 ipV6 
 , 
  
 boolean 
  
 isPremium 
 , 
  
 String 
  
 region 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 String 
  
 ipVersion 
  
 = 
  
 ipV6 
  
 ? 
  
 IpVersion 
 . 
 IPV6 
 . 
 name 
 () 
  
 : 
  
 IpVersion 
 . 
 IPV4 
 . 
 name 
 (); 
  
 String 
  
 networkTier 
  
 = 
  
 ! 
 isPremium 
 && 
 region 
  
 != 
  
 null 
  
 ? 
  
 NetworkTier 
 . 
 STANDARD 
 . 
 name 
 () 
  
 : 
  
 NetworkTier 
 . 
 PREMIUM 
 . 
 name 
 (); 
  
  Address 
 
 . 
 Builder 
  
 address 
  
 = 
  
  Address 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 addressName 
 ) 
  
 . 
  setAddressType 
 
 ( 
  AddressType 
 
 . 
 EXTERNAL 
 . 
 name 
 ()) 
  
 . 
 setNetworkTier 
 ( 
 networkTier 
 ); 
  
 // Use global client if no region is specified 
  
 if 
  
 ( 
 region 
  
 == 
  
 null 
 ) 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  GlobalAddressesClient 
 
  
 client 
  
 = 
  
  GlobalAddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 address 
 . 
 setIpVersion 
 ( 
 ipVersion 
 ); 
  
  InsertGlobalAddressRequest 
 
  
 addressRequest 
  
 = 
  
  InsertGlobalAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setRequestId 
 ( 
 UUID 
 . 
 randomUUID 
 (). 
 toString 
 ()) 
  
 . 
 setAddressResource 
 ( 
 address 
 . 
 build 
 ()) 
  
 . 
 build 
 (); 
  
 client 
 . 
 insertCallable 
 (). 
 futureCall 
 ( 
 addressRequest 
 ). 
 get 
 ( 
 30 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 return 
  
 Lists 
 . 
 newArrayList 
 ( 
 client 
 . 
 list 
 ( 
 projectId 
 ). 
 iterateAll 
 ()); 
  
 } 
  
 } 
  
 else 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  AddressesClient 
 
  
 client 
  
 = 
  
  AddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
 address 
 . 
 setRegion 
 ( 
 region 
 ); 
  
  InsertAddressRequest 
 
  
 addressRequest 
  
 = 
  
  InsertAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setRequestId 
 ( 
 UUID 
 . 
 randomUUID 
 (). 
 toString 
 ()) 
  
 . 
 setAddressResource 
 ( 
 address 
 . 
 build 
 ()) 
  
 . 
 setRegion 
 ( 
 region 
 ) 
  
 . 
 build 
 (); 
  
 client 
 . 
 insertCallable 
 (). 
 futureCall 
 ( 
 addressRequest 
 ). 
 get 
 ( 
 30 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 return 
  
 Lists 
 . 
 newArrayList 
 ( 
 client 
 . 
 list 
 ( 
 projectId 
 , 
  
 region 
 ). 
 iterateAll 
 ()); 
  
 } 
  
 } 
  
 } 
 }

Python

  from 
  
 typing 
  
 import 
 Optional 
 from 
  
 google.cloud.compute_v1.services.addresses.client 
  
 import 
 AddressesClient 
 from 
  
 google.cloud.compute_v1.services.global_addresses 
  
 import 
 GlobalAddressesClient 
 from 
  
 google.cloud.compute_v1.types 
  
 import 
 Address 
 def 
  
 reserve_new_external_ip_address 
 ( 
 project_id 
 : 
 str 
 , 
 address_name 
 : 
 str 
 , 
 is_v6 
 : 
 bool 
 = 
 False 
 , 
 is_premium 
 : 
 bool 
 = 
 False 
 , 
 region 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ): 
  
 """ 
 Reserves a new external IP address in the specified project and region. 
 Args: 
 project_id (str): Your Google Cloud project ID. 
 address_name (str): The name for the new IP address. 
 is_v6 (bool): 'IPV4' or 'IPV6' depending on the IP version. IPV6 if True. 
 is_premium (bool): 'STANDARD' or 'PREMIUM' network tier. Standard option available only in regional ip. 
 region (Optional[str]): The region to reserve the IP address in, if regional. Must be None if global. 
 Returns: 
 None 
 """ 
 ip_version 
 = 
 "IPV6" 
 if 
 is_v6 
 else 
 "IPV4" 
 network_tier 
 = 
 "STANDARD" 
 if 
 not 
 is_premium 
 and 
 region 
 else 
 "PREMIUM" 
 address 
 = 
 Address 
 ( 
 name 
 = 
 address_name 
 , 
 address_type 
 = 
 "EXTERNAL" 
 , 
 network_tier 
 = 
 network_tier 
 , 
 ) 
 if 
 not 
 region 
 : 
 # global IP address 
 client 
 = 
 GlobalAddressesClient 
 () 
 address 
 . 
 ip_version 
 = 
 ip_version 
 operation 
 = 
 client 
 . 
 insert 
 ( 
 project 
 = 
 project_id 
 , 
 address_resource 
 = 
 address 
 ) 
 else 
 : 
 # regional IP address 
 address 
 . 
 region 
 = 
 region 
 client 
 = 
 AddressesClient 
 () 
 operation 
 = 
 client 
 . 
 insert 
 ( 
 project 
 = 
 project_id 
 , 
 region 
 = 
 region 
 , 
 address_resource 
 = 
 address 
 ) 
 operation 
 . 
 result 
 () 
 print 
 ( 
 f 
 "External IP address ' 
 { 
 address_name 
 } 
 ' reserved successfully." 
 )

Promote an ephemeral external IP address

If your VM has an ephemeral external IP address and you want to permanently assign the IP address to your project, promote the ephemeral external IP address to a static external IP address. Promoting an ephemeral external IP address to reserved does not cause Google Cloud to drop packets sent to the VM. This includes packets sent to the VM directly or by means of a load balancer.

Console

Go to the IP addressespage.
Go to IP addresses
Click External IP addresses.
Optional: In the Filterfield, search for the ephemeral IP address that you want to promote.
In the More actionsmenu ( ) of the IP address that you want to promote, select Promote to static IP address.
Enter a name for the new static IP address, and then click Reserve.

gcloud

Use the following instructions to promote a static external IPv4 or IPv6 address:

To promote an ephemeral external IPv4 address to a static external IPv4 address, provide the ephemeral external IP address by using the --addresses flag with the compute addresses create command . Use the region flag to promote an ephemeral regional IP address or the global flag to promote an ephemeral global IP address.
```
gcloud compute addresses create ADDRESS_NAME 
--addresses= IP_ADDRESS 
\
    [--region= REGION 
| --global]
```
Replace the following:
- ADDRESS_NAME : the name that you want to associate with this address.
- IP_ADDRESS : the IP address that you want to promote.
- REGION : the region that the regional IP address belongs to.
To promote an ephemeral regional external IPv6 address to a static regional external IPv6 address, provide the ephemeral external IP address by using the --addresses flag with the gcloud compute addresses create command .
```
gcloud compute addresses create ADDRESS_NAME 
\
  --region= REGION 
\
  --addresses= IPV6_ADDRESS 
\
  --prefix-length=96
```
Replace the following:
- ADDRESS_NAME : a name for the IP address resource.
- REGION : the region for the IPv6 address resource.
- IPV6_ADDRESS : the IPv6 address that you're promoting.

API

To promote an ephemeral regional IP address, call the addresses.insert method :

POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/addresses

To promote an ephemeral global IP address, make a POST request to the following URI:

POST https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/addresses

Specify the values for the required fields of the request body:

For IPv4 addresses, your request body should contain the following fields:

{
  "name": " ADDRESS_NAME 
",
  "address": " IPV4_ADDRESS 
"
  "addressType": "EXTERNAL"
}

For IPv6 addresses, your request body should contain the following fields:
```
{
  "name": " ADDRESS_NAME 
",
  "address": " IPV6_ADDRESS 
"
  "prefixLength": 96
  "addressType": "EXTERNAL"
}
```
Replace the following:
- ADDRESS_NAME : the name that you want to associate with this address
- IPV4_ADDRESS|IPV6_ADDRESS : the IPv4 or IPv6 address that you want to promote
- REGION : the region that the IPv4 or IPv6 address belongs to
- PROJECT_ID : the project ID for this request

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 computepb 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
  
 "google.golang.org/protobuf/proto" 
 ) 
 // promoteEphemeralAddress promotes an ephemeral IP address to a reserved static external IP address. 
 func 
  
 promoteEphemeralAddress 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 region 
 , 
  
 ephemeralIP 
 , 
  
 addressName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // region := "europe-central2" 
  
 // ephemeral_ip := "214.123.100.121" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 addressResource 
  
 := 
  
& computepb 
 . 
 Address 
 { 
  
 Name 
 : 
  
 proto 
 . 
 String 
 ( 
 addressName 
 ), 
  
 AddressType 
 : 
  
 proto 
 . 
 String 
 ( 
 "EXTERNAL" 
 ), 
  
 Address 
 : 
  
 proto 
 . 
 String 
 ( 
 ephemeralIP 
 ), 
  
 } 
  
 req 
  
 := 
  
& computepb 
 . 
 InsertAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Region 
 : 
  
 region 
 , 
  
 AddressResource 
 : 
  
 addressResource 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 client 
 . 
 Insert 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "failed to insert address promoted: %v" 
 , 
  
 err 
 ) 
  
 } 
  
 // Wait for the operation to complete 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "failed to complete promotion operation: %v" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Ephemeral IP %s address promoted successfully" 
 , 
  
 ephemeralIP 
 ) 
  
 return 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. Address 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Address 
. AddressType 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. AddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. InsertAddressRequest 
 
 ; 
 import 
  
 com.google.common.collect.Lists 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.List 
 ; 
 import 
  
 java.util.UUID 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 PromoteEphemeralIp 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // Project ID or project number of the Google Cloud project you want to use. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 // Region where the VM and IP is located. 
  
 String 
  
 region 
  
 = 
  
 "your-region-id" 
 ; 
  
 // Ephemeral IP address to promote. 
  
 String 
  
 ephemeralIp 
  
 = 
  
 "your-ephemeralIp" 
 ; 
  
 // Name of the address to assign. 
  
 String 
  
 addressName 
  
 = 
  
 "your-addressName" 
 ; 
  
 promoteEphemeralIp 
 ( 
 projectId 
 , 
  
 region 
 , 
  
 ephemeralIp 
 , 
  
 addressName 
 ); 
  
 } 
  
 // Promote ephemeral IP found on the instance to a static IP. 
  
 public 
  
 static 
  
 List<Address> 
  
 promoteEphemeralIp 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 region 
 , 
  
 String 
  
 ephemeralIp 
 , 
  
 String 
  
 addressName 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  AddressesClient 
 
  
 client 
  
 = 
  
  AddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  Address 
 
  
 addressResource 
  
 = 
  
  Address 
 
 . 
 newBuilder 
 () 
  
 . 
 setName 
 ( 
 addressName 
 ) 
  
 . 
 setRegion 
 ( 
 region 
 ) 
  
 . 
  setAddressType 
 
 ( 
  AddressType 
 
 . 
 EXTERNAL 
 . 
 name 
 ()) 
  
 . 
 setAddress 
 ( 
 ephemeralIp 
 ) 
  
 . 
 build 
 (); 
  
  InsertAddressRequest 
 
  
 addressRequest 
  
 = 
  
  InsertAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setRegion 
 ( 
 region 
 ) 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setAddressResource 
 ( 
 addressResource 
 ) 
  
 . 
 setRequestId 
 ( 
 UUID 
 . 
 randomUUID 
 (). 
 toString 
 ()) 
  
 . 
 build 
 (); 
  
 client 
 . 
 insertCallable 
 (). 
 futureCall 
 ( 
 addressRequest 
 ). 
 get 
 ( 
 30 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 return 
  
 Lists 
 . 
 newArrayList 
 ( 
 client 
 . 
 list 
 ( 
 projectId 
 , 
  
 region 
 ). 
 iterateAll 
 ()); 
  
 } 
  
 } 
 }

Python

  import 
  
 uuid 
 from 
  
 google.cloud.compute_v1 
  
 import 
  AddressesClient 
 
 from 
  
 google.cloud.compute_v1.types 
  
 import 
  Address 
 
 def 
  
 promote_ephemeral_ip 
 ( 
 project_id 
 : 
 str 
 , 
 ephemeral_ip 
 : 
 str 
 , 
 region 
 : 
 str 
 ): 
  
 """ 
 Promote ephemeral IP found on the instance to a static IP. 
 Args: 
 project_id (str): Project ID. 
 ephemeral_ip (str): Ephemeral IP address to promote. 
 region (str): Region where the VM and IP is located. 
 """ 
 addresses_client 
 = 
 AddressesClient 
 () 
 # Create a new static IP address using existing ephemeral IP 
 address_resource 
 = 
 Address 
 ( 
 name 
 = 
 f 
 "ip-reserved- 
 { 
 uuid 
 . 
 uuid4 
 () 
 } 
 " 
 , 
 # new name for promoted IP address 
 region 
 = 
 region 
 , 
 address_type 
 = 
 "EXTERNAL" 
 , 
 address 
 = 
 ephemeral_ip 
 , 
 ) 
 operation 
 = 
 addresses_client 
 . 
  insert 
 
 ( 
 project 
 = 
 project_id 
 , 
 region 
 = 
 region 
 , 
 address_resource 
 = 
 address_resource 
 ) 
 operation 
 . 
 result 
 () 
 print 
 ( 
 f 
 "Ephemeral IP 
 { 
 ephemeral_ip 
 } 
 has been promoted to a static IP." 
 )

The external IP address remains attached to the VM even after it has been promoted to a static external IP address. If you need to assign the newly promoted static external IP address to another resource, unassign the static external IP address from the existing VM.

List static external IP addresses

To list static external IP addresses that you have reserved for your project, follow these steps.

Console

In the Google Cloud console, go to the IP addressespage.

Go to IP addresses
Click External IP addresses.

gcloud

Use the gcloud compute addresses list command :

To list all IP addresses, use the following command:
```
gcloud compute addresses list
```
To list all global IP addresses, use the following command:
```
gcloud compute addresses list --global
```
To list all regional IP addresses in a given region, use the following command:
```
gcloud compute addresses list \
    --regions= REGION 
```
Replace REGION with the region that you want to list addresses for. You can list addresses of multiple regions by specifying comma-separated region names:
```
gcloud compute addresses list \
    --regions= REGION1 
, REGION2 
, ..REGION_n_ 
```

API

To list regional IPv4 or IPv6 addresses, call the addresses.list method :
```
GET https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/addresses
```
Replace the following:
- PROJECT_ID : the project ID for this request
- REGION : the name of the region for this request

To list all addresses in all regions, call the addresses.aggregatedList method :

GET https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/aggregated/addresses

To list global IPv4 or IPv6 addresses, call the globalAddresses.list method :
```
GET https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/addresses
```
Replace the following:

PROJECT_ID : the project ID for this request

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 "google.golang.org/api/iterator" 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
 ) 
 // listRegionalExternal retrieves list external IP addresses in Google Cloud Platform region. 
 func 
  
 listRegionalExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 region 
  
 string 
 ) 
  
 ([] 
 * 
 computepb 
 . 
 Address 
 , 
  
 error 
 ) 
  
 { 
  
 // projectID := "your_project_id" 
  
 // region := "europe-west3" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 // Create the service client. 
  
 addressesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 err 
  
 } 
  
 defer 
  
 addressesClient 
 . 
 Close 
 () 
  
 // Build the request. 
  
 req 
  
 := 
  
& computepb 
 . 
 ListAddressesRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Region 
 : 
  
 region 
 , 
  
 } 
  
 // List the addresses. 
  
 it 
  
 := 
  
 addressesClient 
 . 
 List 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 // Iterate over the results. 
  
 var 
  
 addresses 
  
 [] 
 * 
 computepb 
 . 
 Address 
  
 for 
  
 { 
  
 address 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
  Done 
 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 err 
  
 } 
  
 addresses 
  
 = 
  
 append 
 ( 
 addresses 
 , 
  
 address 
 ) 
  
 } 
  
 // Print the addresses. 
  
 fmt 
 . 
 Fprint 
 ( 
 w 
 , 
  
 "Fetched addresses: \n" 
 ) 
  
 for 
  
 _ 
 , 
  
 address 
  
 := 
  
 range 
  
 addresses 
  
 { 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "%s\n" 
 , 
  
 * 
 address 
 . 
  Name 
 
 ) 
  
 } 
  
 return 
  
 addresses 
 , 
  
 nil 
 } 
 // listGlobalExternal retrieves list external global IP addresses in Google Cloud Platform. 
 func 
  
 listGlobalExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
  
 string 
 ) 
  
 ([] 
 * 
 computepb 
 . 
 Address 
 , 
  
 error 
 ) 
  
 { 
  
 // projectID := "your_project_id" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 // Create the service client. 
  
 addressesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewGlobalAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 err 
  
 } 
  
 defer 
  
 addressesClient 
 . 
 Close 
 () 
  
 // Build the request. 
  
 req 
  
 := 
  
& computepb 
 . 
 ListGlobalAddressesRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 } 
  
 // List the addresses. 
  
 it 
  
 := 
  
 addressesClient 
 . 
 List 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 // Iterate over the results. 
  
 var 
  
 addresses 
  
 [] 
 * 
 computepb 
 . 
 Address 
  
 for 
  
 { 
  
 address 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
  Done 
 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 err 
  
 } 
  
 addresses 
  
 = 
  
 append 
 ( 
 addresses 
 , 
  
 address 
 ) 
  
 } 
  
 // Print the addresses. 
  
 fmt 
 . 
 Fprint 
 ( 
 w 
 , 
  
 "Fetched addresses: \n" 
 ) 
  
 for 
  
 _ 
 , 
  
 address 
  
 := 
  
 range 
  
 addresses 
  
 { 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "%s\n" 
 , 
  
 * 
 address 
 . 
  Name 
 
 ) 
  
 } 
  
 return 
  
 addresses 
 , 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. Address 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. AddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. GlobalAddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. ListAddressesRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. ListGlobalAddressesRequest 
 
 ; 
 import 
  
 com.google.common.collect.Lists 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.List 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 ListStaticExternalIp 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // Project ID or project number of the Google Cloud project you want to use. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 // Region where the VM and IP is located. 
  
 String 
  
 region 
  
 = 
  
 "your-region-id" 
 ; 
  
 listStaticExternalIp 
 ( 
 projectId 
 , 
  
 region 
 ); 
  
 } 
  
 // Lists all static external IP addresses, either regional or global. 
  
 public 
  
 static 
  
 List<Address> 
  
 listStaticExternalIp 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 region 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Use regional client if a region is specified 
  
 if 
  
 ( 
 region 
  
 != 
  
 null 
 ) 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  AddressesClient 
 
  
 client 
  
 = 
  
  AddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  ListAddressesRequest 
 
  
 request 
  
 = 
  
  ListAddressesRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setRegion 
 ( 
 region 
 ) 
  
 . 
 build 
 (); 
  
 return 
  
 Lists 
 . 
 newArrayList 
 ( 
 client 
 . 
 list 
 ( 
 request 
 ). 
 iterateAll 
 ()); 
  
 } 
  
 } 
  
 else 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  GlobalAddressesClient 
 
  
 client 
  
 = 
  
  GlobalAddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  ListGlobalAddressesRequest 
 
  
 request 
  
 = 
  
  ListGlobalAddressesRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 build 
 (); 
  
 return 
  
 Lists 
 . 
 newArrayList 
 ( 
 client 
 . 
 list 
 ( 
 request 
 ). 
 iterateAll 
 ()); 
  
 } 
  
 } 
  
 } 
 }

Python

  from 
  
 typing 
  
 import 
 List 
 , 
 Optional 
 from 
  
 google.cloud.compute_v1.services.addresses.client 
  
 import 
 AddressesClient 
 from 
  
 google.cloud.compute_v1.services.global_addresses 
  
 import 
 GlobalAddressesClient 
 from 
  
 google.cloud.compute_v1.types 
  
 import 
 Address 
 def 
  
 list_static_ip_addresses 
 ( 
 project_id 
 : 
 str 
 , 
 region 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 ) 
 - 
> List 
 [ 
 Address 
 ]: 
  
 """ 
 Lists all static external IP addresses, either regional or global. 
 Args: 
 project_id (str): project ID. 
 region (Optional[str]): The region of the IP addresses if regional. None if global. 
 Returns: 
 List[Address]: A list of Address objects containing details about the requested IPs. 
 """ 
 if 
 region 
 : 
 # Use regional client if a region is specified 
 client 
 = 
 AddressesClient 
 () 
 addresses_iterator 
 = 
 client 
 . 
 list 
 ( 
 project 
 = 
 project_id 
 , 
 region 
 = 
 region 
 ) 
 else 
 : 
 # Use global client if no region is specified 
 client 
 = 
 GlobalAddressesClient 
 () 
 addresses_iterator 
 = 
 client 
 . 
 list 
 ( 
 project 
 = 
 project_id 
 ) 
 return 
 list 
 ( 
 addresses_iterator 
 ) 
 # Convert the iterator to a list to return

Describe a static external IP address

To get information about a static external IP address, follow these steps.

Console

In the Google Cloud console, go to the IP addressespage.

Go to IP addresses
Click External IP addresses.
Click the IP address that you want to get more information about.

gcloud

Use the gcloud compute addresses describe command . Replace ADDRESS_NAME with the name of the external IP address that you want to describe.

For a global IPv4 or IPv6 address, use the following command:
```
gcloud compute addresses describe ADDRESS_NAME 
--global
```

For a regional IPv4 or IPv6 address, use the following command:

gcloud compute addresses describe ADDRESS_NAME 
--region= REGION

API

To describe a regional IPv4 or IPv6 address, call the addresses.get method :
```
GET https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/addresses/ ADDRESS_NAME 
```
Replace the following:
- PROJECT_ID : the project ID for the request
- REGION : the name of the region for the request
- ADDRESS_NAME : the name of the IP address
To describe a global IPv4 or IPv6 address, call the globalAddresses.get method :
```
GET https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/addresses/ ADDRESS_NAME 
```
Replace the following:
- PROJECT_ID : the project ID for the request
- ADDRESS_NAME : the name of the IP address

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
 ) 
 // getExternalAddress retrieves the external IP address of the given address. 
 func 
  
 getRegionalExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 region 
 , 
  
 addressName 
  
 string 
 ) 
  
 ( 
 * 
 computepb 
 . 
 Address 
 , 
  
 error 
 ) 
  
 { 
  
 // projectID := "your_project_id" 
  
 // region := "europe-west3" 
  
 // addressName := "your_address_name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 addressesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 addressesClient 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 GetAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Region 
 : 
  
 region 
 , 
  
 Address 
 : 
  
 addressName 
 , 
  
 } 
  
 address 
 , 
  
 err 
  
 := 
  
 addressesClient 
 . 
 Get 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to get address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Regional address %s has external IP address: %s\n" 
 , 
  
 addressName 
 , 
  
 address 
 . 
 GetAddress 
 ()) 
  
 return 
  
 address 
 , 
  
 nil 
 } 
 func 
  
 getGlobalExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 addressName 
  
 string 
 ) 
  
 ( 
 * 
 computepb 
 . 
 Address 
 , 
  
 error 
 ) 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 globalAddressesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewGlobalAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewGlobalAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 globalAddressesClient 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 GetGlobalAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Address 
 : 
  
 addressName 
 , 
  
 } 
  
 address 
 , 
  
 err 
  
 := 
  
 globalAddressesClient 
 . 
 Get 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 nil 
 , 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to get address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Global address %s has external IP address: %s\n" 
 , 
  
 addressName 
 , 
  
 address 
 . 
 GetAddress 
 ()) 
  
 return 
  
 address 
 , 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. Address 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. AddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. GetAddressRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. GetGlobalAddressRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. GlobalAddressesClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 GetStaticIpAddress 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // Project ID or project number of the Google Cloud project you want to use. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 // Region where the VM and IP is located. 
  
 String 
  
 region 
  
 = 
  
 "your-region-id" 
 ; 
  
 // Name of the address to assign. 
  
 String 
  
 addressName 
  
 = 
  
 "your-addressName" 
 ; 
  
 getStaticIpAddress 
 ( 
 projectId 
 , 
  
 region 
 , 
  
 addressName 
 ); 
  
 } 
  
 // Retrieves a static external IP address, either regional or global. 
  
 public 
  
 static 
  
  Address 
 
  
 getStaticIpAddress 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 region 
 , 
  
 String 
  
 addressName 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 // Use regional client if a region is specified 
  
 if 
  
 ( 
 region 
  
 != 
  
 null 
 ) 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  AddressesClient 
 
  
 client 
  
 = 
  
  AddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  GetAddressRequest 
 
  
 request 
  
 = 
  
  GetAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setRegion 
 ( 
 region 
 ) 
  
 . 
 setAddress 
 ( 
 addressName 
 ) 
  
 . 
 build 
 (); 
  
 return 
  
 client 
 . 
 get 
 ( 
 request 
 ); 
  
 } 
  
 } 
  
 else 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  GlobalAddressesClient 
 
  
 client 
  
 = 
  
  GlobalAddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  GetGlobalAddressRequest 
 
  
 request 
  
 = 
  
  GetGlobalAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setAddress 
 ( 
 addressName 
 ) 
  
 . 
 build 
 (); 
  
 return 
  
 client 
 . 
 get 
 ( 
 request 
 ); 
  
 } 
  
 } 
  
 } 
 }

Python

  from 
  
 typing 
  
 import 
 Optional 
 from 
  
 google.cloud.compute_v1.services.addresses.client 
  
 import 
 AddressesClient 
 from 
  
 google.cloud.compute_v1.services.global_addresses 
  
 import 
 GlobalAddressesClient 
 from 
  
 google.cloud.compute_v1.types 
  
 import 
 Address 
 def 
  
 get_static_ip_address 
 ( 
 project_id 
 : 
 str 
 , 
 address_name 
 : 
 str 
 , 
 region 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 ) 
 - 
> Address 
 : 
  
 """ 
 Retrieves a static external IP address, either regional or global. 
 Args: 
 project_id (str): project ID. 
 address_name (str): The name of the IP address. 
 region (Optional[str]): The region of the IP address if it's regional. None if it's global. 
 Raises: google.api_core.exceptions.NotFound: in case of address not found 
 Returns: 
 Address: The Address object containing details about the requested IP. 
 """ 
 if 
 region 
 : 
 # Use regional client if a region is specified 
 client 
 = 
 AddressesClient 
 () 
 address 
 = 
 client 
 . 
 get 
 ( 
 project 
 = 
 project_id 
 , 
 region 
 = 
 region 
 , 
 address 
 = 
 address_name 
 ) 
 else 
 : 
 # Use global client if no region is specified 
 client 
 = 
 GlobalAddressesClient 
 () 
 address 
 = 
 client 
 . 
 get 
 ( 
 project 
 = 
 project_id 
 , 
 address 
 = 
 address_name 
 ) 
 return 
 address

Release a static external IP address

If you no longer need a static external IPv4 or IPv6 address, you can release the IP address by deleting the IP address resource.

If you are using the Google Cloud console, you can release a static IP address only if it is not being used by another resource.

If you're using the gcloud CLI or API, you can release an IP address whether or not it's being used by another resource.

If the IP address is not being used by a resource, the IP address is returned to the pool of available external IP addresses.
If the IP address is being used by a resource, it remains attached to the resource until the resource is deleted.

Console

In the Google Cloud console, go to the IP addressespage.

Go to IP addresses
Click External IP addresses.
Optional: In the Filterfield, enter static and then select Static : Typefrom the drop-down list.
Select the static external IP address that you want to release.
Click Release static address.

If you don't see this option, click the More actionsmenu ( ) in the top menu bar, and then select Release static addressfrom the list.

gcloud

Use the compute addresses delete command :

gcloud compute addresses delete ADDRESS_NAME

Replace ADDRESS_NAME with the name of the IPv4 or IPv6 address to release.

API

To release a regional IPv4 or IPv6 address, call the addresses.delete method :
```
DELETE https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/regions/ REGION 
/addresses/ ADDRESS_NAME 
```
Replace the following:
- PROJECT_ID : the project ID for this request
- REGION : the name of the region for this request
- ADDRESS_NAME : the name of the IP address
To release a global IPv4 or IPv6 address, call the globalAddresses.delete method :
```
DELETE https://compute.googleapis.com/compute/v1/projects/ PROJECT_ID 
/global/addresses/ ADDRESS_NAME 
```
Replace the following:
- ADDRESS_NAME : the name of the IP address
- PROJECT_ID : the project ID for this request

Go

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 compute 
  
 "cloud.google.com/go/compute/apiv1" 
  
 "cloud.google.com/go/compute/apiv1/computepb" 
 ) 
 // releaseRegionalStaticExternal releases a static regional external IP address. 
 func 
  
 releaseRegionalStaticExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 region 
 , 
  
 addressName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // region := "us-central1" 
  
 // addressName := "your_address_name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 addressesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 addressesClient 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 DeleteAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Region 
 : 
  
 region 
 , 
  
 Address 
 : 
  
 addressName 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 addressesClient 
 . 
 Delete 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to release static external IP address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 if 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to wait for the operation: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Static external IP address released\n" 
 ) 
  
 return 
  
 nil 
 } 
 // releaseGlobalStaticExternal releases a static global external IP address. 
 func 
  
 releaseGlobalStaticExternal 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 addressName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "your_project_id" 
  
 // addressName := "your_address_name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 addressesClient 
 , 
  
 err 
  
 := 
  
 compute 
 . 
  NewGlobalAddressesRESTClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "NewGlobalAddressesRESTClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 addressesClient 
 . 
 Close 
 () 
  
 req 
  
 := 
  
& computepb 
 . 
 DeleteGlobalAddressRequest 
 { 
  
 Project 
 : 
  
 projectID 
 , 
  
 Address 
 : 
  
 addressName 
 , 
  
 } 
  
 op 
 , 
  
 err 
  
 := 
  
 addressesClient 
 . 
 Delete 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to release static external IP address: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 if 
  
 err 
  
 = 
  
 op 
 . 
 Wait 
 ( 
 ctx 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "unable to wait for the operation: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Static external IP address released\n" 
 ) 
  
 return 
  
 nil 
 }

Java

  import 
  
 com.google.cloud.compute.v1. AddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. DeleteAddressRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. DeleteGlobalAddressRequest 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. GlobalAddressesClient 
 
 ; 
 import 
  
 com.google.cloud.compute.v1. Operation 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 import 
  
 java.util.concurrent.ExecutionException 
 ; 
 import 
  
 java.util.concurrent.TimeUnit 
 ; 
 import 
  
 java.util.concurrent.TimeoutException 
 ; 
 public 
  
 class 
 ReleaseStaticAddress 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 // Project ID or project number of the Google Cloud project you want to use. 
  
 String 
  
 projectId 
  
 = 
  
 "your-project-id" 
 ; 
  
 // The region to reserve the IP address in, if regional. Must be None if global 
  
 String 
  
 region 
  
 = 
  
 "your-region =" 
 ; 
  
 // Name of the address to release. 
  
 String 
  
 addressName 
  
 = 
  
 "your-addressName" 
 ; 
  
 releaseStaticAddress 
 ( 
 projectId 
 , 
  
 addressName 
 , 
  
 region 
 ); 
  
 } 
  
 // Releases a static external IP address that is currently reserved. 
  
 // This action requires that the address is not being used by any forwarding rule. 
  
 public 
  
 static 
  
 void 
  
 releaseStaticAddress 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 addressName 
 , 
  
 String 
  
 region 
 ) 
  
 throws 
  
 IOException 
 , 
  
 ExecutionException 
 , 
  
 InterruptedException 
 , 
  
 TimeoutException 
  
 { 
  
  Operation 
 
  
 operation 
 ; 
  
 // Use global client if no region is specified 
  
 if 
  
 ( 
 region 
  
 == 
  
 null 
 ) 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  GlobalAddressesClient 
 
  
 client 
  
 = 
  
  GlobalAddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  DeleteGlobalAddressRequest 
 
  
 request 
  
 = 
  
  DeleteGlobalAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setAddress 
 ( 
 addressName 
 ) 
  
 . 
 build 
 (); 
  
 operation 
  
 = 
  
 client 
 . 
 deleteCallable 
 (). 
 futureCall 
 ( 
 request 
 ). 
 get 
 ( 
 30 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 } 
  
 } 
  
 else 
  
 { 
  
 // Initialize client that will be used to send requests. This client only needs to be created 
  
 // once, and can be reused for multiple requests. 
  
 try 
  
 ( 
  AddressesClient 
 
  
 client 
  
 = 
  
  AddressesClient 
 
 . 
 create 
 ()) 
  
 { 
  
  DeleteAddressRequest 
 
  
 request 
  
 = 
  
  DeleteAddressRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setProject 
 ( 
 projectId 
 ) 
  
 . 
 setRegion 
 ( 
 region 
 ) 
  
 . 
 setAddress 
 ( 
 addressName 
 ) 
  
 . 
 build 
 (); 
  
 operation 
  
 = 
  
 client 
 . 
 deleteCallable 
 (). 
 futureCall 
 ( 
 request 
 ). 
 get 
 ( 
 30 
 , 
  
 TimeUnit 
 . 
 SECONDS 
 ); 
  
 } 
  
 } 
  
 if 
  
 ( 
 operation 
 . 
  hasError 
 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Can't release external IP address '%s'. Caused by : %s" 
 , 
  
 addressName 
 , 
  
 operation 
 . 
  getError 
 
 ()); 
  
 } 
  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "External IP address '%s' released successfully." 
 , 
  
 addressName 
 ); 
  
 } 
 }

Python

  from 
  
 typing 
  
 import 
 Optional 
 from 
  
 google.cloud.compute_v1.services.addresses.client 
  
 import 
 AddressesClient 
 from 
  
 google.cloud.compute_v1.services.global_addresses 
  
 import 
 GlobalAddressesClient 
 def 
  
 release_external_ip_address 
 ( 
 project_id 
 : 
 str 
 , 
 address_name 
 : 
 str 
 , 
 region 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ) 
 - 
> None 
 : 
  
 """ 
 Releases a static external IP address that is currently reserved. 
 This action requires that the address is not being used by any forwarding rule. 
 Args: 
 project_id (str): project ID. 
 address_name (str): name of the address to release. 
 region (Optional[str]): The region to reserve the IP address in, if regional. Must be None if global. 
 """ 
 if 
 not 
 region 
 : 
 # global IP address 
 client 
 = 
 GlobalAddressesClient 
 () 
 operation 
 = 
 client 
 . 
 delete 
 ( 
 project 
 = 
 project_id 
 , 
 address 
 = 
 address_name 
 ) 
 else 
 : 
 # regional IP address 
 client 
 = 
 AddressesClient 
 () 
 operation 
 = 
 client 
 . 
 delete 
 ( 
 project 
 = 
 project_id 
 , 
 region 
 = 
 region 
 , 
 address 
 = 
 address_name 
 ) 
 operation 
 . 
 result 
 () 
 print 
 ( 
 f 
 "External IP address ' 
 { 
 address_name 
 } 
 ' released successfully." 
 )

What's next

Learn how to Configure static external IP addresses for a new or existing VM.
Learn about IP address specifications for forwarding rules, and how to use forwarding rules , in the Forwarding rules overview .
Learn more about IP addresses .