Method: googleapis.compute.v1.backendServices.getHealth

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

Arguments

Parameters
backendService

string

Required. Name of the BackendService resource to which the queried instance belongs.
project

string

Required. (No description provided)
body

object (ResourceGroupReference)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of BackendServiceGroupHealth.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- getHealth:
    call: googleapis.compute.v1.backendServices.getHealth
    args:
        backendService: ...
        project: ...
        body:
            group: ...
    result: getHealthResult

JSON

[
  {
    "getHealth": {
      "call": "googleapis.compute.v1.backendServices.getHealth",
      "args": {
        "backendService": "...",
        "project": "...",
        "body": {
          "group": "..."
        }
      },
      "result": "getHealthResult"
    }
  }
]