Method: globalAddresses.get

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization Scopes
• IAM Permissions

Returns the specified address resource. Gets a list of available addresses by making a list() request.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/addresses/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project	string Project ID for this request.
resourceId	string Name of the address resource to return.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation

{ "id": string, "creationTimestamp": string, "name": string, "description": string, "address": string, "prefixLength": number, "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, "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])?. 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	number The prefix length if the resource reprensents 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 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	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. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer. If this field is not specified, it is assumed to be PREMIUM.
labels	map (key: string, value: string) Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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. 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.
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, internal load balancers, and similar resources. DNS_RESOLVER for a DNS resolver address in a subnetwork VPC_PEERING for addresses that are reserved for VPC peer networks. NAT_AUTO for addresses that are external IP addresses automatically reserved for Cloud NAT.
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.
kind	string [Output Only] Type of the resource. Always compute#address for addresses.

Authorization Scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/compute
• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following Google IAM permissions:

• compute.globalAddresses.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.