LISTKXCLUSTERNODES()`¶

About ListKxClusterNodes¶

Lists all the nodes in a kdb cluster.

Method Signature¶

METHODS /AWS1/IF_FNS~LISTKXCLUSTERNODES
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/FNSKXENVIRONMENTID OPTIONAL
    !IV_CLUSTERNAME TYPE /AWS1/FNSKXCLUSTERNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/FNSPAGINATIONTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/FNSRESULTLIMIT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fnslstkxclustnodesrsp
  RAISING
    /AWS1/CX_FNSACCESSDENIEDEX
    /AWS1/CX_FNSINTERNALSERVEREX
    /AWS1/CX_FNSLIMITEXCEEDEDEX
    /AWS1/CX_FNSRESOURCENOTFOUNDEX
    /AWS1/CX_FNSTHROTTLINGEX
    /AWS1/CX_FNSVALIDATIONEX
    /AWS1/CX_FNSCLIENTEXC
    /AWS1/CX_FNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_environmentid` `TYPE /AWS1/FNSKXENVIRONMENTID` `/AWS1/FNSKXENVIRONMENTID`¶

A unique identifier for the kdb environment.

`iv_clustername` `TYPE /AWS1/FNSKXCLUSTERNAME` `/AWS1/FNSKXCLUSTERNAME`¶

A unique name for the cluster.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/FNSPAGINATIONTOKEN` `/AWS1/FNSPAGINATIONTOKEN`¶

A token that indicates where a results page should begin.

`iv_maxresults` `TYPE /AWS1/FNSRESULTLIMIT` `/AWS1/FNSRESULTLIMIT`¶

The maximum number of results to return in this request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fnslstkxclustnodesrsp` `/AWS1/CL_FNSLSTKXCLUSTNODESRSP`¶

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->listkxclusternodes(
  iv_clustername = |string|
  iv_environmentid = |string|
  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_nodes( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_kxclusternodeidstring = lo_row_1->get_nodeid( ).
      lv_availabilityzoneid = lo_row_1->get_availabilityzoneid( ).
      lv_timestamp = lo_row_1->get_launchtime( ).
      lv_kxnodestatus = lo_row_1->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_FNS=>LISTKXCLUSTERNODES()¶