DESCRIBEINSTANCETYPELIMITS()`¶

About DescribeInstanceTypeLimits¶

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Method Signature¶

METHODS /AWS1/IF_OSR~DESCRIBEINSTANCETYPELIMITS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/OSRDOMAINNAME OPTIONAL
    !IV_INSTANCETYPE TYPE /AWS1/OSROPENSRCHPARTITIONIN00 OPTIONAL
    !IV_ENGINEVERSION TYPE /AWS1/OSRVERSIONSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrdscinsttypelmtsrsp
  RAISING
    /AWS1/CX_OSRBASEEXCEPTION
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRINVALIDTYPEEX
    /AWS1/CX_OSRLIMITEXCEEDEDEX
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instancetype` `TYPE /AWS1/OSROPENSRCHPARTITIONIN00` `/AWS1/OSROPENSRCHPARTITIONIN00`¶

The OpenSearch Service instance type for which you need limit information.

`iv_engineversion` `TYPE /AWS1/OSRVERSIONSTRING` `/AWS1/OSRVERSIONSTRING`¶

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Optional arguments:¶

`iv_domainname` `TYPE /AWS1/OSRDOMAINNAME` `/AWS1/OSRDOMAINNAME`¶

The name of the domain. Only specify if you need the limits for an existing domain.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrdscinsttypelmtsrsp` `/AWS1/CL_OSRDSCINSTTYPELMTSRSP`¶

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->describeinstancetypelimits(
  iv_domainname = |string|
  iv_engineversion = |string|
  iv_instancetype = |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_limitsbyrole( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      LOOP AT lo_value->get_storagetypes( ) into lo_row_1.
        lo_row_2 = lo_row_1.
        IF lo_row_2 IS NOT INITIAL.
          lv_storagetypename = lo_row_2->get_storagetypename( ).
          lv_storagesubtypename = lo_row_2->get_storagesubtypename( ).
          LOOP AT lo_row_2->get_storagetypelimits( ) into lo_row_3.
            lo_row_4 = lo_row_3.
            IF lo_row_4 IS NOT INITIAL.
              lv_limitname = lo_row_4->get_limitname( ).
              LOOP AT lo_row_4->get_limitvalues( ) into lo_row_5.
                lo_row_6 = lo_row_5.
                IF lo_row_6 IS NOT INITIAL.
                  lv_limitvalue = lo_row_6->get_value( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lo_instancelimits = lo_value->get_instancelimits( ).
      IF lo_instancelimits IS NOT INITIAL.
        lo_instancecountlimits = lo_instancelimits->get_instancecountlimits( ).
        IF lo_instancecountlimits IS NOT INITIAL.
          lv_minimuminstancecount = lo_instancecountlimits->get_minimuminstancecount( ).
          lv_maximuminstancecount = lo_instancecountlimits->get_maximuminstancecount( ).
        ENDIF.
      ENDIF.
      LOOP AT lo_value->get_additionallimits( ) into lo_row_7.
        lo_row_8 = lo_row_7.
        IF lo_row_8 IS NOT INITIAL.
          lv_limitname = lo_row_8->get_limitname( ).
          LOOP AT lo_row_8->get_limitvalues( ) into lo_row_5.
            lo_row_6 = lo_row_5.
            IF lo_row_6 IS NOT INITIAL.
              lv_limitvalue = lo_row_6->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_OSR=>DESCRIBEINSTANCETYPELIMITS()¶