Returns the specified address resource.
HTTP requestGET https://compute.googleapis.com/compute/v1/projects/{project}/global/addresses/{address}
The URL uses gRPC Transcoding syntax.
Path parameters Parametersproject
string
Project ID for this request.
address
string
Name of the address resource to return.
Request bodyThe request body must be empty.
Response bodyRepresents an IP Address resource.
Google Compute Engine has two IP Address resources:
For more information, see Reserving a static external IP address.
If successful, the response body contains data with the following structure:
JSON representation{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "address": string, "prefixLength": integer, "status": enum, "region": string, "selfLink": string, "users": [ string ], "networkTier": enum, "labels": { string: string, ... }, "labelFingerprint": string, "ipVersion": enum, "addressType": enum, "purpose": enum, "subnetwork": string, "network": string, "ipv6EndpointType": enum }Fields
kind
string
[Output Only] Type of the resource. Always compute#address
for addresses.
id
string (uint64 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])?
. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
description
string
An optional description of this resource. Provide this field when you create the resource.
address
string
The static IP address represented by this resource.
prefixLength
integer
The prefix length if the resource represents an IP range.
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] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.
selfLink
string
[Output Only] Server-defined URL for the resource.
users[]
string
[Output Only] The URLs of the resources that are using this address.
networkTier
enum
This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM
or STANDARD
. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier.
If this field is not specified, it is assumed to be PREMIUM
.
labels
map (key: string, value: string)
Labels for this resource. These can only be added or modified by the setLabels
method. Each label key/value pair must comply with RFC1035. Label values may be empty.
labelFingerprint
string (bytes format)
A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet
.
To see the latest fingerprint, make a get()
request to retrieve an Address.
A base64-encoded string.
ipVersion
enum
The IP version that will be used by this address. Valid options are IPV4
or IPV6
.
addressType
enum
The type of address to reserve, either INTERNAL
or EXTERNAL
. If unspecified, defaults to EXTERNAL
.
purpose
enum
The purpose of this resource, which can be one of the following values:
GCE_ENDPOINT
for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources.DNS_RESOLVER
for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network)VPC_PEERING
for global internal IP addresses used for private services access allocated ranges.NAT_AUTO
for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation.IPSEC_INTERCONNECT
for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect configuration. These addresses are regional resources.SHARED_LOADBALANCER_VIP
for an internal IP address that is assigned to multiple internal forwarding rules.PRIVATE_SERVICE_CONNECT
for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose.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 a GCE_ENDPOINT
or DNS_RESOLVER
purpose.
network
string
The URL of the network in which to reserve the address. This field can only be used with INTERNAL
type with the VPC_PEERING
purpose.
ipv6EndpointType
enum
The endpoint type of this address, which should be VM
or NETLB
. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM PermissionsIn addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.globalAddresses.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4