Google Cloud Platform
Hide
Google Compute Engine
Write Feedback

Addresses

Represents an Address resource. See Reserved 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,
  "status": string,
  "name": string,
  "description": string,
  "address": string,
  "region": string,
  "selfLink": string,
  "users": [
    string
  ]
}
Property name Value Description Notes
address string The static external IP address represented by this resource.
creationTimestamp string [Output Only] Creation timestamp in RFC3339 text format.
description string An optional textual description of the resource; provided by the client when the resource is created.
id unsigned long [Output Only] Unique identifier for the resource; defined by the server.
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.
users[] list [Output Only] The URLs of the resources that are using this address.

Methods

The following are valid Address collection methods:

aggregatedList
Retrieves the list of addresses grouped by scope.
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 the list of address resources contained within the specified region.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.