LISTCLUSTERS()`¶

About ListClusters¶

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Method Signature¶

METHODS /AWS1/IF_SNB~LISTCLUSTERS
  IMPORTING
    !IV_MAXRESULTS TYPE /AWS1/SNBLISTLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SNBSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_snblistclustersresult
  RAISING
    /AWS1/CX_SNBINVALIDNEXTTOKENEX
    /AWS1/CX_SNBCLIENTEXC
    /AWS1/CX_SNBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/SNBLISTLIMIT` `/AWS1/SNBLISTLIMIT`¶

The number of ClusterListEntry objects to return.

`iv_nexttoken` `TYPE /AWS1/SNBSTRING` `/AWS1/SNBSTRING`¶

HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_snblistclustersresult` `/AWS1/CL_SNBLISTCLUSTERSRESULT`¶

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->listclusters(
  iv_maxresults = 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_clusterlistentries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_clusterid( ).
      lv_clusterstate = lo_row_1->get_clusterstate( ).
      lv_timestamp = lo_row_1->get_creationdate( ).
      lv_string = lo_row_1->get_description( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SNB=>LISTCLUSTERS()¶