Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
publicDelegatedPrefixes

Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.

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

Path parameters

projectstring required

Project ID for this request.

regionstring required

Name of the region for this request.

publicDelegatedPrefixstring required

Name of the PublicDelegatedPrefix resource to patch.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

selfLinkstring

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

parentPrefixstring

The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.

byoipApiVersion'V1' | 'V2'

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

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.

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.

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.
ipv6AccessType'EXTERNAL' | 'INTERNAL'

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

enableEnhancedIpv4Allocationboolean

Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations. Applicable for IPv4 PDPs 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.

kindstring

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

creationTimestampstring

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

isLiveMigrationboolean

If true, the prefix will be live migrated.

descriptionstring

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

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.

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.

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

The public delegated prefix mode for IPv6 only.

Response

Successful response