mirror of https://github.com/docker/docs.git
				
				
				
			Fix service and tasks API documentation
The documentation contained some outdated information on these endpoints. This change fixes those parts of the documentation Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (cherry picked from commit d69409fd43e73829209315de79abf79000c4c720) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
		
							parent
							
								
									f9f6145003
								
							
						
					
					
						commit
						ac1eb9edd0
					
				|  | @ -4402,7 +4402,8 @@ List services | |||
|               "Reservations": {} | ||||
|             }, | ||||
|             "RestartPolicy": { | ||||
|               "Condition": "ANY" | ||||
|               "Condition": "any", | ||||
|               "MaxAttempts": 0 | ||||
|             }, | ||||
|             "Placement": {} | ||||
|           }, | ||||
|  | @ -4412,26 +4413,36 @@ List services | |||
|             } | ||||
|           }, | ||||
|           "UpdateConfig": { | ||||
|             "Parallelism": 1 | ||||
|             "Parallelism": 1, | ||||
|             "FailureAction": "pause" | ||||
|           }, | ||||
|           "EndpointSpec": { | ||||
|             "Mode": "VIP", | ||||
|             "Ingress": "PUBLICPORT", | ||||
|             "ExposedPorts": [ | ||||
|             "Mode": "vip", | ||||
|             "Ports": [ | ||||
|               { | ||||
|                 "Protocol": "tcp", | ||||
|                 "Port": 6379 | ||||
|                 "TargetPort": 6379, | ||||
|                 "PublishedPort": 30001 | ||||
|               } | ||||
|             ] | ||||
|           } | ||||
|         }, | ||||
|         "Endpoint": { | ||||
|           "Spec": {}, | ||||
|           "ExposedPorts": [ | ||||
|           "Spec": { | ||||
|             "Mode": "vip", | ||||
|             "Ports": [ | ||||
|               { | ||||
|                 "Protocol": "tcp", | ||||
|               "Port": 6379, | ||||
|               "PublicPort": 30000 | ||||
|                 "TargetPort": 6379, | ||||
|                 "PublishedPort": 30001 | ||||
|               } | ||||
|             ] | ||||
|           }, | ||||
|           "Ports": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "TargetPort": 6379, | ||||
|               "PublishedPort": 30001 | ||||
|             } | ||||
|           ], | ||||
|           "VirtualIPs": [ | ||||
|  | @ -4617,13 +4628,13 @@ image](#create-an-image) section for more details. | |||
|     - **FailureAction** - Action to take if an updated task fails to run, or stops running during the | ||||
|       update. Values are `continue` and `pause`. | ||||
| - **Networks** – Array of network names or IDs to attach the service to. | ||||
| - **Endpoint** – Properties that can be configured to access and load balance a service. | ||||
|     - **Spec** – | ||||
| - **EndpointSpec** – Properties that can be configured to access and load balance a service. | ||||
|     - **Mode** – The mode of resolution to use for internal load balancing | ||||
|           between tasks (`vip` or `dnsrr`). | ||||
|         - **Ports** – Exposed ports that this service is accessible on from the outside, in the form | ||||
|           of: `"Ports": { "<port>/<tcp|udp>: {}" }` | ||||
|     - **VirtualIPs** | ||||
|       between tasks (`vip` or `dnsrr`). Defaults to `vip` if not provided. | ||||
|     - **Ports** – List of exposed ports that this service is accessible on from | ||||
|       the outside, in the form of: | ||||
|       `{"Protocol": <"tcp"|"udp">, "PublishedPort": <port>, "TargetPort": <port>}`. | ||||
|       Ports can only be provided if `vip` resolution mode is used. | ||||
| 
 | ||||
| **Request Headers**: | ||||
| 
 | ||||
|  | @ -4676,7 +4687,7 @@ Return information on the service `id`. | |||
|       "UpdatedAt": "2016-06-07T21:10:20.276301259Z", | ||||
|       "Spec": { | ||||
|         "Name": "redis", | ||||
|         "Task": { | ||||
|         "TaskTemplate": { | ||||
|           "ContainerSpec": { | ||||
|             "Image": "redis" | ||||
|           }, | ||||
|  | @ -4685,7 +4696,8 @@ Return information on the service `id`. | |||
|             "Reservations": {} | ||||
|           }, | ||||
|           "RestartPolicy": { | ||||
|             "Condition": "ANY" | ||||
|             "Condition": "any", | ||||
|             "MaxAttempts": 0 | ||||
|           }, | ||||
|           "Placement": {} | ||||
|         }, | ||||
|  | @ -4695,26 +4707,36 @@ Return information on the service `id`. | |||
|           } | ||||
|         }, | ||||
|         "UpdateConfig": { | ||||
|           "Parallelism": 1 | ||||
|           "Parallelism": 1, | ||||
|           "FailureAction": "pause" | ||||
|         }, | ||||
|         "EndpointSpec": { | ||||
|           "Mode": "VIP", | ||||
|           "Ingress": "PUBLICPORT", | ||||
|           "ExposedPorts": [ | ||||
|           "Mode": "vip", | ||||
|           "Ports": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "Port": 6379 | ||||
|               "TargetPort": 6379, | ||||
|               "PublishedPort": 30001 | ||||
|             } | ||||
|           ] | ||||
|         } | ||||
|       }, | ||||
|       "Endpoint": { | ||||
|         "Spec": {}, | ||||
|         "ExposedPorts": [ | ||||
|         "Spec": { | ||||
|           "Mode": "vip", | ||||
|           "Ports": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|             "Port": 6379, | ||||
|             "PublicPort": 30001 | ||||
|               "TargetPort": 6379, | ||||
|               "PublishedPort": 30001 | ||||
|             } | ||||
|           ] | ||||
|         }, | ||||
|         "Ports": [ | ||||
|           { | ||||
|             "Protocol": "tcp", | ||||
|             "TargetPort": 6379, | ||||
|             "PublishedPort": 30001 | ||||
|           } | ||||
|         ], | ||||
|         "VirtualIPs": [ | ||||
|  | @ -4828,7 +4850,7 @@ image](#create-an-image) section for more details. | |||
|       as part of this service. | ||||
|         - **Condition** – Condition for restart (`none`, `on-failure`, or `any`). | ||||
|         - **Delay** – Delay between restart attempts. | ||||
|         - **Attempts** – Maximum attempts to restart a given container before giving up (default value | ||||
|         - **MaxAttempts** – Maximum attempts to restart a given container before giving up (default value | ||||
|           is 0, which is ignored). | ||||
|         - **Window** – Windows is the time window used to evaluate the restart policy (default value is | ||||
|           0, which is unbounded). | ||||
|  | @ -4839,13 +4861,13 @@ image](#create-an-image) section for more details. | |||
|       parallelism). | ||||
|     - **Delay** – Amount of time between updates. | ||||
| - **Networks** – Array of network names or IDs to attach the service to. | ||||
| - **Endpoint** – Properties that can be configured to access and load balance a service. | ||||
|     - **Spec** – | ||||
| - **EndpointSpec** – Properties that can be configured to access and load balance a service. | ||||
|     - **Mode** – The mode of resolution to use for internal load balancing | ||||
|           between tasks (`vip` or `dnsrr`). | ||||
|         - **Ports** – Exposed ports that this service is accessible on from the outside, in the form | ||||
|           of: `"Ports": { "<port>/<tcp|udp>: {}" }` | ||||
|     - **VirtualIPs** | ||||
|       between tasks (`vip` or `dnsrr`). Defaults to `vip` if not provided. | ||||
|     - **Ports** – List of exposed ports that this service is accessible on from | ||||
|       the outside, in the form of: | ||||
|       `{"Protocol": <"tcp"|"udp">, "PublishedPort": <port>, "TargetPort": <port>}`. | ||||
|       Ports can only be provided if `vip` resolution mode is used. | ||||
| 
 | ||||
| **Query parameters**: | ||||
| 
 | ||||
|  | @ -4890,7 +4912,6 @@ List tasks | |||
|         }, | ||||
|         "CreatedAt": "2016-06-07T21:07:31.171892745Z", | ||||
|         "UpdatedAt": "2016-06-07T21:07:31.376370513Z", | ||||
|         "Name": "hopeful_cori", | ||||
|         "Spec": { | ||||
|           "ContainerSpec": { | ||||
|             "Image": "redis" | ||||
|  | @ -4900,21 +4921,24 @@ List tasks | |||
|             "Reservations": {} | ||||
|           }, | ||||
|           "RestartPolicy": { | ||||
|             "Condition": "ANY" | ||||
|             "Condition": "any", | ||||
|             "MaxAttempts": 0 | ||||
|           }, | ||||
|           "Placement": {} | ||||
|         }, | ||||
|         "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz", | ||||
|         "Instance": 1, | ||||
|         "NodeID": "24ifsmvkjbyhk", | ||||
|         "ServiceAnnotations": {}, | ||||
|         "Slot": 1, | ||||
|         "NodeID": "60gvrl6tm78dmak4yl7srz94v", | ||||
|         "Status": { | ||||
|           "Timestamp": "2016-06-07T21:07:31.290032978Z", | ||||
|           "State": "FAILED", | ||||
|           "Message": "execution failed", | ||||
|           "ContainerStatus": {} | ||||
|           "State": "running", | ||||
|           "Message": "started", | ||||
|           "ContainerStatus": { | ||||
|             "ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035", | ||||
|             "PID": 677 | ||||
|           } | ||||
|         }, | ||||
|         "DesiredState": "SHUTDOWN", | ||||
|         "DesiredState": "running", | ||||
|         "NetworksAttachments": [ | ||||
|           { | ||||
|             "Network": { | ||||
|  | @ -4930,12 +4954,12 @@ List tasks | |||
|                   "com.docker.swarm.internal": "true" | ||||
|                 }, | ||||
|                 "DriverConfiguration": {}, | ||||
|                 "IPAM": { | ||||
|                 "IPAMOptions": { | ||||
|                   "Driver": {}, | ||||
|                   "Configs": [ | ||||
|                     { | ||||
|                       "Family": "UNKNOWN", | ||||
|                       "Subnet": "10.255.0.0/16" | ||||
|                       "Subnet": "10.255.0.0/16", | ||||
|                       "Gateway": "10.255.0.1" | ||||
|                     } | ||||
|                   ] | ||||
|                 } | ||||
|  | @ -4946,14 +4970,14 @@ List tasks | |||
|                   "com.docker.network.driver.overlay.vxlanid_list": "256" | ||||
|                 } | ||||
|               }, | ||||
|               "IPAM": { | ||||
|               "IPAMOptions": { | ||||
|                 "Driver": { | ||||
|                   "Name": "default" | ||||
|                 }, | ||||
|                 "Configs": [ | ||||
|                   { | ||||
|                     "Family": "UNKNOWN", | ||||
|                     "Subnet": "10.255.0.0/16" | ||||
|                     "Subnet": "10.255.0.0/16", | ||||
|                     "Gateway": "10.255.0.1" | ||||
|                   } | ||||
|                 ] | ||||
|               } | ||||
|  | @ -4963,26 +4987,6 @@ List tasks | |||
|             ] | ||||
|           } | ||||
|         ], | ||||
|         "Endpoint": { | ||||
|           "Spec": {}, | ||||
|           "ExposedPorts": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "Port": 6379, | ||||
|               "PublicPort": 30000 | ||||
|             } | ||||
|           ], | ||||
|           "VirtualIPs": [ | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.2/16" | ||||
|             }, | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.3/16" | ||||
|             } | ||||
|           ] | ||||
|         } | ||||
|       }, | ||||
|       { | ||||
|         "ID": "1yljwbmlr8er2waf8orvqpwms", | ||||
|  | @ -5001,21 +5005,23 @@ List tasks | |||
|             "Reservations": {} | ||||
|           }, | ||||
|           "RestartPolicy": { | ||||
|             "Condition": "ANY" | ||||
|             "Condition": "any", | ||||
|             "MaxAttempts": 0 | ||||
|           }, | ||||
|           "Placement": {} | ||||
|         }, | ||||
|         "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz", | ||||
|         "Instance": 1, | ||||
|         "NodeID": "24ifsmvkjbyhk", | ||||
|         "ServiceAnnotations": {}, | ||||
|         "Slot": 1, | ||||
|         "NodeID": "60gvrl6tm78dmak4yl7srz94v", | ||||
|         "Status": { | ||||
|           "Timestamp": "2016-06-07T21:07:30.202183143Z", | ||||
|           "State": "FAILED", | ||||
|           "Message": "execution failed", | ||||
|           "ContainerStatus": {} | ||||
|           "State": "shutdown", | ||||
|           "Message": "shutdown", | ||||
|           "ContainerStatus": { | ||||
|             "ContainerID": "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213" | ||||
|           } | ||||
|         }, | ||||
|         "DesiredState": "SHUTDOWN", | ||||
|         "DesiredState": "shutdown", | ||||
|         "NetworksAttachments": [ | ||||
|           { | ||||
|             "Network": { | ||||
|  | @ -5031,12 +5037,12 @@ List tasks | |||
|                   "com.docker.swarm.internal": "true" | ||||
|                 }, | ||||
|                 "DriverConfiguration": {}, | ||||
|                 "IPAM": { | ||||
|                 "IPAMOptions": { | ||||
|                   "Driver": {}, | ||||
|                   "Configs": [ | ||||
|                     { | ||||
|                       "Family": "UNKNOWN", | ||||
|                       "Subnet": "10.255.0.0/16" | ||||
|                       "Subnet": "10.255.0.0/16", | ||||
|                       "Gateway": "10.255.0.1" | ||||
|                     } | ||||
|                   ] | ||||
|                 } | ||||
|  | @ -5047,14 +5053,14 @@ List tasks | |||
|                   "com.docker.network.driver.overlay.vxlanid_list": "256" | ||||
|                 } | ||||
|               }, | ||||
|               "IPAM": { | ||||
|               "IPAMOptions": { | ||||
|                 "Driver": { | ||||
|                   "Name": "default" | ||||
|                 }, | ||||
|                 "Configs": [ | ||||
|                   { | ||||
|                     "Family": "UNKNOWN", | ||||
|                     "Subnet": "10.255.0.0/16" | ||||
|                     "Subnet": "10.255.0.0/16", | ||||
|                     "Gateway": "10.255.0.1" | ||||
|                   } | ||||
|                 ] | ||||
|               } | ||||
|  | @ -5063,28 +5069,8 @@ List tasks | |||
|               "10.255.0.5/16" | ||||
|             ] | ||||
|           } | ||||
|         ], | ||||
|         "Endpoint": { | ||||
|           "Spec": {}, | ||||
|           "ExposedPorts": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "Port": 6379, | ||||
|               "PublicPort": 30000 | ||||
|             } | ||||
|           ], | ||||
|           "VirtualIPs": [ | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.2/16" | ||||
|             }, | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.3/16" | ||||
|             } | ||||
|         ] | ||||
|       } | ||||
|       } | ||||
|     ] | ||||
| 
 | ||||
