Get Health
|
|||||
|
|
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool
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 4 input parameters
Name | Format | Description |
---|---|---|
project Required |
STRING |
Project ID for this request |
region Required |
STRING |
Name of the region scoping this request |
targetPool Required |
STRING |
Name of the TargetPool resource to which the queried instance belongs |
instance |
STRING |
The URL for a specific instance |
= Parameter name
= Format
project STRING Required Project ID for this request |
region STRING Required Name of the region scoping this request |
targetPool STRING Required Name of the TargetPool resource to which the queried instance belongs |
instance STRING The URL for a specific instance |
Output
This building block provides 6 output parameters
Name | Format | Description |
---|---|---|
healthStatus[] |
OBJECT |
|
healthStatus[].healthState |
ENUMERATION |
Health state of the instance |
healthStatus[].instance |
STRING |
URL of the instance resource |
healthStatus[].ipAddress |
STRING |
The IP address represented by this resource |
healthStatus[].port |
INTEGER |
The port on the instance |
kind |
STRING |
[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance |
= Parameter name
= Format
healthStatus[] OBJECT |
healthStatus[].healthState ENUMERATION Health state of the instance |
healthStatus[].instance STRING URL of the instance resource |
healthStatus[].ipAddress STRING The IP address represented by this resource |
healthStatus[].port INTEGER The port on the instance |
kind STRING [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance |