DESCRIBEBACKUPS()`¶

About DescribeBackups¶

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

Method Signature¶

METHODS /AWS1/IF_OWC~DESCRIBEBACKUPS
  IMPORTING
    !IV_BACKUPID TYPE /AWS1/OWCBACKUPID OPTIONAL
    !IV_SERVERNAME TYPE /AWS1/OWCSERVERNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OWCNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OWCMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_owcdescrbackupsrsp
  RAISING
    /AWS1/CX_OWCINVALIDNEXTTOKENEX
    /AWS1/CX_OWCRESOURCENOTFOUNDEX
    /AWS1/CX_OWCVALIDATIONEX
    /AWS1/CX_OWCCLIENTEXC
    /AWS1/CX_OWCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_backupid` `TYPE /AWS1/OWCBACKUPID` `/AWS1/OWCBACKUPID`¶

Describes a single backup.

`iv_servername` `TYPE /AWS1/OWCSERVERNAME` `/AWS1/OWCSERVERNAME`¶

Returns backups for the server with the specified ServerName.

`iv_nexttoken` `TYPE /AWS1/OWCNEXTTOKEN` `/AWS1/OWCNEXTTOKEN`¶

This is not currently implemented for DescribeBackups requests.

`iv_maxresults` `TYPE /AWS1/OWCMAXRESULTS` `/AWS1/OWCMAXRESULTS`¶

This is not currently implemented for DescribeBackups requests.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_owcdescrbackupsrsp` `/AWS1/CL_OWCDESCRBACKUPSRSP`¶

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->describebackups(
  iv_backupid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_servername = |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_backups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_backuparn( ).
      lv_backupid = lo_row_1->get_backupid( ).
      lv_backuptype = lo_row_1->get_backuptype( ).
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_enginemodel( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_string = lo_row_1->get_instanceprofilearn( ).
      lv_string = lo_row_1->get_instancetype( ).
      lv_string = lo_row_1->get_keypair( ).
      lv_timewindowdefinition = lo_row_1->get_preferredbackupwindow( ).
      lv_timewindowdefinition = lo_row_1->get_preferredmaintenancewi00( ).
      lv_integer = lo_row_1->get_s3datasize( ).
      lv_string = lo_row_1->get_s3dataurl( ).
      lv_string = lo_row_1->get_s3logurl( ).
      LOOP AT lo_row_1->get_securitygroupids( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_servername = lo_row_1->get_servername( ).
      lv_string = lo_row_1->get_servicerolearn( ).
      lv_backupstatus = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusdescription( ).
      LOOP AT lo_row_1->get_subnetids( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_toolsversion( ).
      lv_string = lo_row_1->get_userarn( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OWC=>DESCRIBEBACKUPS()¶