Method: googleapis.compute.v1.targetPools.getHealth

Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.

Arguments

Parameters
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.

body

object (InstanceReference)

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 TargetPoolInstanceHealth.

Subworkflow snippet

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

YAML

- getHealth:
    call: googleapis.compute.v1.targetPools.getHealth
    args:
        project: ...
        region: ...
        targetPool: ...
        body:
            instance: ...
    result: getHealthResult

JSON

[
  {
    "getHealth": {
      "call": "googleapis.compute.v1.targetPools.getHealth",
      "args": {
        "project": "...",
        "region": "...",
        "targetPool": "...",
        "body": {
          "instance": "..."
        }
      },
      "result": "getHealthResult"
    }
  }
]