Interface ContainerSummary

ContainerSummary

interface ContainerSummary {
    Command?: string;
    Created?: number;
    HostConfig?: ContainerSummaryHostConfig;
    Id?: string;
    Image?: string;
    ImageID?: string;
    Labels?: {
        [key: string]: string;
    };
    Mounts?: MountPoint[];
    Names?: string[];
    NetworkSettings?: ContainerSummaryNetworkSettings;
    Ports?: Port[];
    SizeRootFs?: number;
    SizeRw?: number;
    State?: string;
    Status?: string;
}

Properties

Command? Created? HostConfig? Id? Image? ImageID? Labels? Mounts? Names? NetworkSettings? Ports? SizeRootFs? SizeRw? State? Status?

Properties

OptionalCommand

Command?: string

Command to run when starting the container

OptionalCreated

Created?: number

When the container was created

OptionalHostConfig

HostConfig?: ContainerSummaryHostConfig

OptionalId

Id?: string

The ID of this container

OptionalImage

Image?: string

The name of the image used when creating this container

OptionalImageID

ImageID?: string

The ID of the image that this container was created from

OptionalLabels

Labels?: {
    [key: string]: string;
}

User-defined key/value metadata.

OptionalMounts

Mounts?: MountPoint[]

OptionalNames

Names?: string[]

The names that this container has been given

OptionalNetworkSettings

NetworkSettings?: ContainerSummaryNetworkSettings

OptionalPorts

Ports?: Port[]

The ports exposed by this container

OptionalSizeRootFs

SizeRootFs?: number

The total size of all the files in this container

OptionalSizeRw

SizeRw?: number

The size of files that have been created or changed by this container

OptionalState

State?: string

The state of this container (e.g. Exited)

OptionalStatus

Status?: string

Additional human-readable status of this container (e.g. Exit 0)

Settings

Member Visibility

On This Page

Properties