Get

Returns the specified address resource

3 variables
17 variables

Returns the specified address resource

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

address STRING Required

Name of the address resource to return

Output

This building block provides 17 output parameters

  = Parameter name
  = Format

address STRING

The static IP address represented by this resource

addressType ENUMERATION

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

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

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

id INTEGER

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

ipVersion ENUMERATION

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

kind STRING

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

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

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

networkTier ENUMERATION

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

prefixLength INTEGER

The prefix length if the resource reprensents an IP range

purpose ENUMERATION

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.

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

status ENUMERATION

[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

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

users[] STRING