Method: publicAdvertisedPrefixes.get

Returns the specified PublicAdvertisedPrefix resource.

HTTP request

GET https://compute.googleapis.com/compute/v1/projects/{project}/global/publicAdvertisedPrefixes/{resourceId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.

resourceId

string

Name of the PublicAdvertisedPrefix resource to return.

Request body

The request body must be empty.

Response body

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

A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.

JSON representation
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "selfLink": string,
  "ipCidrRange": string,
  "dnsVerificationIp": string,
  "sharedSecret": string,
  "status": enum,
  "publicDelegatedPrefixs": [
    {
      "name": string,
      "region": string,
      "project": string,
      "status": string,
      "ipRange": string
    }
  ],
  "fingerprint": string,
  "kind": string
}
Fields
id

string (uint64 format)

[Output Only] The unique identifier for the resource type. The server generates this identifier.

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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

description

string

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

ipCidrRange

string

The IPv4 address range, in CIDR format, represented by this public advertised prefix.

dnsVerificationIp

string

The IPv4 address to be used for reverse DNS verification.

sharedSecret

string

[Output Only] The shared secret to be used for reverse DNS verification.

status

enum

The status of the public advertised prefix.

publicDelegatedPrefixs[]

object

[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

publicDelegatedPrefixs[].name

string

The name of the public delegated prefix

publicDelegatedPrefixs[].region

string

The region of the public delegated prefix if it is regional. If absent, the prefix is global.

publicDelegatedPrefixs[].project

string

The project number of the public delegated prefix

publicDelegatedPrefixs[].status

string

The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

publicDelegatedPrefixs[].ipRange

string

The IP address range of the public delegated prefix

fingerprint

string (bytes format)

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.

A base64-encoded string.

kind

string

[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

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 IAM permissions:

  • compute.publicAdvertisedPrefixes.get

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