Addresses

Represents an Address resource. Addresses are internal or external IPs assigned to an instance and can be either static and ephemeral. Read the IP Addresses documentation for more information.

For a list of methods for this resource, see the end of this page.

Resource representations

A Reserved Address resource.

{
  "kind": "compute#address",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "address": string,
  "status": string,
  "region": string,
  "selfLink": string,
  "users": [
    string
  ],
  "ipVersion": string,
  "addressType": string,
  "subnetwork": string
}
Property name Value Description Notes
address string The static external IP address represented by this resource.
addressType string The type of address to reserve. If unspecified, defaults to EXTERNAL but valid values include INTERNAL and EXTERNAL. Specify INTERNAL to reserve an internal static IP address EXTERNAL to specify an external static IP address.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
id unsigned long [Output Only] The unique identifier for the resource. This identifier is defined by the server.
ipVersion string The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
kind string [Output Only] Type of the resource. Always compute#address for addresses.
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.
region string [Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses.
status string [Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
subnetwork string For external addresses, this field should not be used.

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.
users[] list [Output Only] The URLs of the resources that are using this address.

Methods

The following are valid Address collection methods:

aggregatedList
Retrieves an aggregated list of addresses.
delete
Deletes the specified address resource.
get
Returns the specified address resource.
insert
Creates an address resource in the specified project using the data included in the request.
list
Retrieves a list of addresses contained within the specified region.
testIamPermissions
Returns permissions that a caller has on the specified resource.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Compute Engine