mirror of https://github.com/docker/docs.git
docs: update remote API responses and minor fixes
Add back the "old" networksettings fields that were removed, but added back to maintain backward compatibility, in https://github.com/docker/docker/pull/17538 Update network endpoint responses, with updated response introduced in; https://github.com/docker/docker/pull/17536 Added changes to v1.22 that were applied to the v1.21 / v1.20 docs after the API bump(s); https://github.com/docker/docker/pull/17085 https://github.com/docker/docker/pull/17127 https://github.com/docker/docker/pull/13707 Also fixed some mixed tab/spaces indentation and Markdown formatting issues (causing code-blocks to be rendered incorrectly) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
parent
05a4cb2221
commit
286fe69d53
|
|
@ -116,6 +116,16 @@ list of DNS options to be used in the container.
|
|||
* `GET /containers/json` will return `ImageID` of the image used by container.
|
||||
* `POST /exec/(name)/start` will now return an HTTP 409 when the container is either stopped or paused.
|
||||
* `GET /containers/(name)/json` now accepts a `size` parameter. Setting this parameter to '1' returns container size information in the `SizeRw` and `SizeRootFs` fields.
|
||||
* `GET /containers/(name)/json` now returns a `NetworkSettings.Networks` field,
|
||||
detailing network settings per network. This field deprecates the
|
||||
`NetworkSettings.Gateway`, `NetworkSettings.IPAddress`,
|
||||
`NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which
|
||||
are still returned for backward-compatibility, but will be removed in a future version.
|
||||
* `GET /exec/(id)/json` now returns a `NetworkSettings.Networks` field,
|
||||
detailing networksettings per network. This field deprecates the
|
||||
`NetworkSettings.Gateway`, `NetworkSettings.IPAddress`,
|
||||
`NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which
|
||||
are still returned for backward-compatibility, but will be removed in a future version.
|
||||
|
||||
### v1.20 API changes
|
||||
|
||||
|
|
|
|||
|
|
@ -2141,12 +2141,12 @@ Status Codes:
|
|||
|
||||
`POST /exec/(id)/resize`
|
||||
|
||||
Resizes the `tty` session used by the `exec` command `id`.
|
||||
Resizes the `tty` session used by the `exec` command `id`. The unit is number of characters.
|
||||
This API is valid only if `tty` was specified as part of creating and starting the `exec` command.
|
||||
|
||||
**Example request**:
|
||||
|
||||
POST /exec/e90e34656806/resize HTTP/1.1
|
||||
POST /exec/e90e34656806/resize?h=40&w=80 HTTP/1.1
|
||||
Content-Type: text/plain
|
||||
|
||||
**Example response**:
|
||||
|
|
@ -2257,7 +2257,7 @@ Return low-level information about the `exec` command `id`.
|
|||
"ProcessLabel" : "",
|
||||
"AppArmorProfile" : "",
|
||||
"RestartCount" : 0,
|
||||
"Mounts" : [],
|
||||
"Mounts" : []
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -441,15 +441,23 @@ Return low-level information on the container `id`
|
|||
"HairpinMode": false,
|
||||
"LinkLocalIPv6Address": "",
|
||||
"LinkLocalIPv6PrefixLen": 0,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": [],
|
||||
"SecondaryIPv6Addresses": [],
|
||||
"Ports": null,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": null,
|
||||
"SecondaryIPv6Addresses": null,
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
"GlobalIPv6PrefixLen": 0,
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"MacAddress": "",
|
||||
"Networks": {
|
||||
"bridge": {
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"IPAdress": "",
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
|
|
@ -562,7 +570,7 @@ Status Codes:
|
|||
Get `stdout` and `stderr` logs from the container ``id``
|
||||
|
||||
> **Note**:
|
||||
> This endpoint works only for containers with `json-file` logging driver.
|
||||
> This endpoint works only for containers with the `json-file` or `journald` logging drivers.
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
@ -2390,15 +2398,23 @@ Return low-level information about the `exec` command `id`.
|
|||
"HairpinMode": false,
|
||||
"LinkLocalIPv6Address": "",
|
||||
"LinkLocalIPv6PrefixLen": 0,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": [],
|
||||
"SecondaryIPv6Addresses": [],
|
||||
"Ports": null,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": null,
|
||||
"SecondaryIPv6Addresses": null,
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
"GlobalIPv6PrefixLen": 0,
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"MacAddress": "",
|
||||
"Networks": {
|
||||
"bridge": {
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"IPAdress": "",
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
|
|
@ -2483,7 +2499,7 @@ Create a volume
|
|||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"Name": "tardis"
|
||||
"Name": "tardis",
|
||||
"Driver": "local",
|
||||
"Mountpoint": "/var/lib/docker/volumes/tardis"
|
||||
}
|
||||
|
|
@ -2560,28 +2576,64 @@ Status Codes
|
|||
|
||||
**Example response**:
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
[
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4",
|
||||
"driver": "bridge",
|
||||
"containers": {}
|
||||
"Name": "bridge",
|
||||
"Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
|
||||
"Scope": "local",
|
||||
"Driver": "bridge",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": [
|
||||
{
|
||||
"Subnet": "172.17.0.0/16"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Containers": {
|
||||
"39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
||||
"EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda",
|
||||
"MacAddress": "02:42:ac:11:00:02",
|
||||
"IPv4Address": "172.17.0.2/16",
|
||||
"IPv6Address": ""
|
||||
}
|
||||
},
|
||||
"Options": {
|
||||
"com.docker.network.bridge.default_bridge": "true",
|
||||
"com.docker.network.bridge.enable_icc": "true",
|
||||
"com.docker.network.bridge.enable_ip_masquerade": "true",
|
||||
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
|
||||
"com.docker.network.bridge.name": "docker0",
|
||||
"com.docker.network.driver.mtu": "1500"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "none",
|
||||
"id": "21e34df9b29c74ae45ba312f8e9f83c02433c9a877cfebebcf57be78f69b77c8",
|
||||
"driver": "null",
|
||||
"containers": {}
|
||||
"Name": "none",
|
||||
"Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794",
|
||||
"Scope": "local",
|
||||
"Driver": "null",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": []
|
||||
},
|
||||
"Containers": {},
|
||||
"Options": {}
|
||||
},
|
||||
{
|
||||
"name": "host",
|
||||
"id": "3f43a0873f00310a71cd6a71e2e60c113cf17d1812be2ec22fd519fbac68ec91",
|
||||
"driver": "host",
|
||||
"containers": {}
|
||||
"Name": "host",
|
||||
"Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e",
|
||||
"Scope": "local",
|
||||
"Driver": "host",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": []
|
||||
},
|
||||
"Containers": {},
|
||||
"Options": {}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
|
@ -2603,37 +2655,42 @@ Status Codes:
|
|||
|
||||
**Example request**:
|
||||
|
||||
GET /networks/f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4 HTTP/1.1
|
||||
GET /networks/f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566 HTTP/1.1
|
||||
|
||||
**Example response**:
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4",
|
||||
"driver": "bridge",
|
||||
"containers": {
|
||||
"931d29e96e63022a3691f55ca18b28600239acf53878451975f77054b05ba559": {
|
||||
"endpoint": "aa79321e2899e6d72fcd46e6a4ad7f81ab9a19c3b06e384ef4ce51fea35827f9",
|
||||
"mac_address": "02:42:ac:11:00:04",
|
||||
"ipv4_address": "172.17.0.4/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"961249b4ae6c764b11eed923e8463c102689111fffd933627b2e7e359c7d0f7c": {
|
||||
"endpoint": "4f62c5aea6b9a70512210be7db976bd4ec2cdba47125e4fe514d18c81b1624b1",
|
||||
"mac_address": "02:42:ac:11:00:02",
|
||||
"ipv4_address": "172.17.0.2/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"9f6e0fec4449f42a173ed85be96dc2253b6719edd850d8169bc31bdc45db675c": {
|
||||
"endpoint": "352b512a5bccdfc77d16c2c04d04408e718f879a16f9ce3913a4733139e4f98d",
|
||||
"mac_address": "02:42:ac:11:00:03",
|
||||
"ipv4_address": "172.17.0.3/16",
|
||||
"ipv6_address": ""
|
||||
"Name": "bridge",
|
||||
"Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
|
||||
"Scope": "local",
|
||||
"Driver": "bridge",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": [
|
||||
{
|
||||
"Subnet": "172.17.0.0/16"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Containers": {
|
||||
"39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
||||
"EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda",
|
||||
"MacAddress": "02:42:ac:11:00:02",
|
||||
"IPv4Address": "172.17.0.2/16",
|
||||
"IPv6Address": ""
|
||||
}
|
||||
},
|
||||
"Options": {
|
||||
"com.docker.network.bridge.default_bridge": "true",
|
||||
"com.docker.network.bridge.enable_icc": "true",
|
||||
"com.docker.network.bridge.enable_ip_masquerade": "true",
|
||||
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
|
||||
"com.docker.network.bridge.name": "docker0",
|
||||
"com.docker.network.driver.mtu": "1500"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -2651,25 +2708,25 @@ Create a network
|
|||
|
||||
**Example request**:
|
||||
|
||||
```
|
||||
POST /networks/create HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"name":"isolated_nw",
|
||||
"driver":"bridge"
|
||||
"Name":"isolated_nw",
|
||||
"Driver":"bridge"
|
||||
}
|
||||
```
|
||||
|
||||
**Example response**:
|
||||
|
||||
```
|
||||
HTTP/1.1 201 Created
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30",
|
||||
"warning": ""
|
||||
"Id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30",
|
||||
"Warning": ""
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -2681,10 +2738,10 @@ Status Codes:
|
|||
|
||||
JSON Parameters:
|
||||
|
||||
- **name** - The new network's name. this is a mandatory field
|
||||
- **driver** - Name of the network driver to use. Defaults to `bridge` driver
|
||||
- **options** - Network specific options to be used by the drivers
|
||||
- **check_duplicate** - Requests daemon to check for networks with same name
|
||||
- **Name** - The new network's name. this is a mandatory field
|
||||
- **Driver** - Name of the network driver to use. Defaults to `bridge` driver
|
||||
- **Options** - Network specific options to be used by the drivers
|
||||
- **CheckDuplicate** - Requests daemon to check for networks with same name
|
||||
|
||||
### Connect a container to a network
|
||||
|
||||
|
|
@ -2694,12 +2751,12 @@ Connects a container to a network
|
|||
|
||||
**Example request**:
|
||||
|
||||
```
|
||||
POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"container":"3613f73ba0e4"
|
||||
"Container":"3613f73ba0e4"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -2724,12 +2781,12 @@ Disconnects a container from a network
|
|||
|
||||
**Example request**:
|
||||
|
||||
```
|
||||
POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"container":"3613f73ba0e4"
|
||||
"Container":"3613f73ba0e4"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -2744,7 +2801,7 @@ Status Codes:
|
|||
|
||||
JSON Parameters:
|
||||
|
||||
- **container** - container-id/name to be disconnected from a network
|
||||
- **Container** - container-id/name to be disconnected from a network
|
||||
|
||||
### Remove a network
|
||||
|
||||
|
|
|
|||
|
|
@ -266,6 +266,8 @@ Json Parameters:
|
|||
+ `container_path` to create a new volume for the container
|
||||
+ `host_path:container_path` to bind-mount a host path into the container
|
||||
+ `host_path:container_path:ro` to make the bind-mount read-only inside the container.
|
||||
+ `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
|
||||
+ `volume_name:container_path:ro` to make the bind mount read-only inside the container.
|
||||
- **Links** - A list of links for the container. Each link entry should be
|
||||
in the form of `container_name:alias`.
|
||||
- **LxcConf** - LXC specific configurations. These configurations only
|
||||
|
|
@ -440,15 +442,23 @@ Return low-level information on the container `id`
|
|||
"HairpinMode": false,
|
||||
"LinkLocalIPv6Address": "",
|
||||
"LinkLocalIPv6PrefixLen": 0,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": [],
|
||||
"SecondaryIPv6Addresses": [],
|
||||
"Ports": null,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": null,
|
||||
"SecondaryIPv6Addresses": null,
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
"GlobalIPv6PrefixLen": 0,
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"MacAddress": "",
|
||||
"Networks": {
|
||||
"bridge": {
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"IPAdress": "",
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
|
|
@ -561,7 +571,7 @@ Status Codes:
|
|||
Get `stdout` and `stderr` logs from the container ``id``
|
||||
|
||||
> **Note**:
|
||||
> This endpoint works only for containers with `json-file` logging driver.
|
||||
> This endpoint works only for containers with the `json-file` or `journald` logging drivers.
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
@ -1482,12 +1492,15 @@ a base64-encoded AuthConfig object.
|
|||
|
||||
Query Parameters:
|
||||
|
||||
- **fromImage** – Name of the image to pull.
|
||||
- **fromImage** – Name of the image to pull. The name may include a tag or
|
||||
digest. This parameter may only be used when pulling an image.
|
||||
- **fromSrc** – Source to import. The value may be a URL from which the image
|
||||
can be retrieved or `-` to read the image from the request body.
|
||||
- **repo** – Repository name.
|
||||
- **tag** – Tag.
|
||||
- **registry** – The registry to pull from.
|
||||
This parameter may only be used when importing an image.
|
||||
- **repo** – Repository name given to an image when it is imported.
|
||||
The repo may include a tag. This parameter may only be used when importing
|
||||
an image.
|
||||
- **tag** – Tag or digest.
|
||||
|
||||
Request Headers:
|
||||
|
||||
|
|
@ -2386,15 +2399,23 @@ Return low-level information about the `exec` command `id`.
|
|||
"HairpinMode": false,
|
||||
"LinkLocalIPv6Address": "",
|
||||
"LinkLocalIPv6PrefixLen": 0,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": [],
|
||||
"SecondaryIPv6Addresses": [],
|
||||
"Ports": null,
|
||||
"SandboxKey": "",
|
||||
"SecondaryIPAddresses": null,
|
||||
"SecondaryIPv6Addresses": null,
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
"GlobalIPv6PrefixLen": 0,
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"MacAddress": "",
|
||||
"Networks": {
|
||||
"bridge": {
|
||||
"EndpointID": "",
|
||||
"Gateway": "",
|
||||
"IPAdress": "",
|
||||
"IPAddress": "",
|
||||
"IPPrefixLen": 0,
|
||||
"IPv6Gateway": "",
|
||||
"GlobalIPv6Address": "",
|
||||
|
|
@ -2451,7 +2472,7 @@ Status Codes:
|
|||
|
||||
Query Parameters:
|
||||
|
||||
- **filter** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true`
|
||||
- **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. There is one available filter: `dangling=true`
|
||||
|
||||
Status Codes:
|
||||
|
||||
|
|
@ -2479,7 +2500,7 @@ Create a volume
|
|||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"Name": "tardis"
|
||||
"Name": "tardis",
|
||||
"Driver": "local",
|
||||
"Mountpoint": "/var/lib/docker/volumes/tardis"
|
||||
}
|
||||
|
|
@ -2556,28 +2577,64 @@ Status Codes
|
|||
|
||||
**Example response**:
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
[
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4",
|
||||
"driver": "bridge",
|
||||
"containers": {}
|
||||
"Name": "bridge",
|
||||
"Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
|
||||
"Scope": "local",
|
||||
"Driver": "bridge",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": [
|
||||
{
|
||||
"Subnet": "172.17.0.0/16"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Containers": {
|
||||
"39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
||||
"EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda",
|
||||
"MacAddress": "02:42:ac:11:00:02",
|
||||
"IPv4Address": "172.17.0.2/16",
|
||||
"IPv6Address": ""
|
||||
}
|
||||
},
|
||||
"Options": {
|
||||
"com.docker.network.bridge.default_bridge": "true",
|
||||
"com.docker.network.bridge.enable_icc": "true",
|
||||
"com.docker.network.bridge.enable_ip_masquerade": "true",
|
||||
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
|
||||
"com.docker.network.bridge.name": "docker0",
|
||||
"com.docker.network.driver.mtu": "1500"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "none",
|
||||
"id": "21e34df9b29c74ae45ba312f8e9f83c02433c9a877cfebebcf57be78f69b77c8",
|
||||
"driver": "null",
|
||||
"containers": {}
|
||||
"Name": "none",
|
||||
"Id": "e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794",
|
||||
"Scope": "local",
|
||||
"Driver": "null",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": []
|
||||
},
|
||||
"Containers": {},
|
||||
"Options": {}
|
||||
},
|
||||
{
|
||||
"name": "host",
|
||||
"id": "3f43a0873f00310a71cd6a71e2e60c113cf17d1812be2ec22fd519fbac68ec91",
|
||||
"driver": "host",
|
||||
"containers": {}
|
||||
"Name": "host",
|
||||
"Id": "13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e",
|
||||
"Scope": "local",
|
||||
"Driver": "host",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": []
|
||||
},
|
||||
"Containers": {},
|
||||
"Options": {}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
|
@ -2586,7 +2643,7 @@ Status Codes
|
|||
|
||||
Query Parameters:
|
||||
|
||||
- **filter** - JSON encoded value of the filters (a `map[string][]string`) to process on the volumes list. Available filters: `name=[network-names]` , `id=[network-ids]`
|
||||
- **filters** - JSON encoded value of the filters (a `map[string][]string`) to process on the networks list. Available filters: `name=[network-names]` , `id=[network-ids]`
|
||||
|
||||
Status Codes:
|
||||
|
||||
|
|
@ -2599,37 +2656,42 @@ Status Codes:
|
|||
|
||||
**Example request**:
|
||||
|
||||
GET /networks/f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4 HTTP/1.1
|
||||
GET /networks/f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566 HTTP/1.1
|
||||
|
||||
**Example response**:
|
||||
|
||||
```
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"name": "bridge",
|
||||
"id": "f995e41e471c833266786a64df584fbe4dc654ac99f63a4ee7495842aa093fc4",
|
||||
"driver": "bridge",
|
||||
"containers": {
|
||||
"931d29e96e63022a3691f55ca18b28600239acf53878451975f77054b05ba559": {
|
||||
"endpoint": "aa79321e2899e6d72fcd46e6a4ad7f81ab9a19c3b06e384ef4ce51fea35827f9",
|
||||
"mac_address": "02:42:ac:11:00:04",
|
||||
"ipv4_address": "172.17.0.4/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"961249b4ae6c764b11eed923e8463c102689111fffd933627b2e7e359c7d0f7c": {
|
||||
"endpoint": "4f62c5aea6b9a70512210be7db976bd4ec2cdba47125e4fe514d18c81b1624b1",
|
||||
"mac_address": "02:42:ac:11:00:02",
|
||||
"ipv4_address": "172.17.0.2/16",
|
||||
"ipv6_address": ""
|
||||
},
|
||||
"9f6e0fec4449f42a173ed85be96dc2253b6719edd850d8169bc31bdc45db675c": {
|
||||
"endpoint": "352b512a5bccdfc77d16c2c04d04408e718f879a16f9ce3913a4733139e4f98d",
|
||||
"mac_address": "02:42:ac:11:00:03",
|
||||
"ipv4_address": "172.17.0.3/16",
|
||||
"ipv6_address": ""
|
||||
"Name": "bridge",
|
||||
"Id": "f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566",
|
||||
"Scope": "local",
|
||||
"Driver": "bridge",
|
||||
"IPAM": {
|
||||
"Driver": "default",
|
||||
"Config": [
|
||||
{
|
||||
"Subnet": "172.17.0.0/16"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Containers": {
|
||||
"39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867": {
|
||||
"EndpointID": "ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda",
|
||||
"MacAddress": "02:42:ac:11:00:02",
|
||||
"IPv4Address": "172.17.0.2/16",
|
||||
"IPv6Address": ""
|
||||
}
|
||||
},
|
||||
"Options": {
|
||||
"com.docker.network.bridge.default_bridge": "true",
|
||||
"com.docker.network.bridge.enable_icc": "true",
|
||||
"com.docker.network.bridge.enable_ip_masquerade": "true",
|
||||
"com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
|
||||
"com.docker.network.bridge.name": "docker0",
|
||||
"com.docker.network.driver.mtu": "1500"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -2647,25 +2709,25 @@ Create a network
|
|||
|
||||
**Example request**:
|
||||
|
||||
```
|
||||
POST /networks/create HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"name":"isolated_nw",
|
||||
"driver":"bridge"
|
||||
"Name":"isolated_nw",
|
||||
"Driver":"bridge"
|
||||
}
|
||||
```
|
||||
|
||||
**Example response**:
|
||||
|
||||
```
|
||||
HTTP/1.1 201 Created
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30",
|
||||
"warning": ""
|
||||
"Id": "22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30",
|
||||
"Warning": ""
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -2677,10 +2739,10 @@ Status Codes:
|
|||
|
||||
JSON Parameters:
|
||||
|
||||
- **name** - The new network's name. this is a mandatory field
|
||||
- **driver** - Name of the network driver to use. Defaults to `bridge` driver
|
||||
- **options** - Network specific options to be used by the drivers
|
||||
- **check_duplicate** - Requests daemon to check for networks with same name
|
||||
- **Name** - The new network's name. this is a mandatory field
|
||||
- **Driver** - Name of the network driver to use. Defaults to `bridge` driver
|
||||
- **Options** - Network specific options to be used by the drivers
|
||||
- **CheckDuplicate** - Requests daemon to check for networks with same name
|
||||
|
||||
### Connect a container to a network
|
||||
|
||||
|
|
@ -2690,12 +2752,12 @@ Connects a container to a network
|
|||
|
||||
**Example request**:
|
||||
|
||||
```
|
||||
POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"container":"3613f73ba0e4"
|
||||
"Container":"3613f73ba0e4"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -2720,12 +2782,12 @@ Disconnects a container from a network
|
|||
|
||||
**Example request**:
|
||||
|
||||
```
|
||||
POST /networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
{
|
||||
"container":"3613f73ba0e4"
|
||||
"Container":"3613f73ba0e4"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -2740,7 +2802,7 @@ Status Codes:
|
|||
|
||||
JSON Parameters:
|
||||
|
||||
- **container** - container-id/name to be disconnected from a network
|
||||
- **Container** - container-id/name to be disconnected from a network
|
||||
|
||||
### Remove a network
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue