- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Returns the specified global PublicDelegatedPrefix resource.
HTTP request
GET https://compute.googleapis.com/compute/v1/projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
project
|
Project ID for this request. |
publicDelegatedPrefix
|
Name of the PublicDelegatedPrefix resource to return. |
Request body
The request body must be empty.
Response body
A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "kind" : string , "id" : string , "creationTimestamp" : string , "name" : string , "description" : string , "selfLink" : string , "region" : string , "ipCidrRange" : string , "status" : enum , "parentPrefix" : string , "publicDelegatedSubPrefixs" : [ { "name" : string , "description" : string , "region" : string , "status" : enum , "ipCidrRange" : string , "delegateeProject" : string , "isAddress" : boolean , "mode" : enum , "allocatablePrefixLength" : integer } ] , "isLiveMigration" : boolean , "fingerprint" : string , "mode" : enum , "allocatablePrefixLength" : integer , "byoipApiVersion" : enum } |
kind
string
[Output Only] Type of the resource. Always compute#publicDelegatedPrefix
for public delegated prefixes.
id
string ( uint64
format)
[Output Only] The unique identifier for the resource type. The server generates this identifier.
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.
selfLink
string
[Output Only] Server-defined URL for the resource.
region
string
[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.
ipCidrRange
string
The IP address range, in CIDR format, represented by this public delegated prefix.
status
enum
[Output Only] The status of the public delegated prefix, which can be one of following values:
-
INITIALIZINGThe public delegated prefix is being initialized and addresses cannot be created yet. -
READY_TO_ANNOUNCEThe public delegated prefix is a live migration prefix and is active. -
ANNOUNCEDThe public delegated prefix is announced and ready to use. -
DELETINGThe public delegated prefix is being deprovsioned.
parentPrefix
string
The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.
publicDelegatedSubPrefixs[]
object
The list of sub public delegated prefixes that exist for this public delegated prefix.
publicDelegatedSubPrefixs[].name
string
The name of the sub public delegated prefix.
publicDelegatedSubPrefixs[].description
string
An optional description of this resource. Provide this property when you create the resource.
publicDelegatedSubPrefixs[].region
string
[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.
publicDelegatedSubPrefixs[].status
enum
[Output Only] The status of the sub public delegated prefix.
publicDelegatedSubPrefixs[].ipCidrRange
string
The IP address range, in CIDR format, represented by this sub public delegated prefix.
publicDelegatedSubPrefixs[].delegateeProject
string
Name of the project scoping this PublicDelegatedSubPrefix.
publicDelegatedSubPrefixs[].isAddress
boolean
Whether the sub prefix is delegated to create Address resources in the delegatee project.
publicDelegatedSubPrefixs[].mode
enum
The PublicDelegatedSubPrefix mode for IPv6 only.
publicDelegatedSubPrefixs[].allocatablePrefixLength
integer
The allocatable prefix length supported by this PublicDelegatedSubPrefix.
isLiveMigration
boolean
If true, the prefix will be live migrated.
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 PublicDelegatedPrefix
. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix
, otherwise the request will fail with error 412 conditionNotMet
.
To see the latest fingerprint, make a get()
request to retrieve a PublicDelegatedPrefix.
A base64-encoded string.
mode
enum
The public delegated prefix mode for IPv6 only.
allocatablePrefixLength
integer
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
enum
[Output Only] The version of BYOIP API.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/compute.readonly -
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.globalPublicDelegatedPrefixes.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
