GOgoogle
publicDelegatedPrefixes

GET /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}

Changed on

Returns the specified PublicDelegatedPrefix resource in the given region.

Request

  • Base URL
    https://compute.googleapis.com/compute/v1
  • URL
    https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}
  • 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.

regionstring required

Name of the region of this request.

publicDelegatedPrefixstring required

Name of the PublicDelegatedPrefix resource to return.

Response

Successful response

allocatablePrefixLengthinteger

The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.

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.

enableEnhancedIpv4Allocationboolean

Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs only.

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 PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update thePublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet.

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

idstring uint64

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

ipCidrRangestring

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

ipv6AccessType'EXTERNAL' | 'INTERNAL'

Output only. [Output Only] The internet access type for IPv6 Public Delegated Prefixes. Inherited from parent prefix.

isLiveMigrationboolean

If true, the prefix will be live migrated.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.

mode'DELEGATION' | 'EXTERNAL_IPV6_FORWARDING_RULE_CREATION' | 'EXTERNAL_IPV6_SUBNETWORK_CREATION' | 'INTERNAL_IPV6_SUBNETWORK_CREATION'

The public delegated prefix mode for IPv6 only.

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.

parentPrefixstring

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

regionstring

Output only. [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

selfLinkstring

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

status'ACTIVE' | 'ANNOUNCED' | 'ANNOUNCED_TO_GOOGLE' | 'ANNOUNCED_TO_INTERNET' | 'DELETING' | 'INITIALIZING' | 'READY_TO_ANNOUNCE'

[Output Only] The status of the public delegated prefix, which can be one of following values:

 - `INITIALIZING` The public delegated prefix is being initialized and
 addresses cannot be created yet.
 - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration
 prefix and is active.
 - `ANNOUNCED` The public delegated prefix is announced and ready to
 use.
 - `DELETING` The public delegated prefix is being deprovsioned.
 - `ACTIVE` The public delegated prefix is ready to use.

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