DESCRIBECONTAINERGROUPDEFN()`¶

About DescribeContainerGroupDefinition¶

This API works with the following fleet types: Container

Retrieves the properties of a container group definition, including all container definitions in the group.

Request options:

Retrieve the latest version of a container group definition. Specify the container group definition name only, or use an ARN value without a version number.
Retrieve a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number.

Results:

If successful, this operation returns the complete properties of a container group definition version.

Learn more

Manage a container group definition

Method Signature¶

METHODS /AWS1/IF_GML~DESCRIBECONTAINERGROUPDEFN
  IMPORTING
    !IV_NAME TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 OPTIONAL
    !IV_VERSIONNUMBER TYPE /AWS1/GMLPOSITIVEINTEGER OPTIONAL
  PREFERRED PARAMETER iv_name
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmldsccontainergrde01
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00` `/AWS1/GMLCONTAINERGRDEFNAMEO00`¶

The unique identifier for the container group definition to retrieve properties for. You can use either the Name or ARN value.

Optional arguments:¶

`iv_versionnumber` `TYPE /AWS1/GMLPOSITIVEINTEGER` `/AWS1/GMLPOSITIVEINTEGER`¶

The specific version to retrieve.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmldsccontainergrde01` `/AWS1/CL_GMLDSCCONTAINERGRDE01`¶

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->describecontainergroupdefn(
  iv_name = |string|
  iv_versionnumber = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_containergroupdefinitio = lo_result->get_containergroupdefinition( ).
  IF lo_containergroupdefinitio IS NOT INITIAL.
    lv_containergroupdefinitio_1 = lo_containergroupdefinitio->get_containergroupdefnarn( ).
    lv_timestamp = lo_containergroupdefinitio->get_creationtime( ).
    lv_containeroperatingsyste = lo_containergroupdefinitio->get_operatingsystem( ).
    lv_containergroupdefinitio_2 = lo_containergroupdefinitio->get_name( ).
    lv_containergrouptype = lo_containergroupdefinitio->get_containergrouptype( ).
    lv_containertotalmemorylim = lo_containergroupdefinitio->get_totalmemorylmtmebibytes( ).
    lv_containertotalvcpulimit = lo_containergroupdefinitio->get_totalvcpulimit( ).
    lo_gameservercontainerdefi = lo_containergroupdefinitio->get_gameservercontainerdefn( ).
    IF lo_gameservercontainerdefi IS NOT INITIAL.
      lv_nonzeroand128maxasciist = lo_gameservercontainerdefi->get_containername( ).
      LOOP AT lo_gameservercontainerdefi->get_dependson( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_nonzeroand128maxasciist = lo_row_1->get_containername( ).
          lv_containerdependencycond = lo_row_1->get_condition( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_gameservercontainerdefi->get_mountpoints( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_instancepathstring = lo_row_3->get_instancepath( ).
          lv_containerpathstring = lo_row_3->get_containerpath( ).
          lv_containermountpointacce = lo_row_3->get_accesslevel( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_gameservercontainerdefi->get_environmentoverride( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_nonzeroand255maxstring = lo_row_5->get_name( ).
          lv_nonzeroand255maxstring = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_imageuristring = lo_gameservercontainerdefi->get_imageuri( ).
      lo_containerportconfigurat = lo_gameservercontainerdefi->get_portconfiguration( ).
      IF lo_containerportconfigurat IS NOT INITIAL.
        LOOP AT lo_containerportconfigurat->get_containerportranges( ) into lo_row_6.
          lo_row_7 = lo_row_6.
          IF lo_row_7 IS NOT INITIAL.
            lv_portnumber = lo_row_7->get_fromport( ).
            lv_portnumber = lo_row_7->get_toport( ).
            lv_ipprotocol = lo_row_7->get_protocol( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      lv_sha256 = lo_gameservercontainerdefi->get_resolvedimagedigest( ).
      lv_serversdkversion = lo_gameservercontainerdefi->get_serversdkversion( ).
    ENDIF.
    LOOP AT lo_containergroupdefinitio->get_supportcontainerdefns( ) into lo_row_8.
      lo_row_9 = lo_row_8.
      IF lo_row_9 IS NOT INITIAL.
        lv_nonzeroand128maxasciist = lo_row_9->get_containername( ).
        LOOP AT lo_row_9->get_dependson( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_nonzeroand128maxasciist = lo_row_1->get_containername( ).
            lv_containerdependencycond = lo_row_1->get_condition( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_row_9->get_mountpoints( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_instancepathstring = lo_row_3->get_instancepath( ).
            lv_containerpathstring = lo_row_3->get_containerpath( ).
            lv_containermountpointacce = lo_row_3->get_accesslevel( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_row_9->get_environmentoverride( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_nonzeroand255maxstring = lo_row_5->get_name( ).
            lv_nonzeroand255maxstring = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_booleanmodel = lo_row_9->get_essential( ).
        lo_containerhealthcheck = lo_row_9->get_healthcheck( ).
        IF lo_containerhealthcheck IS NOT INITIAL.
          LOOP AT lo_containerhealthcheck->get_command( ) into lo_row_10.
            lo_row_11 = lo_row_10.
            IF lo_row_11 IS NOT INITIAL.
              lv_nonzeroand255maxstring = lo_row_11->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_containerhealthcheckint = lo_containerhealthcheck->get_interval( ).
          lv_containerhealthcheckret = lo_containerhealthcheck->get_retries( ).
          lv_containerhealthchecksta = lo_containerhealthcheck->get_startperiod( ).
          lv_containerhealthchecktim = lo_containerhealthcheck->get_timeout( ).
        ENDIF.
        lv_imageuristring = lo_row_9->get_imageuri( ).
        lv_containermemorylimit = lo_row_9->get_memoryhardlimitmebibytes( ).
        lo_containerportconfigurat = lo_row_9->get_portconfiguration( ).
        IF lo_containerportconfigurat IS NOT INITIAL.
          LOOP AT lo_containerportconfigurat->get_containerportranges( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_portnumber = lo_row_7->get_fromport( ).
              lv_portnumber = lo_row_7->get_toport( ).
              lv_ipprotocol = lo_row_7->get_protocol( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lv_sha256 = lo_row_9->get_resolvedimagedigest( ).
        lv_containervcpu = lo_row_9->get_vcpu( ).
      ENDIF.
    ENDLOOP.
    lv_positiveinteger = lo_containergroupdefinitio->get_versionnumber( ).
    lv_nonzeroandmaxstring = lo_containergroupdefinitio->get_versiondescription( ).
    lv_containergroupdefinitio_3 = lo_containergroupdefinitio->get_status( ).
    lv_nonzeroandmaxstring = lo_containergroupdefinitio->get_statusreason( ).
  ENDIF.
ENDIF.

/AWS1/IF_GML=>DESCRIBECONTAINERGROUPDEFN()¶