Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 3.52 KB

LogsApi.md

File metadata and controls

88 lines (60 loc) · 3.52 KB

\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

var result ClusterLogs = ClusterLogsGet(ctx, clusterId)
                      .Start(start)
                      .End(end)
                      .Direction(direction)
                      .Limit(limit)
                      .Execute()

Get logs of your cluster

Example

package main

import (
    "context"
    "fmt"
    "os"

    psql "github.com/ionos-cloud/sdk-go-bundle/products/dbaas/psql"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    clusterId := "498ae72f-411f-11eb-9d07-046c59cc737e" // string | The unique ID of the cluster.
    start := time.Now() // time.Time | 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 := time.Now() // time.Time | The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp. (optional)
    direction := "direction_example" // string | The direction in which to scan through the logs. The logs are returned in order of the direction. (optional) (default to "BACKWARD")
    limit := int32(56) // int32 | 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)

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := psql.NewAPIClient(configuration)
    resource, resp, err := apiClient.LogsApi.ClusterLogsGet(context.Background(), clusterId).Start(start).End(end).Direction(direction).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogsApi.ClusterLogsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `ClusterLogsGet`: ClusterLogs
    fmt.Fprintf(os.Stdout, "Response from `LogsApi.ClusterLogsGet`: %v\n", resource)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId string The unique ID of the cluster.

Other Parameters

Other parameters are passed through a pointer to an apiClusterLogsGetRequest struct via the builder pattern

Name Type Description Notes
start time.Time 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.
end time.Time The end time for the query in RFC3339 format. Must not be greater than now. The default is the current timestamp.
direction string The direction in which to scan through the logs. The logs are returned in order of the direction. [default to "BACKWARD"]
limit int32 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). [default to 100]

Return type

ClusterLogs

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json