GOgoogle
publicAdvertisedPrefixes

GET /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}

Changed on

Returns the specified PublicAdvertisedPrefix resource.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/compute.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute.readonly

Path parameters

projectstring required

Project ID for this request.

publicAdvertisedPrefixstring required

Name of the PublicAdvertisedPrefix resource to return.

Response

Successful response

byoipApiVersion'V1' | 'V2'

Output only. [Output Only] The version of BYOIP API.

creationTimestampstring

Output only. [Output Only] Creation timestamp inRFC3339 text format.

descriptionstring

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

dnsVerificationIpstring

The address to be used for reverse DNS verification.

fingerprintstring byte

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 thePublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet.

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

idstring uint64

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

ipCidrRangestring

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

ipv6AccessType'EXTERNAL' | 'INTERNAL'

The internet access type for IPv6 Public Advertised Prefixes.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.

namestring

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

pdpScope'GLOBAL' | 'GLOBAL_AND_REGIONAL' | 'REGIONAL'

Specifies how child public delegated prefix will be scoped. It could be one of following values:

 - `REGIONAL`: The public delegated prefix is regional only. The
 provisioning will take a few minutes.
 - `GLOBAL`: The public delegated prefix is global only. The
 provisioning will take ~4 weeks.
 - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is
  BYOIP V1 legacy prefix. This is output only value and no longer
  supported in BYOIP V2.
selfLinkstring

Output only. [Output Only] Server-defined URL for the resource.

sharedSecretstring

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

status'ANNOUNCED_TO_INTERNET' | 'INITIAL' | 'PREFIX_CONFIGURATION_COMPLETE' | 'PREFIX_CONFIGURATION_IN_PROGRESS' | 'PREFIX_REMOVAL_IN_PROGRESS' | 'PTR_CONFIGURED' | 'READY_TO_ANNOUNCE' | 'REVERSE_DNS_LOOKUP_FAILED' | 'VALIDATED'

The status of the public advertised prefix. Possible values include:

 - `INITIAL`: RPKI validation is complete.
 - `PTR_CONFIGURED`: User has configured the PTR.
 - `VALIDATED`: Reverse DNS lookup is successful.
 - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.
 - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being
 configured.
 - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.
 - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.

Changes

  • 8b85e897d3dcRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c

  • 48929bf89eebRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute.readonly was removed from the endpoint's security scheme Oauth2c