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,
"region": string,
"name": string,
"description": string,
"address": string,
"selfLink": string,
"users": [
string
]
}
| Property name | Value | Description | Notes |
|---|---|---|---|
address
|
string
|
The 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.
|
|
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 address resides. | |
selfLink
|
string
|
[Output Only] Server defined URL for the resource. | |
status
|
string
|
[Output Only]
The status of the address. Valid values are
RESERVED
and
IN USE
. A reserved address is currently available to the project and can be used by a resource. An in-use address is currently being used by a resource.
Acceptable values are:
|
|
users[]
|
list
|
[Output Only] List of URLs of the resources currently 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.