Module docker_api::models
source · [−]Expand description
Generated Docker models
Structs
Address represents an IPv4 or IPv6 IP address.
BuildCache contains information about a build cache record.
No error
ClusterInfo represents information about the swarm as is returned by the “/info” endpoint. Join-tokens are not included.
Commit holds the Git-commit (SHA1) that a binary was built from, as
reported in the version-string of external tools, such as containerd,
or runC.
change item in response to ContainerChanges operation
Configuration for a container that is portable between hosts.
Container created successfully
Configuration for a container that is portable between hosts.
no error
No error
ContainerState stores container’s running state. It’s part of ContainerJSONBase and will be returned by the “inspect” command.
A summary of the container’s network settings
no error
The container has been updated.
A container’s resources (cgroups config, ulimits, etc)
container waiting error, if any
OK response to ContainerWait operation
A device mapping between the host and container
A request for devices to be sent to device drivers
Describes the result obtained from contacting the registry to retrieve image metadata.
Driver represents a driver (network, logging, secrets).
EndpointIPAMConfig represents an endpoint’s IPAM configuration.
Configuration for a network endpoint.
Properties that can be configured to access and load balance a service.
EngineDescription provides information about an engine.
Represents an error.
Actor describes something that generates events, like a container, network, or a volume.
EventMessage represents the information an event contains.
No error
Information about the storage driver used to store the container’s and image’s filesystem.
Health stores information about the container’s healthcheck results.
A test to perform to check that the container is healthy.
HealthcheckResult stores information about a single run of a healthcheck probe
individual image layer information in response to ImageHistory operation
Container configuration that depends on the host we are running on
The logging configuration for this container
Response to an API call that returns just an Id
Image ID or Digest
Information about an image in the local image cache.
Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.
Information about the image’s RootFS, including the layer IDs.
No error
IndexInfo contains information about a registry.
JoinTokens contains the tokens workers and managers need to join the swarm.
An object describing a limit on resources which can be requested by a task.
ManagerStatus represents the status of a manager.
Optional configuration for the bind type.
MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
Optional configuration for the tmpfs type.
Optional configuration for the volume type.
Map of driver specific options
Specifies how a service should be attached to a particular network.
No error
No error
NetworkSettings exposes the network settings in the API
NetworkingConfig represents the container’s networking configuration for
each of its interfaces.
It is used for the networking configs specified in the docker create
and docker network connect commands.
NodeDescription encapsulates the properties of the Node as reported by the agent.
NodeStatus represents the status of a node.
The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects.
A descriptor struct containing digest, media type, and size, as defined in the OCI Content Descriptors Specification.
Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.
Represents a peer-node in the swarm
Platform represents the platform (Arch/OS).
A plugin for the Engine API
The config of a plugin.
The interface between Docker and the plugin
Describes a permission the user has to accept upon installing the plugin.
Settings that can be modified by users.
Available plugins per type.
An open port on a container
PortBinding represents a binding between a host IP address and a host port.
RegistryServiceConfig stores daemon registry services configuration.
An object describing the resources which can be advertised by a node and requested by a task.
A container’s resources (cgroups config, ulimits, etc)
The behavior to apply when the container exits. The default is not to restart.
Runtime describes an OCI compliant runtime.
no error
User modifiable configuration for a service.
Scheduling mode for the service.
The mode used for services with a finite number of tasks that run to a completed state.
Specification for the rollback strategy of the service.
Specification for the update strategy of the service.
The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service’s version, does not need to be sent with an update request.
The status of the service’s tasks. Provided only when requested as part of a ServiceList operation.
User modifiable configuration for a service.
Scheduling mode for the service.
The mode used for services with a finite number of tasks that run to a completed state.
Specification for the rollback strategy of the service.
Specification for the update strategy of the service.
User modifiable configuration for a service.
Scheduling mode for the service.
The mode used for services with a finite number of tasks that run to a completed state.
Specification for the rollback strategy of the service.
Specification for the update strategy of the service.
The status of a service update.
ClusterInfo represents information about the swarm as is returned by the “/info” endpoint. Join-tokens are not included.
Represents generic information about swarm.
User modifiable swarm configuration.
CA configuration.
Dispatcher configuration.
Parameters related to encryption-at-rest.
Orchestration configuration.
Raft configuration.
Defaults for creating tasks in this cluster.
The log driver to use for tasks created in the orchestrator if unspecified by a service.
no error
An identity token was generated successfully.
no error
Response of Engine API: GET “/version”
User modifiable task configuration.
Container spec for the service.
File represents a specific target that is backed by a file.
Specification for DNS related configurations in resolver configuration
file (resolv.conf).
Security options for the container
CredentialSpec for managed service account (Windows only)
SELinux labels of the container
File represents a specific target that is backed by a file.
Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified.
Read-only spec type for non-swarm containers attached to swarm overlay networks.
Plugin spec for the service. (Experimental release only.)
Resource requirements which apply to each individual container created as part of the service.
Specification for the restart policy which applies to containers created as part of this service.
Information about the issuer of leaf TLS certificates and the trusted root CA certificate.
Volume configuration
Summary volume data that matches the query
No error
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
Enums
Cache record type.
String representation of the container state. Can be one of “created”, “running”, “paused”, “restarting”, “removing”, “exited”, or “dead”.
The mode in which port is published.
The mode of resolution to use for internal load balancing between tasks.
The type of object emitting the event
Scope of the event. Engine events are local scope. Cluster (Swarm)
events are swarm scope.
Status is one of none, starting, healthy or unhealthy
cgroup namespace mode for the container. Possible values are:
Isolation technology of the container. (Windows only)
Represents a response chunk from Docker api when building, pulling or importing an image.
Current local status of this node.
A propagation mode with the value [r]private, [r]shared, or [r]slave.
The mount type:
The mount type. Available types:
Availability of the node.
Role of the node.
NodeState represents the state of a node.
Protocol to use for clients connecting to the plugin.
Reachability represents the reachability of a node.
no Do not automatically restartalways Always restartunless-stopped Restart always except when the user has manually stopped the containeron-failure Restart only when the container exit code is non-zeroAction to take if an rolled back task fails to run, or stops running during the rollback.
The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
Action to take if an updated task fails to run, or stops running during the update.
The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
Action to take if an rolled back task fails to run, or stops running during the rollback.
The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
Action to take if an updated task fails to run, or stops running during the update.
The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
Action to take if an rolled back task fails to run, or stops running during the rollback.
The order of operations when rolling back a task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
Action to take if an updated task fails to run, or stops running during the update.
The order of operations when rolling out an updated task. Either the old task is shut down before the new task is started, or the new task is started before the old task is shut down.
Protocol for communication with the external CA (currently
only cfssl is supported).
The driver to use for managing cgroups.
The version of the cgroup.
Represents the isolation technology to use as a default for containers. The supported values are platform-specific.
Isolation technology of the containers running the service. (Windows only)
Condition for restart.
The level at which the volume exists. Either global for cluster-wide,
or local for machine level.
Type Definitions
no error
The list of changes
no error
logs returned as a stream in response body. For the stream format, see the documentation for the attach endpoint. Note that unlike the attach endpoint, the logs endpoint does not upgrade the connection and does not set Content-Type.
no error
User-defined resources can be either Integer resources (e.g, SSD=3) or
String resources (e.g, GPU=UUID1).
no error
Configuration for a container that is portable between hosts.
The image was deleted successfully
no error
no error
List of image layers
Summary image data for the images matching the query
No error
No error
no error
No error
PortMap describes the mapping of container ports to host ports, using the
container’s port-number and protocol as key in the format <port>/<protocol>,
for example, 80/udp.
no error
no error
logs returned as a stream in response body
no error
User modifiable swarm configuration.
no error
no error
no error
logs returned as a stream in response body
Volume configuration