DESCRIBETARGETHEALTH()`¶

About DescribeTargetHealth¶

Describes the health of the specified targets or all of your targets.

Method Signature¶

METHODS /AWS1/IF_EL2~DESCRIBETARGETHEALTH
  IMPORTING
    !IV_TARGETGROUPARN TYPE /AWS1/EL2TARGETGROUPARN OPTIONAL
    !IT_TARGETS TYPE /AWS1/CL_EL2TARGETDESCRIPTION=>TT_TARGETDESCRIPTIONS OPTIONAL
    !IT_INCLUDE TYPE /AWS1/CL_EL2LSTOFDSCTGTHEALT00=>TT_LSTOFDESCRTGTHEALTHINCLOPTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_el2descrtgthealthout
  RAISING
    /AWS1/CX_EL2HEALTHUNAVAILEX
    /AWS1/CX_EL2INVALIDTARGETEX
    /AWS1/CX_EL2TGTGROUPNOTFOUNDEX
    /AWS1/CX_EL2CLIENTEXC
    /AWS1/CX_EL2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_targetgrouparn` `TYPE /AWS1/EL2TARGETGROUPARN` `/AWS1/EL2TARGETGROUPARN`¶

The Amazon Resource Name (ARN) of the target group.

Optional arguments:¶

`it_targets` `TYPE /AWS1/CL_EL2TARGETDESCRIPTION=>TT_TARGETDESCRIPTIONS` `TT_TARGETDESCRIPTIONS`¶

The targets.

`it_include` `TYPE /AWS1/CL_EL2LSTOFDSCTGTHEALT00=>TT_LSTOFDESCRTGTHEALTHINCLOPTS` `TT_LSTOFDESCRTGTHEALTHINCLOPTS`¶

Used to include anomaly detection information.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_el2descrtgthealthout` `/AWS1/CL_EL2DESCRTGTHEALTHOUT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->describetargethealth(
  it_include = VALUE /aws1/cl_el2lstofdsctgthealt00=>tt_lstofdescrtgthealthinclopts(
    ( new /aws1/cl_el2lstofdsctgthealt00( |string| ) )
  )
  it_targets = VALUE /aws1/cl_el2targetdescription=>tt_targetdescriptions(
    (
      new /aws1/cl_el2targetdescription(
        iv_availabilityzone = |string|
        iv_id = |string|
        iv_port = 123
        iv_quicserverid = |string|
      )
    )
  )
  iv_targetgrouparn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_targethealthdescriptions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lo_targetdescription = lo_row_1->get_target( ).
      IF lo_targetdescription IS NOT INITIAL.
        lv_targetid = lo_targetdescription->get_id( ).
        lv_port = lo_targetdescription->get_port( ).
        lv_zonename = lo_targetdescription->get_availabilityzone( ).
        lv_quicserverid = lo_targetdescription->get_quicserverid( ).
      ENDIF.
      lv_healthcheckport = lo_row_1->get_healthcheckport( ).
      lo_targethealth = lo_row_1->get_targethealth( ).
      IF lo_targethealth IS NOT INITIAL.
        lv_targethealthstateenum = lo_targethealth->get_state( ).
        lv_targethealthreasonenum = lo_targethealth->get_reason( ).
        lv_description = lo_targethealth->get_description( ).
      ENDIF.
      lo_anomalydetection = lo_row_1->get_anomalydetection( ).
      IF lo_anomalydetection IS NOT INITIAL.
        lv_anomalyresultenum = lo_anomalydetection->get_result( ).
        lv_mitigationineffectenum = lo_anomalydetection->get_mitigationineffect( ).
      ENDIF.
      lo_administrativeoverride = lo_row_1->get_administrativeoverride( ).
      IF lo_administrativeoverride IS NOT INITIAL.
        lv_targetadministrativeove = lo_administrativeoverride->get_state( ).
        lv_targetadministrativeove_1 = lo_administrativeoverride->get_reason( ).
        lv_description = lo_administrativeoverride->get_description( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

To describe the health of the targets for a target group¶

This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.

DATA(lo_result) = lo_client->describetargethealth( iv_targetgrouparn = |arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067| ) .

To describe the health of a target¶

This example describes the health of the specified target. This target is healthy.

DATA(lo_result) = lo_client->describetargethealth(
  it_targets = VALUE /aws1/cl_el2targetdescription=>tt_targetdescriptions(
    (
      new /aws1/cl_el2targetdescription(
        iv_id = |i-0f76fade|
        iv_port = 80
      )
    )
  )
  iv_targetgrouparn = |arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067|
).

/AWS1/IF_EL2=>DESCRIBETARGETHEALTH()¶