| **Query parameters**: | ||||
|  | @ -5123,7 +5109,6 @@ Get details on a task | |||
|       }, | ||||
|       "CreatedAt": "2016-06-07T21:07:31.171892745Z", | ||||
|       "UpdatedAt": "2016-06-07T21:07:31.376370513Z", | ||||
|       "Name": "hopeful_cori", | ||||
|       "Spec": { | ||||
|         "ContainerSpec": { | ||||
|           "Image": "redis" | ||||
|  | @ -5133,21 +5118,24 @@ Get details on a task | |||
|           "Reservations": {} | ||||
|         }, | ||||
|         "RestartPolicy": { | ||||
|           "Condition": "ANY" | ||||
|           "Condition": "any", | ||||
|           "MaxAttempts": 0 | ||||
|         }, | ||||
|         "Placement": {} | ||||
|       }, | ||||
|       "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz", | ||||
|       "Instance": 1, | ||||
|       "NodeID": "24ifsmvkjbyhk", | ||||
|       "ServiceAnnotations": {}, | ||||
|       "Slot": 1, | ||||
|       "NodeID": "60gvrl6tm78dmak4yl7srz94v", | ||||
|       "Status": { | ||||
|         "Timestamp": "2016-06-07T21:07:31.290032978Z", | ||||
|         "State": "FAILED", | ||||
|         "Message": "execution failed", | ||||
|         "ContainerStatus": {} | ||||
|         "State": "running", | ||||
|         "Message": "started", | ||||
|         "ContainerStatus": { | ||||
|           "ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035", | ||||
|           "PID": 677 | ||||
|         } | ||||
|       }, | ||||
|       "DesiredState": "SHUTDOWN", | ||||
|       "DesiredState": "running", | ||||
|       "NetworksAttachments": [ | ||||
|         { | ||||
|           "Network": { | ||||
|  | @ -5163,12 +5151,12 @@ Get details on a task | |||
|                 "com.docker.swarm.internal": "true" | ||||
|               }, | ||||
|               "DriverConfiguration": {}, | ||||
|               "IPAM": { | ||||
|               "IPAMOptions": { | ||||
|                 "Driver": {}, | ||||
|                 "Configs": [ | ||||
|                   { | ||||
|                     "Family": "UNKNOWN", | ||||
|                     "Subnet": "10.255.0.0/16" | ||||
|                     "Subnet": "10.255.0.0/16", | ||||
|                     "Gateway": "10.255.0.1" | ||||
|                   } | ||||
|                 ] | ||||
|               } | ||||
|  | @ -5179,14 +5167,14 @@ Get details on a task | |||
|                 "com.docker.network.driver.overlay.vxlanid_list": "256" | ||||
|               } | ||||
|             }, | ||||
|             "IPAM": { | ||||
|             "IPAMOptions": { | ||||
|               "Driver": { | ||||
|                 "Name": "default" | ||||
|               }, | ||||
|               "Configs": [ | ||||
|                 { | ||||
|                   "Family": "UNKNOWN", | ||||
|                   "Subnet": "10.255.0.0/16" | ||||
|                   "Subnet": "10.255.0.0/16", | ||||
|                   "Gateway": "10.255.0.1" | ||||
|                 } | ||||
|               ] | ||||
|             } | ||||
|  | @ -5195,28 +5183,8 @@ Get details on a task | |||
|             "10.255.0.10/16" | ||||
|           ] | ||||
|         } | ||||
|       ], | ||||
|       "Endpoint": { | ||||
|         "Spec": {}, | ||||
|         "ExposedPorts": [ | ||||
|           { | ||||
|             "Protocol": "tcp", | ||||
|             "Port": 6379, | ||||
|             "PublicPort": 30000 | ||||
|           } | ||||
|         ], | ||||
|         "VirtualIPs": [ | ||||
|           { | ||||
|             "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|             "Addr": "10.255.0.2/16" | ||||
|           }, | ||||
|           { | ||||
|             "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|             "Addr": "10.255.0.3/16" | ||||
|           } | ||||
|       ] | ||||
|     } | ||||
|     } | ||||
| 
 | ||||
