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 |
Project ID for this request. |
resourceId |
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 |
[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 |
labels |
Labels to apply to this Address resource. These can be later modified by the An object containing a list of |
labelFingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
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 |
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.