List tasks

/v1.33

GET

/tasks

Task

Response Example

200 - Example 1

[
    {
        "CreatedAt": "2016-06-07T21:07:31.171892745Z",
        "DesiredState": "running",
        "ID": "0kzzo1i0y4jz6027t0k7aezc7",
        "NetworksAttachments": [
            {
                "Addresses": [
                    "10.255.0.10/16"
                ],
                "Network": {
                    "CreatedAt": "2016-06-07T20:31:11.912919752Z",
                    "DriverState": {
                        "Name": "overlay",
                        "Options": {
                            "com.docker.network.driver.overlay.vxlanid_list": "256"
                        }
                    },
                    "ID": "4qvuz4ko70xaltuqbt8956gd1",
                    "IPAMOptions": {
                        "Configs": [
                            {
                                "Gateway": "10.255.0.1",
                                "Subnet": "10.255.0.0/16"
                            }
                        ],
                        "Driver": {
                            "Name": "default"
                        }
                    },
                    "Spec": {
                        "DriverConfiguration": {},
                        "IPAMOptions": {
                            "Configs": [
                                {
                                    "Gateway": "10.255.0.1",
                                    "Subnet": "10.255.0.0/16"
                                }
                            ],
                            "Driver": {}
                        },
                        "Labels": {
                            "com.docker.swarm.internal": "true"
                        },
                        "Name": "ingress"
                    },
                    "UpdatedAt": "2016-06-07T21:07:29.955277358Z",
                    "Version": {
                        "Index": 18
                    }
                }
            }
        ],
        "NodeID": "60gvrl6tm78dmak4yl7srz94v",
        "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz",
        "Slot": 1,
        "Spec": {
            "ContainerSpec": {
                "Image": "redis"
            },
            "Placement": {},
            "Resources": {
                "Limits": {},
                "Reservations": {}
            },
            "RestartPolicy": {
                "Condition": "any",
                "MaxAttempts": 0
            }
        },
        "Status": {
            "ContainerStatus": {
                "ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035",
                "PID": 677
            },
            "Message": "started",
            "State": "running",
            "Timestamp": "2016-06-07T21:07:31.290032978Z"
        },
        "UpdatedAt": "2016-06-07T21:07:31.376370513Z",
        "Version": {
            "Index": 71
        }
    },
    {
        "CreatedAt": "2016-06-07T21:07:30.019104782Z",
        "DesiredState": "shutdown",
        "ID": "1yljwbmlr8er2waf8orvqpwms",
        "Name": "hopeful_cori",
        "NetworksAttachments": [
            {
                "Addresses": [
                    "10.255.0.5/16"
                ],
                "Network": {
                    "CreatedAt": "2016-06-07T20:31:11.912919752Z",
                    "DriverState": {
                        "Name": "overlay",
                        "Options": {
                            "com.docker.network.driver.overlay.vxlanid_list": "256"
                        }
                    },
                    "ID": "4qvuz4ko70xaltuqbt8956gd1",
                    "IPAMOptions": {
                        "Configs": [
                            {
                                "Gateway": "10.255.0.1",
                                "Subnet": "10.255.0.0/16"
                            }
                        ],
                        "Driver": {
                            "Name": "default"
                        }
                    },
                    "Spec": {
                        "DriverConfiguration": {},
                        "IPAMOptions": {
                            "Configs": [
                                {
                                    "Gateway": "10.255.0.1",
                                    "Subnet": "10.255.0.0/16"
                                }
                            ],
                            "Driver": {}
                        },
                        "Labels": {
                            "com.docker.swarm.internal": "true"
                        },
                        "Name": "ingress"
                    },
                    "UpdatedAt": "2016-06-07T21:07:29.955277358Z",
                    "Version": {
                        "Index": 18
                    }
                }
            }
        ],
        "NodeID": "60gvrl6tm78dmak4yl7srz94v",
        "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz",
        "Slot": 1,
        "Spec": {
            "ContainerSpec": {
                "Image": "redis"
            },
            "Placement": {},
            "Resources": {
                "Limits": {},
                "Reservations": {}
            },
            "RestartPolicy": {
                "Condition": "any",
                "MaxAttempts": 0
            }
        },
        "Status": {
            "ContainerStatus": {
                "ContainerID": "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213"
            },
            "Message": "shutdown",
            "State": "shutdown",
            "Timestamp": "2016-06-07T21:07:30.202183143Z"
        },
        "UpdatedAt": "2016-06-07T21:07:30.231958098Z",
        "Version": {
            "Index": 30
        }
    }
]

Request

Query Params

filters

string

optional

A JSON encoded value of the filters (a map[string][]string) to process on the tasks list. Available filters:

desired-state=(running | shutdown | accepted)

id=<task id>

label=key or label="key=value"

name=<task name>

node=<node id or name>

service=<service name>

Responses

🟢200no error

application/json

Body

array of:

AssignedGenericResources

array [object {2}]

optional

User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1)

Example:

[{"DiscreteResourceSpec":{"Kind":"SSD","Value":3}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID1"}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID2"}}]

DiscreteResourceSpec

object

optional

NamedResourceSpec

object

optional

CreatedAt

string <dateTime>

optional

DesiredState

enum<string>

optional

Allowed values:

newallocatedpendingassignedacceptedpreparingreadystartingrunningcompleteshutdownfailedrejected

string

optional

The ID of the task.

Labels

object

optional

User-defined key/value metadata.

Additional properties

string

optional

Name

string

optional

Name of the task.

NodeID

string

optional

The ID of the node that this task is on.

ServiceID

string

optional

The ID of the service this task is part of.

Slot

integer

optional

Spec

object (TaskSpec)

optional

User modifiable task configuration.

ContainerSpec

object

optional

Invalid when specified with PluginSpec.

ForceUpdate

integer

optional

A counter that triggers an update even if no relevant parameters have been changed.

LogDriver

object

optional

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.

Networks

array [object {2}]

optional

Placement

object

optional

PluginSpec

object

optional

Invalid when specified with ContainerSpec. (Experimental release only.)

Resources

object

optional

Resource requirements which apply to each individual container created as part of the service.

RestartPolicy

object

optional

Specification for the restart policy which applies to containers created as part of this service.

Runtime

string

optional

Runtime is the type of runtime specified for the task executor.

Status

object

optional

ContainerStatus

object

optional

Err

string

optional

Message

string

optional

State

enum<string>

optional

Allowed values:

newallocatedpendingassignedacceptedpreparingreadystartingrunningcompleteshutdownfailedrejected

Timestamp

string <dateTime>

optional

UpdatedAt

string <dateTime>

optional

Version

object (ObjectVersion)

optional

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.
This approach ensures safe concurrency and determinism in that the change on the object
may not be applied if the version number has changed from the last read. In other words,
if two update requests specify the same base version, only one of the requests can succeed.
As a result, two separate update requests that happen at the same time will not
unintentionally overwrite each other.

Index

integer <uint64>

optional

Example:

373531

🔴500server error

🔴503node is not part of a swarm

Modified at 2022-09-10 17:56:07

Update a swarm

Inspect a task