Console
    Contact Us Start free

    Method: publicAdvertisedPrefixes.list

    Lists the PublicAdvertisedPrefixes for a project.

    HTTP request

    GET https://compute.googleapis.com/compute/v1/projects/{project}/global/publicAdvertisedPrefixes

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    project

    string

    Project ID for this request.

    Query parameters

    Parameters
    maxResults

    integer ( uint32 format)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults , Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500 , inclusive. (Default: 500 )
    pageToken

    string

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    filter

    string

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160 . These two types of filter expressions cannot be mixed in one request.

    If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either = , != , > , < , <= , >= or : .

    For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance .

    The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use:

     labels.owner:*

    You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels .

    To filter on multiple expressions, provide each separate expression within parentheses. For example:

     (scheduling.automaticRestart = true)
(cpuPlatform = "Intel Skylake")

    By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

     (cpuPlatform = "Intel Skylake") OR
(cpuPlatform = "Intel Broadwell") AND
(scheduling.automaticRestart = true)

    If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples:

    fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal")

    The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field.

    For example, to filter for instances that do not end with name "instance", you would use name ne .*instance .

    You cannot combine constraints on multiple fields using regular expressions.
    orderBy

    string

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

    You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc" . This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

    Currently, only sorting by name or creationTimestamp desc is supported.
    returnPartialSuccess

    boolean

    Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

    For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

    Request body

    The request body must be empty.

    Response body

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "items" 
 : 
 [ 
 { 
 "kind" 
 : 
 string 
 , 
 "id" 
 : 
 string 
 , 
 "creationTimestamp" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "ipCidrRange" 
 : 
 string 
 , 
 "dnsVerificationIp" 
 : 
 string 
 , 
 "sharedSecret" 
 : 
 string 
 , 
 "status" 
 : 
 enum 
 , 
 "pdpScope" 
 : 
 enum 
 , 
 "publicDelegatedPrefixs" 
 : 
 [ 
 { 
 "name" 
 : 
 string 
 , 
 "region" 
 : 
 string 
 , 
 "project" 
 : 
 string 
 , 
 "status" 
 : 
 string 
 , 
 "ipRange" 
 : 
 string 
 } 
 ] 
 , 
 "fingerprint" 
 : 
 string 
 , 
 "byoipApiVersion" 
 : 
 enum 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "selfLink" 
 : 
 string 
 , 
 "warning" 
 : 
 { 
 "code" 
 : 
 enum 
 , 
 "message" 
 : 
 string 
 , 
 "data" 
 : 
 [ 
 { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 string 
 } 
 ] 
 } 
 }
    Fields
    kind

    string

    [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

    id

    string

    [Output Only] Unique identifier for the resource; defined by the server.

    items[]

    object

    A list of PublicAdvertisedPrefix resources.

    items[].kind

    string

    [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.

    items[].id

    string ( uint64 format)

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

    items[].creationTimestamp

    string

    [Output Only] Creation timestamp in RFC3339 text format.

    items[].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.

    items[].description

    string

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

    items[].selfLink

    string

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

    items[].ipCidrRange

    string

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

    items[].dnsVerificationIp

    string

    The address to be used for reverse DNS verification.

    items[].sharedSecret

    string

    [Output Only] The shared secret to be used for reverse DNS verification.

    items[].status

    enum

    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.
    items[].pdpScope

    enum

    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.
    items[].publicDelegatedPrefixs[]

    object

    [Output Only] The list of public delegated prefixes that exist for this public advertised prefix.

    items[].publicDelegatedPrefixs[].name

    string

    The name of the public delegated prefix

    items[].publicDelegatedPrefixs[].region

    string

    The region of the public delegated prefix if it is regional. If absent, the prefix is global.

    items[].publicDelegatedPrefixs[].project

    string

    The project number of the public delegated prefix

    items[].publicDelegatedPrefixs[].status

    string

    The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.

    items[].publicDelegatedPrefixs[].ipRange

    string

    The IP address range of the public delegated prefix

    items[].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 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.

    A base64-encoded string.

    items[].byoipApiVersion

    enum

    [Output Only] The version of BYOIP API.

    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.

    warning

    object

    [Output Only] Informational warning message.

    warning.code

    enum

    [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

    warning.message

    string

    [Output Only] A human-readable description of the warning code.

    warning.data[]

    object

    [Output Only] Metadata about this warning in key: value format. For example:

    "data": [  {  "key": "scope",  "value": "zones/us-east1-d"  }
    warning.data[].key

    string

    [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

    warning.data[].value

    string

    [Output Only] A warning data value corresponding to the key.

    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.publicAdvertisedPrefixes.list

    To find predefined roles that contain those permissions, see Compute Engine IAM Roles .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: