Resource: Address
Represents an IP Address resource.
An address
resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.
A globalAddresses
resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources.
JSON representation | |
---|---|
{ "id": string, "creationTimestamp": string, "name": string, "description": string, "address": string, "prefixLength": number, "status": enum, "region": string, "selfLink": string, "users": [ string ], "networkTier": enum, "ipVersion": enum, "addressType": enum, "purpose": enum, "subnetwork": string, "network": string, "kind": string } |
Fields | |
---|---|
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
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 |
description |
An optional description of this resource. Provide this field when you create the resource. |
address |
The static IP address represented by this resource. |
prefixLength |
The prefix length if the resource reprensents an IP range. |
status |
[Output Only] The status of the address, which can be one of |
region |
[Output Only] The 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. |
selfLink |
[Output Only] Server-defined URL for the resource. |
users[] |
[Output Only] The URLs of the resources that are using this address. |
networkTier |
This signifies the networking tier used for configuring this address and can only take the following values: If this field is not specified, it is assumed to be |
ipVersion |
The IP version that will be used by this address. Valid options are |
addressType |
The type of address to reserve, either |
purpose |
The purpose of this resource, which can be one of the following values:
|
subnetwork |
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 |
network |
The URL of the network in which to reserve the address. This field can only be used with |
kind |
[Output Only] Type of the resource. Always |
Methods |
|
---|---|
|
Deletes the specified address resource. |
|
Returns the specified address resource. |
|
Creates an address resource in the specified project by using the data included in the request. |
|
Retrieves a list of global addresses. |
|
Sets the labels on a GlobalAddress. |
|
Returns permissions that a caller has on the specified resource. |