Show DB log file details (GET /v1.0/{tenantId}/logfiles/{instanceId}/{logFileName})

Shows details of a DB log file.

CAUTION:

This can only be referenced if the virtual database server status is one of Active, Restart_Required, Switched, Degenerated, Backup, Modifying, Resize, Error, or Failed.

However, in a Modifying or Resize status, there is a temporary point where this returns 404, 503, or 504. In that event, please retry after a while.

Request URI

{tenantID}

Project ID of the owner of the instance

Data Type Cardinality
String 1..1

{instanceId}

ID of the virtual database server

Data Type Cardinality
String 1..1

{logFileName}

Name of the DB log file

Data Type Cardinality
String 1..1

Request Parameters

limit

Number of rows to display

Default:20

Data Type Cardinality Parent Element Child Element(s)
Integer 0..1 None None

marker

A pagination token used to establish the starting point for retrieving the list.

Specify the value returned with the previous DescribeDBInstances request.

If marker is specified, the lines following marker are displayed. If marker is not specified, the lines starting from the top line of the log file are displayed.

Data Type Cardinality Parent Element Child Element(s)
String 0..1 None None

descending

true: The DB log will be referenced in descending order

Default: false

If this parameter is "true", the DB log will be referenced in descending order.

This can be executed on the virtual database servers for which the downloadLogExtension parameter in the instance category is set to "true".

Data Type Cardinality Parent Element Child Element(s)
Boolean 0..1 None None

Response Headers

Status

Returns the status of the request.

One of the following values will be returned.
400:
badRequest
401:
unauthorized
403:
forbidden
404:
itemNotFound
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1..1

Response Elements

additionalDataPending

A return value of "true" indicates that there is still more data that can be downloaded.

Data Type Cardinality Parent Element Child Element(s)
Boolean      

logFileData

Stores the data of the specified log file.

Data Type Cardinality Parent Element Child Element(s)
String      

marker

Pagination token that can be used in subsequent DownloadDBLogFilePortion requests.

Data Type Cardinality Parent Element Child Element(s)
String      

Example of Response


{
   "downloadDBLogFilePortion":{
     "additionalDataPending":true,
     "logFileData":"xxxxxx"
     "marker":"20"
   }
 }