Skip to main content

public_advertised_prefixes

Creates, updates, deletes, gets or lists a public_advertised_prefixes resource.

Overview​

Namepublic_advertised_prefixes
TypeResource
Idgoogle.compute.public_advertised_prefixes

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
namestringName 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
byoipApiVersionstringOutput only. [Output Only] The version of BYOIP API. (V1, V2)
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
dnsVerificationIpstringThe 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.
ipCidrRangestringThe address range, in CIDR format, represented by this public advertised prefix.
ipv6AccessTypestringThe internet access type for IPv6 Public Advertised Prefixes. (EXTERNAL, INTERNAL)
kindstringOutput only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes. (default: compute#publicAdvertisedPrefix)
pdpScopestringSpecifies 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. (GLOBAL, GLOBAL_AND_REGIONAL, REGIONAL)
publicDelegatedPrefixsarrayOutput only. [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
selfLinkstringOutput only. [Output Only] Server-defined URL for the resource.
sharedSecretstring[Output Only] The shared secret to be used for reverse DNS verification.
statusstringThe 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. (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)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, publicAdvertisedPrefixReturns the specified PublicAdvertisedPrefix resource.
listselectprojectreturnPartialSuccess, filter, maxResults, pageToken, orderByLists the PublicAdvertisedPrefixes for a project.
insertinsertprojectrequestIdCreates a PublicAdvertisedPrefix in the specified project
using the parameters that are included in the request.
patchupdateproject, publicAdvertisedPrefixrequestIdPatches the specified Router resource with the data included in the
request. This method supportsPATCH
semantics and usesJSON merge
patch format and processing rules.
deletedeleteproject, publicAdvertisedPrefixrequestIdDeletes the specified PublicAdvertisedPrefix
announceexecproject, publicAdvertisedPrefixrequestIdAnnounces the specified PublicAdvertisedPrefix
withdrawexecproject, publicAdvertisedPrefixrequestIdWithdraws the specified PublicAdvertisedPrefix

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
projectstring
publicAdvertisedPrefixstring
filterstring
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean

SELECT examples​

Returns the specified PublicAdvertisedPrefix resource.

SELECT
id,
name,
byoipApiVersion,
creationTimestamp,
description,
dnsVerificationIp,
fingerprint,
ipCidrRange,
ipv6AccessType,
kind,
pdpScope,
publicDelegatedPrefixs,
selfLink,
sharedSecret,
status
FROM google.compute.public_advertised_prefixes
WHERE project = '{{ project }}' -- required
AND publicAdvertisedPrefix = '{{ publicAdvertisedPrefix }}' -- required
;

INSERT examples​

Creates a PublicAdvertisedPrefix in the specified project
using the parameters that are included in the request.

INSERT INTO google.compute.public_advertised_prefixes (
data__sharedSecret,
data__ipv6AccessType,
data__ipCidrRange,
data__fingerprint,
data__dnsVerificationIp,
data__pdpScope,
data__description,
data__name,
data__status,
project,
requestId
)
SELECT 
'{{ sharedSecret }}',
'{{ ipv6AccessType }}',
'{{ ipCidrRange }}',
'{{ fingerprint }}',
'{{ dnsVerificationIp }}',
'{{ pdpScope }}',
'{{ description }}',
'{{ name }}',
'{{ status }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

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

UPDATE google.compute.public_advertised_prefixes
SET 
data__sharedSecret = '{{ sharedSecret }}',
data__ipv6AccessType = '{{ ipv6AccessType }}',
data__ipCidrRange = '{{ ipCidrRange }}',
data__fingerprint = '{{ fingerprint }}',
data__dnsVerificationIp = '{{ dnsVerificationIp }}',
data__pdpScope = '{{ pdpScope }}',
data__description = '{{ description }}',
data__name = '{{ name }}',
data__status = '{{ status }}'
WHERE 
project = '{{ project }}' --required
AND publicAdvertisedPrefix = '{{ publicAdvertisedPrefix }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified PublicAdvertisedPrefix

DELETE FROM google.compute.public_advertised_prefixes
WHERE project = '{{ project }}' --required
AND publicAdvertisedPrefix = '{{ publicAdvertisedPrefix }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods​

Announces the specified PublicAdvertisedPrefix

EXEC google.compute.public_advertised_prefixes.announce 
@project='{{ project }}' --required, 
@publicAdvertisedPrefix='{{ publicAdvertisedPrefix }}' --required, 
@requestId='{{ requestId }}'
;