Context

/platform/logging.alauda.io/v2/logs/context

getLog Context

Retrieve log context with authentication.

Parameters

  • cluster(in query): stringrequired

    Name of the cluster.

  • logIndex(in query): stringrequired

    Name of the log index (ES index or CK table name).

  • logId(in query): stringrequired

    Log ID.

  • pageSize(in query): integer

    Number of records per page. For export, 0 means export all.

  • direction(in query): string

    Context direction. Either 'before' or 'after'.

Response

  • 200object: Successful log context response
    Properties:

LogEntry

  • time: number

    Time of the log entry.

  • node: string

    Name of the node.

  • podName: string

    Name of the pod.

  • podId: string

    Identifier of the pod.

  • logData: string

    Log data as a JSON string.

  • logLevel: string

    Severity level of the log.

  • containerName: string

    Name of the container.

  • cluster: string

    Name of the cluster.

  • containerId: string

    Identifier of the container.

  • containerId8: string

    Shortened container identifier.

  • @timestamp: string

    Timestamp in string format.

  • namespace: string

    Namespace of the log.

  • project: string

    Project associated with the log.

  • path: string

    Log path.

  • logId: string

    Unique identifier of the log.

  • logType: string

    Type of the log.

  • logIndex: string

    Index name for the log.

  • component: string

    Component related to the log.

  • product: string

    Product name associated with the log.

  • workload: string

    Workload details.

/platform/logging.alauda.io/v2/clusters/{cluster}/logs/context

getLog Context by Cluster

Retrieve log context by cluster with authentication.

Parameters

  • cluster(in path): stringrequired

    Name of the cluster.

  • logIndex(in query): stringrequired

    Name of the log index (ES index or CK table name).

  • logId(in query): stringrequired

    Log ID.

  • pageSize(in query): integer

    Number of records per page. For export, 0 means export all.

  • direction(in query): string

    Context direction. Either 'before' or 'after'.

Response

  • 200object: Successful log context response
    Properties:

LogEntry

  • time: number

    Time of the log entry.

  • node: string

    Name of the node.

  • podName: string

    Name of the pod.

  • podId: string

    Identifier of the pod.

  • logData: string

    Log data as a JSON string.

  • logLevel: string

    Severity level of the log.

  • containerName: string

    Name of the container.

  • cluster: string

    Name of the cluster.

  • containerId: string

    Identifier of the container.

  • containerId8: string

    Shortened container identifier.

  • @timestamp: string

    Timestamp in string format.

  • namespace: string

    Namespace of the log.

  • project: string

    Project associated with the log.

  • path: string

    Log path.

  • logId: string

    Unique identifier of the log.

  • logType: string

    Type of the log.

  • logIndex: string

    Index name for the log.

  • component: string

    Component related to the log.

  • product: string

    Product name associated with the log.

  • workload: string

    Workload details.

/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/context

getLog Context by Project, Cluster and Namespace

Retrieve log context within a specific project, cluster, and namespace with authentication.

Parameters

  • project(in path): stringrequired

    Name of the project.

  • cluster(in path): stringrequired

    Name of the cluster.

  • namespace(in path): stringrequired

    Name of the namespace.

  • logIndex(in query): stringrequired

    Name of the log index (ES index or CK table name).

  • logId(in query): stringrequired

    Log ID.

  • pageSize(in query): integer

    Number of records per page. For export, 0 means export all.

  • direction(in query): string

    Context direction. Either 'before' or 'after'.

Response

  • 200object: Successful log context response
    Properties:

LogEntry

  • time: number

    Time of the log entry.

  • node: string

    Name of the node.

  • podName: string

    Name of the pod.

  • podId: string

    Identifier of the pod.

  • logData: string

    Log data as a JSON string.

  • logLevel: string

    Severity level of the log.

  • containerName: string

    Name of the container.

  • cluster: string

    Name of the cluster.

  • containerId: string

    Identifier of the container.

  • containerId8: string

    Shortened container identifier.

  • @timestamp: string

    Timestamp in string format.

  • namespace: string

    Namespace of the log.

  • project: string

    Project associated with the log.

  • path: string

    Log path.

  • logId: string

    Unique identifier of the log.

  • logType: string

    Type of the log.

  • logIndex: string

    Index name for the log.

  • component: string

    Component related to the log.

  • product: string

    Product name associated with the log.

  • workload: string

    Workload details.