Interface ContainerState

ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the "inspect" command. ContainerState

interface ContainerState {
    Dead?: boolean;
    Error?: string;
    ExitCode?: number;
    FinishedAt?: string;
    Health?: null | Health;
    OOMKilled?: boolean;
    Paused?: boolean;
    Pid?: number;
    Restarting?: boolean;
    Running?: boolean;
    StartedAt?: string;
    Status?: ContainerStateStatusEnum;
}

Properties

Dead? Error? ExitCode? FinishedAt? Health? OOMKilled? Paused? Pid? Restarting? Running? StartedAt? Status?

Properties

OptionalDead

Dead?: boolean

OptionalError

Error?: string

OptionalExitCode

ExitCode?: number

The last exit code of this container

OptionalFinishedAt

FinishedAt?: string

The time when this container last exited.

OptionalHealth

Health?: null | Health

OptionalOOMKilled

OOMKilled?: boolean

Whether this container has been killed because it ran out of memory.

OptionalPaused

Paused?: boolean

Whether this container is paused.

OptionalPid

Pid?: number

The process ID of this container

OptionalRestarting

Restarting?: boolean

Whether this container is restarting.

OptionalRunning

Running?: boolean

Whether this container is running. Note that a running container can be paused. The Running and Paused booleans are not mutually exclusive: When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both Running and Paused. Use the Status field instead to determine if a container's state is "running".

OptionalStartedAt

StartedAt?: string

The time when this container was last started.

OptionalStatus

Status?: ContainerStateStatusEnum

String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead".

Settings

Member Visibility

On This Page

Properties