REST Resource: addresses

Resource: Address

A reserved address resource.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "address": string,
  "status": enum,
  "region": string,
  "selfLink": string,
  "users": [
    string
  ],
  "ipVersion": enum,
  "addressType": enum,
  "subnetwork": string,
  "kind": string,
}
Fields
id

string (fixed64 format)

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

creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 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. 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.

description

string

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

address

string

The static IP address represented by this resource.

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] URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body.

users[]

string

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

ipVersion

enum

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.

addressType

enum

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

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 GCE_ENDPOINT/DNS_RESOLVER purposes.

kind

string

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

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.

setLabels

Sets the labels on an Address.

testIamPermissions

Returns permissions that a caller has on the specified resource.

Send feedback about...

Compute Engine