Get Health
|
|||||
|
|
||||
Gets the most recent health check results for this regional BackendService
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 |
|
region Required |
STRING |
Name of the region scoping this request |
backendService Required |
STRING |
Name of the BackendService resource for which to get health |
group |
STRING |
A URI referencing one of the instance groups or network endpoint groups listed in the backend service |
= Parameter name
= Format
|
project STRING Required |
|
region STRING Required Name of the region scoping this request |
|
backendService STRING Required Name of the BackendService resource for which to get health |
|
group STRING A URI referencing one of the instance groups or network endpoint groups listed in the backend service |
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#backendServiceGroupHealth for the health of backend services |
= 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#backendServiceGroupHealth for the health of backend services |