Jump to

• Request
• Response

Get Microservice Container Logs

get

/api/microservice/Workload/readLogs

Gets microservice container logs. For performance reasons, only the last 20 lines of logs are returned.

Request

Query Parameters

• ContainerPrefix(required): integer
  The container prefix which is used to get container data. If container prefix is 1, source container name is included in the results.

  Example:

  1

• TimestampPrefix(required): integer
  The time stamp prefix which is used to show time stamps. If time stamp prefix is 1, log timestamp is included in the results.

  Example:

  1

• container(required): string
  The microservice init-container or the container ID.

  Example:

  12345

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• path(required): string
  The resource path, in /{cluster}/{namespace}/{resource-name} format.

  Example:

  /cluster-1/kube-system/canal

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  Example:

  1

• workloadType(required): string
  The type of the workload. Possible values are pod, deployment, service, statefulset, job, replicaset, daemonset, or cronjob.

  Example:

  daemonset

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: array data
• message: string
  The response message in text.

  Example:
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message in text.",
            "type":"string",
            "example":""
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/microserviceWorkloadReadLogs"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object microserviceWorkloadReadLogs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/microserviceWorkloadReadLogs"
    }
}

Nested Schema : microserviceWorkloadReadLogs

Type: object

Show Source

• container: string
  Container Name

  Example: container-node
• message: string
  message for log entry generated by conatiner

  Example: 2023-10-20 10:18:23.391 [INFO][52] cni-config-monitor/token_watch.go 225: Update of CNI kubeconfig triggered based on elapsed time.
• time: string
  Time stamp

  Example: 2023-10-20T10:18:23.391270632Z

{
    "properties":{
        "time":{
            "description":"Time stamp",
            "type":"string",
            "example":"2023-10-20T10:18:23.391270632Z"
        },
        "container":{
            "description":"Container Name",
            "type":"string",
            "example":"container-node"
        },
        "message":{
            "description":"message for log entry generated by conatiner",
            "type":"string",
            "example":"2023-10-20 10:18:23.391 [INFO][52] cni-config-monitor/token_watch.go 225: Update of CNI kubeconfig triggered based on elapsed time."
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top