public_advertised_prefixes

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

Overview

Name	public_advertised_prefixes
Type	Resource
Id	google.compute.public_advertised_prefixes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[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. (pattern: a-z?)
byoipApiVersion	string	[Output Only] The version of BYOIP API.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
dnsVerificationIp	string	The address to be used for reverse DNS verification.
fingerprint	string (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 the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
ipCidrRange	string	The address range, in CIDR format, represented by this public advertised prefix.
kind	string	[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. (default: compute#publicAdvertisedPrefix)
pdpScope	string	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.
publicDelegatedPrefixs	array	[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
selfLink	string	[Output Only] Server-defined URL for the resource.
sharedSecret	string	[Output Only] The shared secret to be used for reverse DNS verification.
status	string	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.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of PublicAdvertisedPrefix resources.
kind	string	[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. (default: compute#publicAdvertisedPrefixList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, publicAdvertisedPrefix		Returns the specified PublicAdvertisedPrefix resource.
list	select	project	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Lists the PublicAdvertisedPrefixes for a project.
insert	insert	project	requestId	Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.
patch	update	project, publicAdvertisedPrefix	requestId	Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
delete	delete	project, publicAdvertisedPrefix	requestId	Deletes the specified PublicAdvertisedPrefix
announce	exec	project, publicAdvertisedPrefix	requestId	Announces the specified PublicAdvertisedPrefix
withdraw	exec	project, publicAdvertisedPrefix	requestId	Withdraws 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.

Name	Datatype	Description
project	string
publicAdvertisedPrefix	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified PublicAdvertisedPrefix resource.

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

list

Lists the PublicAdvertisedPrefixes for a project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.public_advertised_prefixes
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

insert

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

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

Manifest

# Description fields are for documentation purposes
- name: public_advertised_prefixes
  props:
    - name: project
      value: string
      description: Required parameter for the public_advertised_prefixes resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.
        
      default: compute#publicAdvertisedPrefix
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource type. The server generates this identifier.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: ipCidrRange
      value: string
      description: >
        The address range, in CIDR format, represented by this public advertised prefix.
        
    - name: dnsVerificationIp
      value: string
      description: >
        The address to be used for reverse DNS verification.
        
    - name: sharedSecret
      value: string
      description: >
        [Output Only] The shared secret to be used for reverse DNS verification.
        
    - name: status
      value: string
      description: >
        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. 
        
      valid_values: ['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']
    - name: pdpScope
      value: string
      description: >
        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. 
        
      valid_values: ['GLOBAL', 'GLOBAL_AND_REGIONAL', 'REGIONAL']
    - name: publicDelegatedPrefixs
      value: array
      description: >
        [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.
        
    - name: fingerprint
      value: string
      description: >
        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 the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.
        
    - name: byoipApiVersion
      value: string
      description: >
        [Output Only] The version of BYOIP API.
        
      valid_values: ['V1', 'V2']
    - name: requestId
      value: string

UPDATE examples

patch

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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

DELETE examples

delete

Deletes the specified PublicAdvertisedPrefix

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

Lifecycle Methods

announce

Announces the specified PublicAdvertisedPrefix

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

withdraw

Withdraws the specified PublicAdvertisedPrefix

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