Method: projects.listXpnHosts

Lists all shared VPC host projects visible to the user in an organization.

HTTP request

POST https://compute.googleapis.com/compute/v1/projects/{project}/listXpnHosts

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 contains data with the following structure:

JSON representation 
{
  "organization": string
}
Fields
organization

string

Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.

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,
      "commonInstanceMetadata": {
        "kind": string,
        "fingerprint": string,
        "items": [
          {
            "key": string,
            "value": string
          }
        ]
      },
      "quotas": [
        {
          "metric": enum,
          "limit": number,
          "usage": number,
          "owner": string
        }
      ],
      "usageExportLocation": {
        "bucketName": string,
        "reportNamePrefix": string
      },
      "enabledFeatures": [
        string
      ],
      "selfLink": string,
      "defaultServiceAccount": string,
      "xpnProjectStatus": enum,
      "defaultNetworkTier": enum,
      "vmDnsSetting": enum,
      "cloudArmorTier": enum
    }
  ],
  "nextPageToken": string,
  "selfLink": string,
  "warning": {
    "code": enum,
    "message": string,
    "data": [
      {
        "key": string,
        "value": string
      }
    ]
  }
}
Fields
kind

string

[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.
id

string

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

object

[Output Only] A list of shared VPC host project URLs.
items[].kind

string

[Output Only] Type of the resource. Always compute#project for projects.
items[].id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.
items[].creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
items[].name

string

The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.
items[].description

string

An optional textual description of the resource.
items[].commonInstanceMetadata

object

Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.
items[].commonInstanceMetadata.kind

string

[Output Only] Type of the resource. Always compute#metadata for metadata.
items[].commonInstanceMetadata.fingerprint

string (bytes format)

Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve the resource.

A base64-encoded string.
items[].commonInstanceMetadata.items[]

object

Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
items[].commonInstanceMetadata.items[].key

string

Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
items[].commonInstanceMetadata.items[].value

string

Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
items[].quotas[]

object

[Output Only] Quotas assigned to this project.
items[].quotas[].metric

enum

[Output Only] Name of the quota metric.
items[].quotas[].limit

number

[Output Only] Quota limit for this metric.
items[].quotas[].usage

number

[Output Only] Current usage of this metric.
items[].quotas[].owner

string

[Output Only] Owning resource. This is the resource on which this quota is applied.
items[].usageExportLocation

object

The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.
items[].usageExportLocation.bucketName

string

The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.
items[].usageExportLocation.reportNamePrefix

string

An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.
items[].enabledFeatures[]

string

Restricted features enabled for use on this project.
items[].selfLink

string

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

string

[Output Only] Default service account used by VMs running in this project.
items[].xpnProjectStatus

enum

[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.
items[].defaultNetworkTier

enum

This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.
items[].vmDnsSetting

enum

[Output Only] Default internal DNS setting used by VMs running in this project.
items[].cloudArmorTier

enum

[Output Only] The Cloud Armor tier for this project. It can be one of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO.

If this field is not specified, it is assumed to be CA_STANDARD.
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
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.