| **Status codes**: | ||||
| 
 | ||||
|  |  | |||
|  | @ -4433,7 +4433,8 @@ List services | |||
|               "Reservations": {} | ||||
|             }, | ||||
|             "RestartPolicy": { | ||||
|               "Condition": "ANY" | ||||
|               "Condition": "any", | ||||
|               "MaxAttempts": 0 | ||||
|             }, | ||||
|             "Placement": {} | ||||
|           }, | ||||
|  | @ -4443,26 +4444,36 @@ List services | |||
|             } | ||||
|           }, | ||||
|           "UpdateConfig": { | ||||
|             "Parallelism": 1 | ||||
|             "Parallelism": 1, | ||||
|             "FailureAction": "pause" | ||||
|           }, | ||||
|           "EndpointSpec": { | ||||
|             "Mode": "VIP", | ||||
|             "Ingress": "PUBLICPORT", | ||||
|             "ExposedPorts": [ | ||||
|             "Mode": "vip", | ||||
|             "Ports": [ | ||||
|               { | ||||
|                 "Protocol": "tcp", | ||||
|                 "Port": 6379 | ||||
|                 "TargetPort": 6379, | ||||
|                 "PublishedPort": 30001 | ||||
|               } | ||||
|             ] | ||||
|           } | ||||
|         }, | ||||
|         "Endpoint": { | ||||
|           "Spec": {}, | ||||
|           "ExposedPorts": [ | ||||
|           "Spec": { | ||||
|             "Mode": "vip", | ||||
|             "Ports": [ | ||||
|               { | ||||
|                 "Protocol": "tcp", | ||||
|               "Port": 6379, | ||||
|               "PublicPort": 30000 | ||||
|                 "TargetPort": 6379, | ||||
|                 "PublishedPort": 30001 | ||||
|               } | ||||
|             ] | ||||
|           }, | ||||
|           "Ports": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "TargetPort": 6379, | ||||
|               "PublishedPort": 30001 | ||||
|             } | ||||
|           ], | ||||
|           "VirtualIPs": [ | ||||
|  | @ -4648,13 +4659,13 @@ image](#create-an-image) section for more details. | |||
|     - **FailureAction** - Action to take if an updated task fails to run, or stops running during the | ||||
|       update. Values are `continue` and `pause`. | ||||
| - **Networks** – Array of network names or IDs to attach the service to. | ||||
| - **Endpoint** – Properties that can be configured to access and load balance a service. | ||||
|     - **Spec** – | ||||
| - **EndpointSpec** – Properties that can be configured to access and load balance a service. | ||||
|     - **Mode** – The mode of resolution to use for internal load balancing | ||||
|           between tasks (`vip` or `dnsrr`). | ||||
|         - **Ports** – Exposed ports that this service is accessible on from the outside, in the form | ||||
|           of: `"Ports": { "<port>/<tcp|udp>: {}" }` | ||||
|     - **VirtualIPs** | ||||
|       between tasks (`vip` or `dnsrr`). Defaults to `vip` if not provided. | ||||
|     - **Ports** – List of exposed ports that this service is accessible on from | ||||
|       the outside, in the form of: | ||||
|       `{"Protocol": <"tcp"|"udp">, "PublishedPort": <port>, "TargetPort": <port>}`. | ||||
|       Ports can only be provided if `vip` resolution mode is used. | ||||
| 
 | ||||
| **Request Headers**: | ||||
| 
 | ||||
|  | @ -4707,7 +4718,7 @@ Return information on the service `id`. | |||
|       "UpdatedAt": "2016-06-07T21:10:20.276301259Z", | ||||
|       "Spec": { | ||||
|         "Name": "redis", | ||||
|         "Task": { | ||||
|         "TaskTemplate": { | ||||
|           "ContainerSpec": { | ||||
|             "Image": "redis" | ||||
|           }, | ||||
|  | @ -4716,7 +4727,8 @@ Return information on the service `id`. | |||
|             "Reservations": {} | ||||
|           }, | ||||
|           "RestartPolicy": { | ||||
|             "Condition": "ANY" | ||||
|             "Condition": "any", | ||||
|             "MaxAttempts": 0 | ||||
|           }, | ||||
|           "Placement": {} | ||||
|         }, | ||||
|  | @ -4726,26 +4738,36 @@ Return information on the service `id`. | |||
|           } | ||||
|         }, | ||||
|         "UpdateConfig": { | ||||
|           "Parallelism": 1 | ||||
|           "Parallelism": 1, | ||||
|           "FailureAction": "pause" | ||||
|         }, | ||||
|         "EndpointSpec": { | ||||
|           "Mode": "VIP", | ||||
|           "Ingress": "PUBLICPORT", | ||||
|           "ExposedPorts": [ | ||||
|           "Mode": "vip", | ||||
|           "Ports": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "Port": 6379 | ||||
|               "TargetPort": 6379, | ||||
|               "PublishedPort": 30001 | ||||
|             } | ||||
|           ] | ||||
|         } | ||||
|       }, | ||||
|       "Endpoint": { | ||||
|         "Spec": {}, | ||||
|         "ExposedPorts": [ | ||||
|         "Spec": { | ||||
|           "Mode": "vip", | ||||
|           "Ports": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|             "Port": 6379, | ||||
|             "PublicPort": 30001 | ||||
|               "TargetPort": 6379, | ||||
|               "PublishedPort": 30001 | ||||
|             } | ||||
|           ] | ||||
|         }, | ||||
|         "Ports": [ | ||||
|           { | ||||
|             "Protocol": "tcp", | ||||
|             "TargetPort": 6379, | ||||
|             "PublishedPort": 30001 | ||||
|           } | ||||
|         ], | ||||
|         "VirtualIPs": [ | ||||
|  | @ -4859,7 +4881,7 @@ image](#create-an-image) section for more details. | |||
|       as part of this service. | ||||
|         - **Condition** – Condition for restart (`none`, `on-failure`, or `any`). | ||||
|         - **Delay** – Delay between restart attempts. | ||||
|         - **Attempts** – Maximum attempts to restart a given container before giving up (default value | ||||
|         - **MaxAttempts** – Maximum attempts to restart a given container before giving up (default value | ||||
|           is 0, which is ignored). | ||||
|         - **Window** – Windows is the time window used to evaluate the restart policy (default value is | ||||
|           0, which is unbounded). | ||||
|  | @ -4870,13 +4892,13 @@ image](#create-an-image) section for more details. | |||
|       parallelism). | ||||
|     - **Delay** – Amount of time between updates. | ||||
| - **Networks** – Array of network names or IDs to attach the service to. | ||||
| - **Endpoint** – Properties that can be configured to access and load balance a service. | ||||
|     - **Spec** – | ||||
| - **EndpointSpec** – Properties that can be configured to access and load balance a service. | ||||
|     - **Mode** – The mode of resolution to use for internal load balancing | ||||
|           between tasks (`vip` or `dnsrr`). | ||||
|         - **Ports** – Exposed ports that this service is accessible on from the outside, in the form | ||||
|           of: `"Ports": { "<port>/<tcp|udp>: {}" }` | ||||
|     - **VirtualIPs** | ||||
|       between tasks (`vip` or `dnsrr`). Defaults to `vip` if not provided. | ||||
|     - **Ports** – List of exposed ports that this service is accessible on from | ||||
|       the outside, in the form of: | ||||
|       `{"Protocol": <"tcp"|"udp">, "PublishedPort": <port>, "TargetPort": <port>}`. | ||||
|       Ports can only be provided if `vip` resolution mode is used. | ||||
| 
 | ||||
| **Query parameters**: | ||||
| 
 | ||||
|  | @ -4921,7 +4943,6 @@ List tasks | |||
|         }, | ||||
|         "CreatedAt": "2016-06-07T21:07:31.171892745Z", | ||||
|         "UpdatedAt": "2016-06-07T21:07:31.376370513Z", | ||||
|         "Name": "hopeful_cori", | ||||
|         "Spec": { | ||||
|           "ContainerSpec": { | ||||
|             "Image": "redis" | ||||
|  | @ -4931,21 +4952,24 @@ List tasks | |||
|             "Reservations": {} | ||||
|           }, | ||||
|           "RestartPolicy": { | ||||
|             "Condition": "ANY" | ||||
|             "Condition": "any", | ||||
|             "MaxAttempts": 0 | ||||
|           }, | ||||
|           "Placement": {} | ||||
|         }, | ||||
|         "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz", | ||||
|         "Instance": 1, | ||||
|         "NodeID": "24ifsmvkjbyhk", | ||||
|         "ServiceAnnotations": {}, | ||||
|         "Slot": 1, | ||||
|         "NodeID": "60gvrl6tm78dmak4yl7srz94v", | ||||
|         "Status": { | ||||
|           "Timestamp": "2016-06-07T21:07:31.290032978Z", | ||||
|           "State": "FAILED", | ||||
|           "Message": "execution failed", | ||||
|           "ContainerStatus": {} | ||||
|           "State": "running", | ||||
|           "Message": "started", | ||||
|           "ContainerStatus": { | ||||
|             "ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035", | ||||
|             "PID": 677 | ||||
|           } | ||||
|         }, | ||||
|         "DesiredState": "SHUTDOWN", | ||||
|         "DesiredState": "running", | ||||
|         "NetworksAttachments": [ | ||||
|           { | ||||
|             "Network": { | ||||
|  | @ -4961,12 +4985,12 @@ List tasks | |||
|                   "com.docker.swarm.internal": "true" | ||||
|                 }, | ||||
|                 "DriverConfiguration": {}, | ||||
|                 "IPAM": { | ||||
|                 "IPAMOptions": { | ||||
|                   "Driver": {}, | ||||
|                   "Configs": [ | ||||
|                     { | ||||
|                       "Family": "UNKNOWN", | ||||
|                       "Subnet": "10.255.0.0/16" | ||||
|                       "Subnet": "10.255.0.0/16", | ||||
|                       "Gateway": "10.255.0.1" | ||||
|                     } | ||||
|                   ] | ||||
|                 } | ||||
|  | @ -4977,14 +5001,14 @@ List tasks | |||
|                   "com.docker.network.driver.overlay.vxlanid_list": "256" | ||||
|                 } | ||||
|               }, | ||||
|               "IPAM": { | ||||
|               "IPAMOptions": { | ||||
|                 "Driver": { | ||||
|                   "Name": "default" | ||||
|                 }, | ||||
|                 "Configs": [ | ||||
|                   { | ||||
|                     "Family": "UNKNOWN", | ||||
|                     "Subnet": "10.255.0.0/16" | ||||
|                     "Subnet": "10.255.0.0/16", | ||||
|                     "Gateway": "10.255.0.1" | ||||
|                   } | ||||
|                 ] | ||||
|               } | ||||
|  | @ -4994,26 +5018,6 @@ List tasks | |||
|             ] | ||||
|           } | ||||
|         ], | ||||
|         "Endpoint": { | ||||
|           "Spec": {}, | ||||
|           "ExposedPorts": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "Port": 6379, | ||||
|               "PublicPort": 30000 | ||||
|             } | ||||
|           ], | ||||
|           "VirtualIPs": [ | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.2/16" | ||||
|             }, | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.3/16" | ||||
|             } | ||||
|           ] | ||||
|         } | ||||
|       }, | ||||
|       { | ||||
|         "ID": "1yljwbmlr8er2waf8orvqpwms", | ||||
|  | @ -5032,21 +5036,23 @@ List tasks | |||
|             "Reservations": {} | ||||
|           }, | ||||
|           "RestartPolicy": { | ||||
|             "Condition": "ANY" | ||||
|             "Condition": "any", | ||||
|             "MaxAttempts": 0 | ||||
|           }, | ||||
|           "Placement": {} | ||||
|         }, | ||||
|         "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz", | ||||
|         "Instance": 1, | ||||
|         "NodeID": "24ifsmvkjbyhk", | ||||
|         "ServiceAnnotations": {}, | ||||
|         "Slot": 1, | ||||
|         "NodeID": "60gvrl6tm78dmak4yl7srz94v", | ||||
|         "Status": { | ||||
|           "Timestamp": "2016-06-07T21:07:30.202183143Z", | ||||
|           "State": "FAILED", | ||||
|           "Message": "execution failed", | ||||
|           "ContainerStatus": {} | ||||
|           "State": "shutdown", | ||||
|           "Message": "shutdown", | ||||
|           "ContainerStatus": { | ||||
|             "ContainerID": "1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213" | ||||
|           } | ||||
|         }, | ||||
|         "DesiredState": "SHUTDOWN", | ||||
|         "DesiredState": "shutdown", | ||||
|         "NetworksAttachments": [ | ||||
|           { | ||||
|             "Network": { | ||||
|  | @ -5062,12 +5068,12 @@ List tasks | |||
|                   "com.docker.swarm.internal": "true" | ||||
|                 }, | ||||
|                 "DriverConfiguration": {}, | ||||
|                 "IPAM": { | ||||
|                 "IPAMOptions": { | ||||
|                   "Driver": {}, | ||||
|                   "Configs": [ | ||||
|                     { | ||||
|                       "Family": "UNKNOWN", | ||||
|                       "Subnet": "10.255.0.0/16" | ||||
|                       "Subnet": "10.255.0.0/16", | ||||
|                       "Gateway": "10.255.0.1" | ||||
|                     } | ||||
|                   ] | ||||
|                 } | ||||
|  | @ -5078,14 +5084,14 @@ List tasks | |||
|                   "com.docker.network.driver.overlay.vxlanid_list": "256" | ||||
|                 } | ||||
|               }, | ||||
|               "IPAM": { | ||||
|               "IPAMOptions": { | ||||
|                 "Driver": { | ||||
|                   "Name": "default" | ||||
|                 }, | ||||
|                 "Configs": [ | ||||
|                   { | ||||
|                     "Family": "UNKNOWN", | ||||
|                     "Subnet": "10.255.0.0/16" | ||||
|                     "Subnet": "10.255.0.0/16", | ||||
|                     "Gateway": "10.255.0.1" | ||||
|                   } | ||||
|                 ] | ||||
|               } | ||||
|  | @ -5094,28 +5100,8 @@ List tasks | |||
|               "10.255.0.5/16" | ||||
|             ] | ||||
|           } | ||||
|         ], | ||||
|         "Endpoint": { | ||||
|           "Spec": {}, | ||||
|           "ExposedPorts": [ | ||||
|             { | ||||
|               "Protocol": "tcp", | ||||
|               "Port": 6379, | ||||
|               "PublicPort": 30000 | ||||
|             } | ||||
|           ], | ||||
|           "VirtualIPs": [ | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.2/16" | ||||
|             }, | ||||
|             { | ||||
|               "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|               "Addr": "10.255.0.3/16" | ||||
|             } | ||||
|         ] | ||||
|       } | ||||
|       } | ||||
|     ] | ||||
| 
 | ||||
