Skip to content

KubernetesLogsApi.md

Latest commit

 

History

History
235 lines (162 loc) · 9.06 KB

KubernetesLogsApi.md

File metadata and controls

235 lines (162 loc) · 9.06 KB

\KubernetesLogsApi

All URIs are relative to http://localhost

Method HTTP request Description
GetKubernetesLogs Get /k8s/logs Get Kubernetes logs
GetKubernetesLogsAutocomplete Get /k8s/logs/autocomplete Get Kubernetes logs autocomplete values
GetKubernetesLogsHistogram Get /k8s/logs/histogram Get Kubernetes logs histogram

GetKubernetesLogs

GetKubernetesLogsResult GetKubernetesLogs(ctx).From(from).To(to).PodUID(podUID).PageSize(pageSize).Page(page).Query(query).ContainerNames(containerNames).Direction(direction).Severity(severity).Execute()

Get Kubernetes logs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    from := int32(56) // int32 | Logs initial timestamp.
    to := int32(56) // int32 | Logs last timestamp.
    podUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Find only logs for the given pod UID.
    pageSize := int32(56) // int32 | Maximum number of the log lines in the result. (optional) (default to 25)
    page := int32(56) // int32 | The page for which the log lines of pageSize must be returned. (optional) (default to 1)
    query := "query_example" // string | Find only logs containing query text. (optional)
    containerNames := []string{"Inner_example"} // []string | Find only logs for the given container names. (optional)
    direction := openapiclient.LogsDirection("NEWEST") // LogsDirection | Fetch Oldest or Newest first. (optional) (default to "NEWEST")
    severity := []openapiclient.LogSeverity{openapiclient.LogSeverity("WARNING")} // []LogSeverity | Search a specific log severity WARN, ERROR, OTHER. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesLogsApi.GetKubernetesLogs(context.Background()).From(from).To(to).PodUID(podUID).PageSize(pageSize).Page(page).Query(query).ContainerNames(containerNames).Direction(direction).Severity(severity).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesLogsApi.GetKubernetesLogs``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetKubernetesLogs`: GetKubernetesLogsResult
    fmt.Fprintf(os.Stdout, "Response from `KubernetesLogsApi.GetKubernetesLogs`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
from int32 Logs initial timestamp.
to int32 Logs last timestamp.
podUID string Find only logs for the given pod UID.
pageSize int32 Maximum number of the log lines in the result. [default to 25]
page int32 The page for which the log lines of pageSize must be returned. [default to 1]
query string Find only logs containing query text.
containerNames []string Find only logs for the given container names.
direction LogsDirection Fetch Oldest or Newest first. [default to "NEWEST"]
severity []LogSeverity Search a specific log severity WARN, ERROR, OTHER.

Return type

GetKubernetesLogsResult

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetKubernetesLogsAutocomplete

GetKubernetesLogsAutocompleteResult GetKubernetesLogsAutocomplete(ctx).From(from).To(to).PodUID(podUID).Execute()

Get Kubernetes logs autocomplete values

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    from := int32(56) // int32 | Logs initial timestamp.
    to := int32(56) // int32 | Logs last timestamp.
    podUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Find only logs for the given pod UID.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesLogsApi.GetKubernetesLogsAutocomplete(context.Background()).From(from).To(to).PodUID(podUID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesLogsApi.GetKubernetesLogsAutocomplete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetKubernetesLogsAutocomplete`: GetKubernetesLogsAutocompleteResult
    fmt.Fprintf(os.Stdout, "Response from `KubernetesLogsApi.GetKubernetesLogsAutocomplete`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
from int32 Logs initial timestamp.
to int32 Logs last timestamp.
podUID string Find only logs for the given pod UID.

Return type

GetKubernetesLogsAutocompleteResult

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetKubernetesLogsHistogram

GetKubernetesLogsHistogramResult GetKubernetesLogsHistogram(ctx).From(from).To(to).PodUID(podUID).BucketsCount(bucketsCount).Query(query).ContainerNames(containerNames).Severity(severity).Execute()

Get Kubernetes logs histogram

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    from := int32(56) // int32 | Logs initial timestamp.
    to := int32(56) // int32 | Logs last timestamp.
    podUID := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Find only logs for the given pod UID.
    bucketsCount := int32(56) // int32 | The number of histogram buckets.
    query := "query_example" // string | Find only logs containing query text. (optional)
    containerNames := []string{"Inner_example"} // []string | Find only logs for the given container names. (optional)
    severity := []openapiclient.LogSeverity{openapiclient.LogSeverity("WARNING")} // []LogSeverity | Search a specific log severity WARN, ERROR, OTHER. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesLogsApi.GetKubernetesLogsHistogram(context.Background()).From(from).To(to).PodUID(podUID).BucketsCount(bucketsCount).Query(query).ContainerNames(containerNames).Severity(severity).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesLogsApi.GetKubernetesLogsHistogram``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetKubernetesLogsHistogram`: GetKubernetesLogsHistogramResult
    fmt.Fprintf(os.Stdout, "Response from `KubernetesLogsApi.GetKubernetesLogsHistogram`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
from int32 Logs initial timestamp.
to int32 Logs last timestamp.
podUID string Find only logs for the given pod UID.
bucketsCount int32 The number of histogram buckets.
query string Find only logs containing query text.
containerNames []string Find only logs for the given container names.
severity []LogSeverity Search a specific log severity WARN, ERROR, OTHER.

Return type

GetKubernetesLogsHistogramResult

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]