Comment on page

LogsApi

LogsApi
All URIs are relative to https://api.ionos.com/databases/postgresql
Method
HTTP request
Description
​clusterLogsGet​
GET /clusters/{clusterId}/logs
Get logs of your cluster
clusterLogsGet
ClusterLogs clusterLogsGet(clusterId, start, end, direction, limit)
Get logs of your cluster
Retrieves PostgreSQL logs based on the given parameters.
Example
// Import classes:
import com.ionoscloud.dbaaspostgres.ApiClient;
import com.ionoscloud.dbaaspostgres.ApiException;
import com.ionoscloud.dbaaspostgres.Configuration;
import com.ionoscloud.dbaaspostgres.auth.*;
import com.ionoscloud.dbaaspostgres.model.*;
import com.ionoscloud.dbaaspostgres.api.LogsApi;
​
public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");
​
​
    LogsApi apiInstance = new LogsApi(defaultClient);
    String clusterId = "498ae72f-411f-11eb-9d07-046c59cc737e"; // String | The unique ID of the cluster.
    OffsetDateTime start = OffsetDateTime.now(); // OffsetDateTime | The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago.
    OffsetDateTime end = OffsetDateTime.now(); // OffsetDateTime | The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.
    String direction = "BACKWARD"; // String | The direction in which to scan through the logs. The logs are returned in order of the direction.
    Integer limit = 100; // Integer | The maximal number of log lines to return.  If the limit is reached then log lines will be cut at the end (respecting the scan direction).
    try {
      ClusterLogs result = apiInstance.clusterLogsGet(clusterId, start, end, direction, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling LogsApi#clusterLogsGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
Parameters
Name
Type
Description
Notes
clusterId
String
The unique ID of the cluster.
​
start
OffsetDateTime
The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago.
[optional]
end
OffsetDateTime
The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.
[optional]
direction
String
The direction in which to scan through the logs. The logs are returned in order of the direction.
[optional] [default to BACKWARD] [enum: BACKWARD, FORWARD]
limit
Integer
The maximal number of log lines to return. If the limit is reached then log lines will be cut at the end (respecting the scan direction).
[optional] [default to 100]
Return type
​ClusterLogs​
HTTP request headers
Content-Type: Not defined
Accept: application/json

Method	HTTP request	Description
clusterLogsGet	GET /clusters/{clusterId}/logs	Get logs of your cluster

Name	Type	Description	Notes
clusterId	String	The unique ID of the cluster.
start	OffsetDateTime	The start time for the query in RFC3339 format. Must not be more than 30 days ago but before the end parameter. The default is 30 days ago.	[optional]
end	OffsetDateTime	The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.	[optional]
direction	String	The direction in which to scan through the logs. The logs are returned in order of the direction.	[optional] [default to BACKWARD] [enum: BACKWARD, FORWARD]
limit	Integer	The maximal number of log lines to return. If the limit is reached then log lines will be cut at the end (respecting the scan direction).	[optional] [default to 100]

Last modified 4mo ago