| **Query parameters**: | ||||
|  | @ -5154,7 +5140,6 @@ Get details on a task | |||
|       }, | ||||
|       "CreatedAt": "2016-06-07T21:07:31.171892745Z", | ||||
|       "UpdatedAt": "2016-06-07T21:07:31.376370513Z", | ||||
|       "Name": "hopeful_cori", | ||||
|       "Spec": { | ||||
|         "ContainerSpec": { | ||||
|           "Image": "redis" | ||||
|  | @ -5164,21 +5149,24 @@ Get details on a task | |||
|           "Reservations": {} | ||||
|         }, | ||||
|         "RestartPolicy": { | ||||
|           "Condition": "ANY" | ||||
|           "Condition": "any", | ||||
|           "MaxAttempts": 0 | ||||
|         }, | ||||
|         "Placement": {} | ||||
|       }, | ||||
|       "ServiceID": "9mnpnzenvg8p8tdbtq4wvbkcz", | ||||
|       "Instance": 1, | ||||
|       "NodeID": "24ifsmvkjbyhk", | ||||
|       "ServiceAnnotations": {}, | ||||
|       "Slot": 1, | ||||
|       "NodeID": "60gvrl6tm78dmak4yl7srz94v", | ||||
|       "Status": { | ||||
|         "Timestamp": "2016-06-07T21:07:31.290032978Z", | ||||
|         "State": "FAILED", | ||||
|         "Message": "execution failed", | ||||
|         "ContainerStatus": {} | ||||
|         "State": "running", | ||||
|         "Message": "started", | ||||
|         "ContainerStatus": { | ||||
|           "ContainerID": "e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035", | ||||
|           "PID": 677 | ||||
|         } | ||||
|       }, | ||||
|       "DesiredState": "SHUTDOWN", | ||||
|       "DesiredState": "running", | ||||
|       "NetworksAttachments": [ | ||||
|         { | ||||
|           "Network": { | ||||
|  | @ -5194,12 +5182,12 @@ Get details on a task | |||
|                 "com.docker.swarm.internal": "true" | ||||
|               }, | ||||
|               "DriverConfiguration": {}, | ||||
|               "IPAM": { | ||||
|               "IPAMOptions": { | ||||
|                 "Driver": {}, | ||||
|                 "Configs": [ | ||||
|                   { | ||||
|                     "Family": "UNKNOWN", | ||||
|                     "Subnet": "10.255.0.0/16" | ||||
|                     "Subnet": "10.255.0.0/16", | ||||
|                     "Gateway": "10.255.0.1" | ||||
|                   } | ||||
|                 ] | ||||
|               } | ||||
|  | @ -5210,14 +5198,14 @@ Get details on a task | |||
|                 "com.docker.network.driver.overlay.vxlanid_list": "256" | ||||
|               } | ||||
|             }, | ||||
|             "IPAM": { | ||||
|             "IPAMOptions": { | ||||
|               "Driver": { | ||||
|                 "Name": "default" | ||||
|               }, | ||||
|               "Configs": [ | ||||
|                 { | ||||
|                   "Family": "UNKNOWN", | ||||
|                   "Subnet": "10.255.0.0/16" | ||||
|                   "Subnet": "10.255.0.0/16", | ||||
|                   "Gateway": "10.255.0.1" | ||||
|                 } | ||||
|               ] | ||||
|             } | ||||
|  | @ -5226,28 +5214,8 @@ Get details on a task | |||
|             "10.255.0.10/16" | ||||
|           ] | ||||
|         } | ||||
|       ], | ||||
|       "Endpoint": { | ||||
|         "Spec": {}, | ||||
|         "ExposedPorts": [ | ||||
|           { | ||||
|             "Protocol": "tcp", | ||||
|             "Port": 6379, | ||||
|             "PublicPort": 30000 | ||||
|           } | ||||
|         ], | ||||
|         "VirtualIPs": [ | ||||
|           { | ||||
|             "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|             "Addr": "10.255.0.2/16" | ||||
|           }, | ||||
|           { | ||||
|             "NetworkID": "4qvuz4ko70xaltuqbt8956gd1", | ||||
|             "Addr": "10.255.0.3/16" | ||||
|           } | ||||
|       ] | ||||
|     } | ||||
|     } | ||||
| 
 | ||||
| **Status codes**: | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
		Reference in New Issue