Skip to content

/AWS1/CL_ASC=>DESCRLOADBALANCERTGTGROUPS()

About DescribeLoadBalancerTargetGroups

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group.

Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.

To determine the attachment status of the target group, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter the InService state.

Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.

Method Signature

IMPORTING

Required arguments:

iv_autoscalinggroupname TYPE /AWS1/ASCXMLSTRINGMAXLEN255 /AWS1/ASCXMLSTRINGMAXLEN255

The name of the Auto Scaling group.

Optional arguments:

iv_nexttoken TYPE /AWS1/ASCXMLSTRING /AWS1/ASCXMLSTRING

The token for the next set of items to return. (You received this token from a previous call.)

iv_maxrecords TYPE /AWS1/ASCMAXRECORDS /AWS1/ASCMAXRECORDS

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

RETURNING

oo_output TYPE REF TO /aws1/cl_ascdscloadbalancert01 /AWS1/CL_ASCDSCLOADBALANCERT01

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->/aws1/if_asc~descrloadbalancertgtgroups(
  iv_autoscalinggroupname = |string|
  iv_maxrecords = 123
  iv_nexttoken = |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_loadbalancertargetgroups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_xmlstringmaxlen511 = lo_row_1->get_loadbalancertgtgrouparn( ).
      lv_xmlstringmaxlen255 = lo_row_1->get_state( ).
    ENDIF.
  ENDLOOP.
  lv_xmlstring = lo_result->get_nexttoken( ).
ENDIF.

To describe the target groups for an Auto Scaling group

This example describes the target groups attached to the specified Auto Scaling group.

DATA(lo_result) = lo_client->/aws1/if_asc~descrloadbalancertgtgroups( iv_autoscalinggroupname = |my-auto-scaling-group| ) .