Skip to content

/AWS1/CL_RDS=>DESCRIBEDBLOGFILES()

About DescribeDBLogFiles

Returns a list of DB log files for the DB instance.

This command doesn't apply to RDS Custom.

Method Signature

IMPORTING

Required arguments:

iv_dbinstanceidentifier TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must match the identifier of an existing DBInstance.

Optional arguments:

iv_filenamecontains TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

Filters the available log files for log file names that contain the specified string.

iv_filelastwritten TYPE /AWS1/RDSLONG /AWS1/RDSLONG

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

iv_filesize TYPE /AWS1/RDSLONG /AWS1/RDSLONG

Filters the available log files for files larger than the specified size.

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

This parameter isn't currently supported.

iv_maxrecords TYPE /AWS1/RDSINTEGEROPTIONAL /AWS1/RDSINTEGEROPTIONAL

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

iv_marker TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsdescrdblogfilesrsp /AWS1/CL_RDSDESCRDBLOGFILESRSP

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->/aws1/if_rds~describedblogfiles(
  it_filters = VALUE /aws1/cl_rdsfilter=>tt_filterlist(
    (
      new /aws1/cl_rdsfilter(
        it_values = VALUE /aws1/cl_rdsfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_rdsfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbinstanceidentifier = |string|
  iv_filelastwritten = 123
  iv_filenamecontains = |string|
  iv_filesize = 123
  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.
  LOOP AT lo_result->get_describedblogfiles00( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_logfilename( ).
      lv_long = lo_row_1->get_lastwritten( ).
      lv_long = lo_row_1->get_size( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.

To describe the log files for a DB instance

The following example retrieves details about the log files for the specified DB instance.

DATA(lo_result) = lo_client->/aws1/if_rds~describedblogfiles( iv_dbinstanceidentifier = |test-instance| ) .