- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
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 |
Project ID for this request. |
Query parameters
Parameters | |
---|---|
maxResults |
The maximum number of results per page that should be returned. If the number of available results is larger than |
pageToken |
Specifies a page token to use. Set |
filter |
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 For example, if you are filtering Compute Engine instances, you can exclude instances named The
You can also filter nested fields. For example, you could specify To filter on multiple expressions, provide each separate expression within parentheses. For example:
By default, each expression is an
If you want to use a regular expression, use the
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 You cannot combine constraints on multiple fields using regular expressions. |
orderBy |
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 Currently, only sorting by |
returnPartialSuccess |
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 |
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 |
[Output Only] Type of resource. Always |
id |
[Output Only] Unique identifier for the resource; defined by the server. |
items[] |
[Output Only] A list of shared VPC host project URLs. |
items[].kind |
[Output Only] Type of the resource. Always |
items[].id |
[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 |
[Output Only] Creation timestamp in RFC3339 text format. |
items[].name |
The project ID. For example: |
items[].description |
An optional textual description of the resource. |
items[].commonInstanceMetadata |
Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. |
items[].commonInstanceMetadata.kind |
[Output Only] Type of the resource. Always |
items[].commonInstanceMetadata.fingerprint |
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 To see the latest fingerprint, make a A base64-encoded string. |
items[].commonInstanceMetadata.items[] |
Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
items[].commonInstanceMetadata.items[].key |
Key for the metadata entry. Keys must conform to the following regexp: |
items[].commonInstanceMetadata.items[].value |
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[] |
[Output Only] Quotas assigned to this project. |
items[].quotas[].metric |
[Output Only] Name of the quota metric. |
items[].quotas[].limit |
[Output Only] Quota limit for this metric. |
items[].quotas[].usage |
[Output Only] Current usage of this metric. |
items[].quotas[].owner |
[Output Only] Owning resource. This is the resource on which this quota is applied. |
items[].usageExportLocation |
The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. |
items[].usageExportLocation.bucketName |
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 |
items[].usageExportLocation.reportNamePrefix |
An optional prefix for the name of the usage report object stored in |
items[].enabledFeatures[] |
Restricted features enabled for use on this project. |
items[].selfLink |
[Output Only] Server-defined URL for the resource. |
items[].defaultServiceAccount |
[Output Only] Default service account used by VMs running in this project. |
items[].xpnProjectStatus |
[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 |
items[].defaultNetworkTier |
This signifies the default network tier used for configuring resources of the project and can only take the following values: |
items[].vmDnsSetting |
[Output Only] Default internal DNS setting used by VMs running in this project. |
items[].cloudArmorTier |
[Output Only] The Cloud Armor tier for this project. It can be one of the following values: If this field is not specified, it is assumed to be |
nextPageToken |
[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than |
selfLink |
[Output Only] Server-defined URL for this resource. |
warning |
[Output Only] Informational warning message. |
warning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
warning.message |
[Output Only] A human-readable description of the warning code. |
warning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warning.data[].key |
[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 |
warning.data[].value |
[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.