Help Center/ Cloud Container Instance/ API Reference/ Kubernetes APIs/ Pod/ Querying Pod Logs
Updated on 2023-12-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Pod Logs

Function

This API is used to query the logs of a specified pod.

Calling Method

For details, see Calling APIs.

URI

GET /api/v1/namespaces/{namespace}/pods/{name}/log

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

name

Yes

String

name of the Pod

namespace

Yes

String

object name and auth scope, such as for teams and projects
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

container

No

String

The container for which to stream logs. Defaults to only container if there is one container in the pod.

follow

No

Boolean

Follow the log stream of the pod. Defaults to false.

insecureSkipTLSVerifyBackend

No

Boolean

insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet).

limitBytes

No

Integer

If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

pretty

No

String

If 'true', then the output is pretty printed.

previous

No

Boolean

Return previous terminated container logs. Defaults to false.

sinceSeconds

No

Integer

A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

tailLines

No

Integer

If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

timestamps

No

Boolean

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

None

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

405

MethodNotAllowed

406

NotAcceptable

409

Conflict

415

UnsupportedMediaType

422

Invalid

429

TooManyRequests

500

InternalError

503

ServiceUnavailable

504

ServerTimeout
Parent topic: Pod