List
|
|||||
|
|
Retrieves the list of interconnect locations available to the specified project
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
- View your Google Compute Engine resources
Input
This building block consumes 5 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) |
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 |
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 |
= 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) |
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 |
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 |
Output
This building block provides 29 output parameters
Name | Format | Description |
---|---|---|
id |
STRING |
[Output Only] Unique identifier for the resource; defined by the server |
items[] |
OBJECT |
Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments |
items[].address |
STRING |
[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character |
items[].availabilityZone |
STRING |
[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2" |
items[].city |
STRING |
[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands" |
items[].continent |
ENUMERATION |
[Output Only] Continent for this location, which can take one of the following values:
|
items[].creationTimestamp |
STRING |
[Output Only] Creation timestamp in RFC3339 text format |
items[].description |
STRING |
[Output Only] An optional description of the resource |
items[].facilityProvider |
STRING |
[Output Only] The name of the provider for this facility (e.g., EQUINIX) |
items[].facilityProviderFacilityId |
STRING |
[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1) |
items[].id |
INTEGER |
[Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].kind |
STRING |
[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations |
items[].name |
STRING |
[Output Only] Name of the resource |
items[].peeringdbFacilityId |
STRING |
[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb) |
items[].regionInfos[] |
OBJECT |
Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region |
items[].regionInfos[].expectedRttMs |
INTEGER |
Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region |
items[].regionInfos[].locationPresence |
ENUMERATION |
Identifies the network presence of this location |
items[].regionInfos[].region |
STRING |
URL for the region of this location |
items[].selfLink |
STRING |
[Output Only] Server-defined URL for the resource |
items[].status |
ENUMERATION |
[Output Only] The status of this InterconnectLocation, which can take one of the following values:
|
kind |
STRING |
[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations |
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 an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments |
items[].address STRING [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character |
items[].availabilityZone STRING [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2" |
items[].city STRING [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands" |
items[].continent ENUMERATION [Output Only] Continent for this location, which can take one of the following values:
|
items[].creationTimestamp STRING [Output Only] Creation timestamp in RFC3339 text format |
items[].description STRING [Output Only] An optional description of the resource |
items[].facilityProvider STRING [Output Only] The name of the provider for this facility (e.g., EQUINIX) |
items[].facilityProviderFacilityId STRING [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1) |
items[].id INTEGER [Output Only] The unique identifier for the resource. This identifier is defined by the server |
items[].kind STRING [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations |
items[].name STRING [Output Only] Name of the resource |
items[].peeringdbFacilityId STRING [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb) |
items[].regionInfos[] OBJECT Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region |
items[].regionInfos[].expectedRttMs INTEGER Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region |
items[].regionInfos[].locationPresence ENUMERATION Identifies the network presence of this location |
items[].regionInfos[].region STRING URL for the region of this location |
items[].selfLink STRING [Output Only] Server-defined URL for the resource |
items[].status ENUMERATION [Output Only] The status of this InterconnectLocation, which can take one of the following values:
|
kind STRING [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations |
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 |