List Xpn Hosts
|
|||||
|
|
Lists all shared VPC host projects visible to the user in an organization
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
Input
This building block consumes 6 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
filter |
STRING |
A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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) |
maxResults |
INTEGER |
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) |
order_by |
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 |
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 |
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 |
= Parameter name
= Format
project STRING Required Project ID for this request |
filter STRING A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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. 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) |
maxResults INTEGER 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) |
order_by 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 |
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 |
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 |
Output
This building block provides 35 output parameters
Name | Format | Description |
---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items[] |
OBJECT |
Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) |
items[].commonInstanceMetadata |
OBJECT |
A metadata key/value entry |
items[].commonInstanceMetadata.fingerprint |
BINARY |
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 |
items[].commonInstanceMetadata.items[] |
OBJECT |
|
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[].commonInstanceMetadata.kind |
STRING |
[Output Only] Type of the resource. Always compute#metadata for metadata |
items[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items[].defaultNetworkTier |
ENUMERATION |
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[].defaultServiceAccount |
STRING |
[Output Only] Default service account used by VMs running in this project |
items[].description |
STRING |
An optional textual description of the resource |
items[].enabledFeatures[] |
STRING |
|
items[].id |
INTEGER |
[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[].kind |
STRING |
[Output Only] Type of the resource. Always compute#project for projects |
items[].name |
STRING |
The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine |
items[].quotas[] |
OBJECT |
A quotas entry |
items[].quotas[].limit |
NUMBER |
[Output Only] Quota limit for this metric |
items[].quotas[].metric |
ENUMERATION |
[Output Only] Name of the quota metric |
items[].quotas[].owner |
STRING |
[Output Only] Owning resource. This is the resource on which this quota is applied |
items[].quotas[].usage |
NUMBER |
[Output Only] Current usage of this metric |
items[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
items[].usageExportLocation |
OBJECT |
The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix |
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. 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[].xpnProjectStatus |
ENUMERATION |
[Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated |
kind |
STRING |
[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts |
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 |
warning.code |
ENUMERATION |
[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.data[] |
OBJECT |
|
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 |
warning.message |
STRING |
[Output Only] A human-readable description of the warning code |
= Parameter name
= Format
id STRING [Output Only] Unique identifier for the resource; defined by the server |
items[] OBJECT Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) |
items[].commonInstanceMetadata OBJECT A metadata key/value entry |
items[].commonInstanceMetadata.fingerprint BINARY 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 |
items[].commonInstanceMetadata.items[] OBJECT |
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[].commonInstanceMetadata.kind STRING [Output Only] Type of the resource. Always compute#metadata for metadata |
items[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
items[].defaultNetworkTier ENUMERATION 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[].defaultServiceAccount STRING [Output Only] Default service account used by VMs running in this project |
items[].description STRING An optional textual description of the resource |
items[].enabledFeatures[] STRING |
items[].id INTEGER [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[].kind STRING [Output Only] Type of the resource. Always compute#project for projects |
items[].name STRING The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine |
items[].quotas[] OBJECT A quotas entry |
items[].quotas[].limit NUMBER [Output Only] Quota limit for this metric |
items[].quotas[].metric ENUMERATION [Output Only] Name of the quota metric |
items[].quotas[].owner STRING [Output Only] Owning resource. This is the resource on which this quota is applied |
items[].quotas[].usage NUMBER [Output Only] Current usage of this metric |
items[].selfLink STRING [Output Only] Server-defined URL for the resource |
items[].usageExportLocation OBJECT The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix |
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. 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[].xpnProjectStatus ENUMERATION [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated |
kind STRING [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts |
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 |
warning.code ENUMERATION [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.data[] OBJECT |
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 |
warning.message STRING [Output Only] A human-readable description of the warning code |