NAME
API::Docker::Type::ContainerSummary - One entry of the 200 response to GET /containers/json
VERSION
version 0.004
DESCRIPTION
Generated from the ContainerSummary definition of spec/v1.51.yaml, which the swagger leaves undescribed. paths: says what it is: one entry of the 200 response to GET /containers/json and the Containers field of the 200 response to GET /system/df.
id
The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes).
names
The names associated with this container. Most containers have a single name, but when using legacy "links", the container can have multiple names.
For historic reasons, names are prefixed with a forward-slash (/).
image
The name or ID of the image used to create the container.
This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., docker.io/library/ubuntu:latest or docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782), short form (e.g., ubuntu:latest)), or the ID(-prefix) of the image (e.g., 72297848456d).
The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782).
image_id
The ID (digest) of the image that this container was created from. Serialised as ImageID -- spelled out, because deriving it from the Perl name would produce ImageId.
image_manifest_descriptor
OCI descriptor of the platform-specific manifest of the image the container was created from.
Note: Only available if the daemon provides a multi-platform image store.
This field is not populated in the GET /system/df endpoint. See API::Docker::Type::OCIDescriptor.
command
Command to run when starting the container.
created
Date and time at which the container was created as a Unix timestamp (number of seconds since EPOCH).
ports
Port-mappings for the container. See API::Docker::Type::Port.
size_rw
The size of files that have been created or changed by this container.
This field is omitted by default, and only set when size is requested in the API request.
size_root_fs
The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers.
This field is omitted by default, and only set when size is requested in the API request.
labels
User-defined key/value metadata. The keys are the caller's data and are never translated.
state
The state of this container. The swagger enumerates created, running, paused, restarting, exited, removing and dead.
status
Additional human-readable status of this container (e.g. Exit 0).
host_config
Summary of host-specific runtime information of the container. This is a reduced set of information in the container's "HostConfig" as available in the container "inspect" response. See API::Docker::Type::ContainerSummary::HostConfig.
network_settings
Summary of the container's network settings. See API::Docker::Type::ContainerSummary::NetworkSettings.
mounts
List of mounts used by the container. See API::Docker::Type::MountPoint.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHOR
Torsten Raudssus <getty@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.