DESCRIBEGLOBALCLUSTERS()`¶

About DescribeGlobalClusters¶

Returns information about Neptune global database clusters. This API supports pagination.

Method Signature¶

METHODS /AWS1/IF_NEP~DESCRIBEGLOBALCLUSTERS
  IMPORTING
    !IV_GLOBALCLUSTERIDENTIFIER TYPE /AWS1/NEPGLOBALCLUSTERID OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/NEPINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/NEPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nepglobalclustsmsg
  RAISING
    /AWS1/CX_NEPGLBCLSTNOTFNDFAULT
    /AWS1/CX_NEPCLIENTEXC
    /AWS1/CX_NEPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_globalclusteridentifier` `TYPE /AWS1/NEPGLOBALCLUSTERID` `/AWS1/NEPGLOBALCLUSTERID`¶

The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.

Constraints: If supplied, must match an existing DB cluster identifier.

`iv_maxrecords` `TYPE /AWS1/NEPINTEGEROPTIONAL` `/AWS1/NEPINTEGEROPTIONAL`¶

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination marker token is included in the response that you can use to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

`iv_marker` `TYPE /AWS1/NEPSTRING` `/AWS1/NEPSTRING`¶

(Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nepglobalclustsmsg` `/AWS1/CL_NEPGLOBALCLUSTSMSG`¶

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->describeglobalclusters(
  iv_globalclusteridentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_globalclusters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_globalclusteridentifier = lo_row_1->get_globalclusteridentifier( ).
      lv_string = lo_row_1->get_globalclusterresourceid( ).
      lv_string = lo_row_1->get_globalclusterarn( ).
      lv_string = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_booleanoptional = lo_row_1->get_storageencrypted( ).
      lv_booleanoptional = lo_row_1->get_deletionprotection( ).
      LOOP AT lo_row_1->get_globalclustermembers( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_dbclusterarn( ).
          LOOP AT lo_row_3->get_readers( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_boolean = lo_row_3->get_iswriter( ).
        ENDIF.
      ENDLOOP.
      lo_failoverstate = lo_row_1->get_failoverstate( ).
      IF lo_failoverstate IS NOT INITIAL.
        lv_failoverstatus = lo_failoverstate->get_status( ).
        lv_string = lo_failoverstate->get_fromdbclusterarn( ).
        lv_string = lo_failoverstate->get_todbclusterarn( ).
        lv_boolean = lo_failoverstate->get_isdatalossallowed( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_NEP=>DESCRIBEGLOBALCLUSTERS()¶