List
|
|||||
|
|
||||
Returns the list of IPs that checkers run from
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 write monitoring data for all of your Google and third-party Cloud and API projects
- View monitoring data for all of your Google Cloud and third-party projects
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
pageToken |
STRING |
If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented |
pageSize |
INTEGER |
The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented |
= Parameter name
= Format
|
pageToken STRING If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented |
|
pageSize INTEGER The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented |
Output
This building block provides 5 output parameters
| Name | Format | Description |
|---|---|---|
uptimeCheckIps[] |
OBJECT |
Contains the region, location, and list of IP addresses where checkers in the location run from |
uptimeCheckIps[].ipAddress |
STRING |
The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format |
uptimeCheckIps[].region |
ENUMERATION |
A broad region category in which the IP address is located |
uptimeCheckIps[].location |
STRING |
A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category |
nextPageToken |
STRING |
This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented |
= Parameter name
= Format
|
uptimeCheckIps[] OBJECT Contains the region, location, and list of IP addresses where checkers in the location run from |
|
uptimeCheckIps[].ipAddress STRING The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format |
|
uptimeCheckIps[].region ENUMERATION A broad region category in which the IP address is located |
|
uptimeCheckIps[].location STRING A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category |
|
nextPageToken STRING This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented |