Nanocl Daemon (v0.14.0)
The Nanocl Daemon is an HTTP REST API.
It is the API the Nanocl Client uses, so everything the Nanocl Client can do can be done with the API.
Most of the client's commands map directly to API endpoints e.g: nanocl ps is GET /processes.
The notable exception is running Cargo, which consists of several API calls.
This API is documented in OpenAPI format using Utoipa
The specification is generated automatically when running in development only.
When releasing a version, the generated file is transfered to our Documentation.
This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec.
And that allows cross-domain communication from the browser.
All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
List cargoes
query Parameters
| filter | string or null Example: filter={ "where": { "name": { "eq": "test" } } } Generic filter |
| namespace | string or null Namespace where the cargoes are |
Responses
Response samples
- 200
[- {
- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "InstanceTotal": 0,
- "InstanceRunning": 0,
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}
]Create a new cargo
query Parameters
| namespace | string or null Namespace where the cargo belongs |
Request Body schema: application/jsonrequired
required | object (Config) Container to create. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata of the cargo (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null)) Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster Discriminator field: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null List of secrets to use as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
{- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}Response samples
- 201
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}create_exec_command
path Parameters
| Name required | string Name of the cargo |
query Parameters
| Namespace | string or null Namespace of the cargo |
Request Body schema: application/jsonrequired
| AttachStderr | boolean or null Attach to stderr of the exec command. |
| AttachStdin | boolean or null Attach to |
| AttachStdout | boolean or null Attach to stdout of the exec command. |
| Cmd | Array of strings or null Command to run, as a string or array of strings. |
| DetachKeys | string or null Override the key sequence for detaching a container. Format is a single character |
| Env | Array of strings or null A list of environment variables in the form |
| Privileged | boolean or null Runs the exec process with extended privileges. |
| Tty | boolean or null Allocate a pseudo-TTY. |
| User | string or null The user, and optionally, group to run the exec process inside the container. Format is one
of: |
| WorkingDir | string or null The working directory for the exec process inside the container. |
Responses
Request samples
- Payload
{- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "Tty": true,
- "DetachKeys": "string",
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Privileged": true,
- "User": "string",
- "WorkingDir": "string"
}Create a new cargo spec and add history entry
path Parameters
| name required | string Name of the cargo |
query Parameters
| namespace | string or null Namespace where the cargo belongs |
Request Body schema: application/jsonrequired
required | object (Config) Container to create. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata of the cargo (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null)) Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster Discriminator field: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null List of secrets to use as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
{- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}Response samples
- 200
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}Patch a cargo spec meaning merging current spec with the new one and add history entry
path Parameters
| name required | string Name of the cargo |
query Parameters
| namespace | string or null Namespace where the cargo belongs |
Request Body schema: application/jsonrequired
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object New metadata of the cargo (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | string or null New name of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null)) Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster Discriminator field: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null List of secrets to use as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
{- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}Response samples
- 200
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}List cargo histories
path Parameters
| name required | string Name of the cargo |
query Parameters
| namespace | string or null Namespace where the cargo belongs |
Responses
Response samples
- 200
[- {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
]Revert a cargo to a specific history
path Parameters
| id required | string Id of the cargo history |
| name required | string Name of the cargo |
query Parameters
| namespace | string or null Namespace where the cargo belongs |
Responses
Response samples
- 200
- 404
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}Get detailed information about a cargo
path Parameters
| name required | string Name of the cargo |
query Parameters
| namespace | string or null Namespace where the cargo belongs |
Responses
Response samples
- 200
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "InstanceTotal": 0,
- "InstanceRunning": 0,
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}, - "Instances": [
- {
- "Key": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Kind": "vm",
- "NodeKey": "string",
- "KindKey": "string",
- "Data": {
- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
}
]
}Get events of all peer nodes
query Parameters
| filter | string or null Example: filter={ "where": { "kind": { "eq": "normal" } } } Generic filter |
Responses
Response samples
- 200
[- {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "ReportingNode": "string",
- "ReportingController": "string",
- "Kind": "error",
- "Action": "string",
- "Reason": "string",
- "Note": "string",
- "Actor": {
- "Key": "string",
- "Kind": "Namespace",
- "Attributes": {
- "property1": "string",
- "property2": "string"
}
}, - "Related": {
- "Key": "string",
- "Kind": "Namespace",
- "Attributes": {
- "property1": "string",
- "property2": "string"
}
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
]Watch on new events using Server-Sent Events / EventSource
Request Body schema: application/jsonoptional
required | Array of strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or objects (NativeEventAction) |
| ActorKey | string or null |
| ActorKind | string or null Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage" Kind is the type of event related to the actor kind |
| Kind required | Array of strings (EventKind) Items Enum: "error" "normal" "warning" |
| RelatedKey | string or null |
| RelatedKind | string or null Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage" Kind is the type of event related to the actor kind |
Responses
Request samples
- Payload
[- {
- "ActorKey": "string",
- "ActorKind": "Namespace",
- "RelatedKey": "string",
- "RelatedKind": "Namespace",
- "Kind": [
- "error"
], - "Action": [
- "create"
]
}
]Response samples
- 200
{- "CanRemove": true,
- "DetachKeys": "string",
- "ID": "string",
- "Running": true,
- "ExitCode": 0,
- "ProcessConfig": {
- "privileged": true,
- "user": "string",
- "tty": true,
- "entrypoint": "string",
- "arguments": [
- "string"
]
}, - "OpenStdin": true,
- "OpenStderr": true,
- "OpenStdout": true,
- "ContainerID": "string",
- "Pid": 0
}start_exec_command
path Parameters
| id required | string Exec command id |
Request Body schema: application/jsonrequired
| Detach required | boolean Detach from the command. |
| OutputCapacity | integer or null >= 0 The maximum size for a line of output. The default is 8 * 1024 (roughly 1024 characters). |
| Tty required | boolean Allocate a pseudo-TTY. |
Responses
Request samples
- Payload
{- "Detach": true,
- "Tty": true,
- "OutputCapacity": 0
}Response samples
- 200
[- {
- "InstanceTotal": 0,
- "InstanceSuccess": 0,
- "InstanceRunning": 0,
- "InstanceFailed": 0,
- "Spec": {
- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- null
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": null,
- "property2": null
}, - "DriverConfig": {
- "Name": null,
- "Options": { }
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- null
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- null
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}
}
]Create a job
Request Body schema: application/jsonrequired
required | Array of objects (Config) List of container to run | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the job | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Schedule | string or null Schedule of the job (cron) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null Secrets to load as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ttl | integer or null >= 0 Remove the job after (x) seconds after execution | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Responses
Request samples
- Payload
{- "Name": "string",
- "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}Response samples
- 201
{- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}Response samples
- 200
{- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "InstanceTotal": 0,
- "InstanceSuccess": 0,
- "InstanceRunning": 0,
- "InstanceFailed": 0,
- "Spec": {
- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}, - "Instances": [
- {
- "Key": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Kind": "vm",
- "NodeKey": "string",
- "KindKey": "string",
- "Data": {
- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
}
]
}Get metrics of all peer nodes
query Parameters
| filter | string or null Example: filter={ "where": { "kind": { "eq": "CPU" } } } Generic filter |
Responses
Response samples
- 200
[- {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "NodeName": "string",
- "Kind": "string",
- "Data": null,
- "Note": "string"
}
]create_metric
Request Body schema: application/jsonrequired
| Data required | any The data of the metric |
| Kind required | string The kind of the metric |
| Note | string or null Optional note about the metric |
Responses
Request samples
- Payload
{- "Kind": "string",
- "Data": null,
- "Note": "string"
}Response samples
- 201
{- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "NodeName": "string",
- "Kind": "string",
- "Data": null,
- "Note": "string"
}Get detailed information about a namespace
path Parameters
| name required | string The namespace name to inspect |
Responses
Response samples
- 200
- 404
[- {
- "Name": "string",
- "Cargoes": [
- {
- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "InstanceTotal": 0,
- "InstanceRunning": 0,
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- null
], - "Capabilities": [
- [ ]
], - "Options": {
- "property1": null,
- "property2": null
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": null,
- "HostIp": null
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": null,
- "NonRecursive": null,
- "CreateMountpoint": null,
- "ReadOnlyNonRecursive": null,
- "ReadOnlyForceRecursive": null
}, - "VolumeOptions": {
- "NoCopy": null,
- "Labels": { },
- "DriverConfig": null
}, - "TmpfsOptions": {
- "SizeBytes": null,
- "Mode": null
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": null,
- "IPv6Address": null,
- "LinkLocalIPs": [ ]
}, - "Links": [
- null
], - "MacAddress": "string",
- "Aliases": [
- null
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": null,
- "property2": null
}, - "DNSNames": [
- null
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": null,
- "IPv6Address": null,
- "LinkLocalIPs": [ ]
}, - "Links": [
- null
], - "MacAddress": "string",
- "Aliases": [
- null
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": null,
- "property2": null
}, - "DNSNames": [
- null
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- null
], - "Capabilities": [
- [ ]
], - "Options": {
- "property1": null,
- "property2": null
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": null,
- "HostIp": null
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": null,
- "NonRecursive": null,
- "CreateMountpoint": null,
- "ReadOnlyNonRecursive": null,
- "ReadOnlyForceRecursive": null
}, - "VolumeOptions": {
- "NoCopy": null,
- "Labels": { },
- "DriverConfig": null
}, - "TmpfsOptions": {
- "SizeBytes": null,
- "Mode": null
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": null,
- "IPv6Address": null,
- "LinkLocalIPs": [ ]
}, - "Links": [
- null
], - "MacAddress": "string",
- "Aliases": [
- null
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": null,
- "property2": null
}, - "DNSNames": [
- null
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": null,
- "IPv6Address": null,
- "LinkLocalIPs": [ ]
}, - "Links": [
- null
], - "MacAddress": "string",
- "Aliases": [
- null
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": null,
- "property2": null
}, - "DNSNames": [
- null
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}, - "Instances": [
- {
- "Key": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Kind": "vm",
- "NodeKey": "string",
- "KindKey": "string",
- "Data": {
- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- null
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": null,
- "Weight": null
}
], - "BlkioDeviceReadBps": [
- {
- "Path": null,
- "Rate": null
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": null,
- "Rate": null
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": null,
- "Rate": null
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": null,
- "Rate": null
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": null,
- "PathInContainer": null,
- "CgroupPermissions": null
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": null,
- "Count": null,
- "DeviceIDs": [ ],
- "Capabilities": [ ],
- "Options": { }
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": null,
- "Soft": null,
- "Hard": null
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": null,
- "property2": null
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- { }
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": null,
- "Source": null,
- "Type": null,
- "ReadOnly": null,
- "Consistency": null,
- "BindOptions": null,
- "VolumeOptions": null,
- "TmpfsOptions": null
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- null
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- { }
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": null,
- "PrefixLen": null
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": null,
- "PrefixLen": null
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": null,
- "Links": [ ],
- "MacAddress": null,
- "Aliases": [ ],
- "NetworkID": null,
- "EndpointID": null,
- "Gateway": null,
- "IPAddress": null,
- "IPPrefixLen": null,
- "IPv6Gateway": null,
- "GlobalIPv6Address": null,
- "GlobalIPv6PrefixLen": null,
- "DriverOpts": { },
- "DNSNames": [ ]
}, - "property2": {
- "IPAMConfig": null,
- "Links": [ ],
- "MacAddress": null,
- "Aliases": [ ],
- "NetworkID": null,
- "EndpointID": null,
- "Gateway": null,
- "IPAddress": null,
- "IPPrefixLen": null,
- "IPv6Gateway": null,
- "GlobalIPv6Address": null,
- "GlobalIPv6PrefixLen": null,
- "DriverOpts": { },
- "DNSNames": [ ]
}
}
}
}
}
]
}
], - "Network": {
- "Name": "string",
- "Id": "string",
- "Created": "2021-01-01T00:00:00.000000000Z",
- "Scope": "string",
- "Driver": "string",
- "EnableIPv6": true,
- "IPAM": {
- "Driver": "string",
- "Config": [
- {
- "Subnet": "string",
- "IPRange": "string",
- "Gateway": "string",
- "AuxiliaryAddresses": {
- "property1": "string",
- "property2": "string"
}
}
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}, - "Internal": true,
- "Attachable": true,
- "Ingress": true,
- "Containers": {
- "property1": {
- "Name": "string",
- "EndpointID": "string",
- "MacAddress": "string",
- "IPv4Address": "string",
- "IPv6Address": "string"
}, - "property2": {
- "Name": "string",
- "EndpointID": "string",
- "MacAddress": "string",
- "IPv4Address": "string",
- "IPv6Address": "string"
}
}, - "Options": {
- "property1": "string",
- "property2": "string"
}, - "Labels": {
- "property1": "string",
- "property2": "string"
}
}
}
]List process (Vm, Job, Cargo)
query Parameters
| filter | string or null Example: filter={ "where": { "name": { "eq": "test" } } } Generic filter |
Responses
Response samples
- 200
[- {
- "Key": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Kind": "vm",
- "NodeKey": "string",
- "KindKey": "string",
- "Data": {
- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
}
]Send a signal to processes of given kind and name
path Parameters
| kind required | string Example: cargo Kind of the process |
| name required | string Example: deploy-example Name of the process |
query Parameters
| namespace | string or null Namespace where the process belongs is needed |
Request Body schema: application/jsonrequired
| signal required | string Signal to send to the container default: SIGKILL |
Responses
Request samples
- Payload
{- "signal": "string"
}Get logs of processes for all instances of given kind and name (cargo, job, vm)
path Parameters
| kind required | string Example: cargo Kind of the process |
| name required | string Example: deploy-example Name of the process |
query Parameters
| follow | boolean or null Boolean to return a stream or not |
| namespace | string or null Namespace of the process |
| since | integer or null <int64> Only logs returned since timestamp |
| tail | string or null Only return the n last (integer) or all ("all") logs |
| timestamps | boolean or null Add timestamps to every log line |
| until | integer or null <int64> Only logs returned until timestamp |
Responses
Get stats of a cargo instance
path Parameters
| kind required | string Example: cargo Kind of process |
| name required | string Example: deploy-example Name of the process group |
query Parameters
| namespace | string or null Namespace where the cargo belongs |
| one_shot | boolean or null Return stats only once |
| stream | boolean or null Return a stream of stats |
Responses
Get logs of a single process instance by it's name or id
path Parameters
| name required | string Example: deploy-example Name of the process |
query Parameters
| follow | boolean or null Boolean to return a stream or not |
| since | integer or null <int64> Only logs returned since timestamp |
| tail | string or null Only return the n last (integer) or all ("all") logs |
| timestamps | boolean or null Add timestamps to every log line |
| until | integer or null <int64> Only logs returned until timestamp |
Responses
Create a resource kind
Request Body schema: application/jsonrequired
required | object (ResourceKindSpec) Specification of a resource kind. Depending on the spec it will validate a JSONSchema or call a service. | ||||
| |||||
object Metadata (user defined) of the resource kind | |||||
| |||||
| Name required | string The name of the resource kind | ||||
| Version required | string The version of the resource kind | ||||
Responses
Request samples
- Payload
{- "Name": "string",
- "Version": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Data": {
- "Schema": {
- "property1": "string",
- "property2": "string"
}, - "Url": "string"
}
}Response samples
- 201
{- "Name": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Metadata": null,
- "Data": {
- "Schema": {
- "property1": "string",
- "property2": "string"
}, - "Url": "string"
}
}Inspect a resource kind
path Parameters
| domain required | string Domain of the resource kind |
| name required | string Name of the resource kind |
Responses
Response samples
- 200
{- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Versions": [
- {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "KindKey": "string",
- "Version": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Data": {
- "Schema": {
- "property1": "string",
- "property2": "string"
}, - "Url": "string"
}
}
]
}Inspect a specific version of a resource kind
path Parameters
| domain required | string Domain of the resource kind |
| name required | string Name of the resource kind |
Responses
Response samples
- 200
{- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "KindKey": "string",
- "Version": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Data": {
- "Schema": {
- "property1": "string",
- "property2": "string"
}, - "Url": "string"
}
}List resources
query Parameters
| filter | string or null Example: filter={ "where": { "kind": { "eq": "ProxyRule" } } } Generic filter |
Responses
Response samples
- 200
[- {
- "Kind": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ResourceKey": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
}
]Create a resource
Request Body schema: application/jsonrequired
required | object The data of the resource (json object) | ||
| |||
| Kind required | string The kind of the resource | ||
object The metadata of the resource (user defined) | |||
| |||
| Name required | string The name of the resource | ||
Responses
Request samples
- Payload
{- "Name": "string",
- "Kind": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}Response samples
- 200
{- "Kind": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ResourceKey": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
}Get detailed information about a resource
path Parameters
| name required | string The resource name to inspect |
Responses
Response samples
- 200
- 404
{- "Kind": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ResourceKey": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
}Create a new resource spec and add history entry
path Parameters
| name required | string Name of the resource |
Request Body schema: application/jsonrequired
required | object The spec of the resource as a json object | ||
| |||
object The metadata of the resource as a json object | |||
| |||
Responses
Request samples
- Payload
{- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}Response samples
- 200
- 404
{- "Kind": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ResourceKey": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
}Response samples
- 200
- 404
[- {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ResourceKey": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
]Revert a resource to a specific history
path Parameters
| id required | string The resource history id to revert to |
| name required | string The resource name to revert |
Responses
Response samples
- 200
- 404
{- "Kind": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ResourceKey": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}
}| Addr | string or null IP address. |
| PrefixLen | integer or null <int64> Mask length of the IP address. |
{- "Addr": "string",
- "PrefixLen": 0
}Helper to generate have Any type for OpenApi useful for dynamic json objects like ResourceSpec
{- "property1": "string",
- "property2": "string"
}| Arch required | string Arch is the architecture of the current binary |
| Channel required | string Channel is the channel of the current binary |
| CommitId required | string CommitID is the commit id of the current binary |
| Version required | string Version is the version of the current binary |
{- "Arch": "string",
- "Channel": "string",
- "Version": "string",
- "CommitId": "string"
}Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
Array of objects or null (BlkioStatsEntry) | |||||||||
Array
| |||||||||
{- "io_service_bytes_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "io_serviced_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "io_queue_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "io_service_time_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "io_wait_time_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "io_merged_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "io_time_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
], - "sectors_recursive": [
- {
- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}
]
}| major required | integer <int64> >= 0 |
| minor required | integer <int64> >= 0 |
| op required | string |
| value required | integer <int64> >= 0 |
{- "major": 0,
- "minor": 0,
- "op": "string",
- "value": 0
}required | object (CPUUsage) CPU usage statistics for the container. | ||||||||
| |||||||||
| online_cpus | integer or null <int64> >= 0 | ||||||||
| system_cpu_usage | integer or null <int64> >= 0 | ||||||||
required | object (ThrottlingData) CPU throttling statistics. | ||||||||
| |||||||||
{- "cpu_usage": {
- "percpu_usage": [
- 0
], - "usage_in_usermode": 0,
- "total_usage": 0,
- "usage_in_kernelmode": 0
}, - "system_cpu_usage": 0,
- "online_cpus": 0,
- "throttling_data": {
- "periods": 0,
- "throttled_periods": 0,
- "throttled_time": 0
}
}| percpu_usage | Array of integers or null <int64> [ items <int64 > >= 0 ] |
| total_usage required | integer <int64> >= 0 |
| usage_in_kernelmode required | integer <int64> >= 0 |
| usage_in_usermode required | integer <int64> >= 0 |
{- "percpu_usage": [
- 0
], - "usage_in_usermode": 0,
- "total_usage": 0,
- "usage_in_kernelmode": 0
}| CreatedAt required | string <date-time> When the cargo was created | ||||||||||||||||||||||||
| NamespaceName required | string Name of the namespace | ||||||||||||||||||||||||
required | object (CargoSpec) A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (ObjPsStatus) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}| CreatedAt required | string <date-time> When the cargo was created | ||||||||||||||||||||||||
| InstanceRunning required | integer >= 0 Number of running instances | ||||||||||||||||||||||||
required | Array of objects (Process) List of instances | ||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
| InstanceTotal required | integer >= 0 Number of instances | ||||||||||||||||||||||||
| NamespaceName required | string Name of the namespace | ||||||||||||||||||||||||
required | object (CargoSpec) A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (ObjPsStatus) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "InstanceTotal": 0,
- "InstanceRunning": 0,
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}, - "Instances": [
- {
- "Key": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Kind": "vm",
- "NodeKey": "string",
- "KindKey": "string",
- "Data": {
- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
}
]
}| signal required | string Signal to send to the container default: SIGKILL |
{- "signal": "string"
}| CargoKey required | string The key of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (Config) Container to create. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CreatedAt required | string <date-time> Creation date of the cargo spec | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Key required | string <uuid> Unique identifier of the cargo spec | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata of the cargo (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null)) Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster Discriminator field: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null List of secrets to use as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Version required | string Version of the spec | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}required | object (Config) Container to create. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata of the cargo (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null)) Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster Discriminator field: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null List of secrets to use as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container to create. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
object New metadata of the cargo (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | string or null New name of the cargo | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
(Auto (object or null)) or (Unique (object or null)) or (UniqueByNode (object or null)) or (UniqueByNodeGroups (object or null)) or (UniqueByNodeNames (object or null)) or (Static (object or null)) or (StaticByNodes (object or null)) or (StaticByNodeGroups (object or null)) or (StaticByNodeNames (object or null)) Auto is used to automatically define that the number of replicas in the cluster Number is used to manually set the number of replicas Note: auto will ensure at least 1 replica exists in the cluster Discriminator field: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null List of secrets to use as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}| CreatedAt required | string <date-time> When the cargo was created | ||||||||||||||||||||||||
| InstanceRunning required | integer >= 0 Number of running instances | ||||||||||||||||||||||||
| InstanceTotal required | integer >= 0 Number of instances | ||||||||||||||||||||||||
| NamespaceName required | string Name of the namespace | ||||||||||||||||||||||||
required | object (CargoSpec) A cargo spec is the specification of a cargo It used to know the state of the cargo It keep tracking of an history when you patch an existing cargo | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
{- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "InstanceTotal": 0,
- "InstanceRunning": 0,
- "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Replication": {
- "Mode": "Auto"
}
}
}| CreatedAt | string or null (BollardDate) BollardDate | ||||||||||||||||
| DataPathPort | integer or null <int32> >= 0 DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used. | ||||||||||||||||
| DefaultAddrPool | Array of strings or null Default Address Pool specifies default subnet pools for global scope networks. | ||||||||||||||||
| ID | string or null The ID of the swarm. | ||||||||||||||||
| RootRotationInProgress | boolean or null Whether there is currently a root CA rotation in progress for the swarm | ||||||||||||||||
object or null User modifiable swarm configuration. | |||||||||||||||||
| |||||||||||||||||
| SubnetSize | integer or null <int32> >= 0 SubnetSize specifies the subnet size of the networks created from the default subnet pool. | ||||||||||||||||
object or null Information about the issuer of leaf TLS certificates and the trusted root CA certificate. | |||||||||||||||||
| |||||||||||||||||
| UpdatedAt | string or null (BollardDate) BollardDate | ||||||||||||||||
object or null 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. | |||||||||||||||||
| |||||||||||||||||
{- "ID": "string",
- "Version": {
- "Index": 0
}, - "CreatedAt": "2021-01-01T00:00:00.000000000Z",
- "UpdatedAt": "2021-01-01T00:00:00.000000000Z",
- "Spec": {
- "Name": "string",
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "Orchestration": {
- "TaskHistoryRetentionLimit": 0
}, - "Raft": {
- "SnapshotInterval": 0,
- "KeepOldSnapshots": 0,
- "LogEntriesForSlowFollowers": 0,
- "ElectionTick": 0,
- "HeartbeatTick": 0
}, - "Dispatcher": {
- "HeartbeatPeriod": 0
}, - "CAConfig": {
- "NodeCertExpiry": 0,
- "ExternalCAs": [
- {
- "Protocol": "EMPTY",
- "URL": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}, - "CACert": "string"
}
], - "SigningCACert": "string",
- "SigningCAKey": "string",
- "ForceRotate": 0
}, - "EncryptionConfig": {
- "AutoLockManagers": true
}, - "TaskDefaults": {
- "LogDriver": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "TLSInfo": {
- "TrustRoot": "string",
- "CertIssuerSubject": "string",
- "CertIssuerPublicKey": "string"
}, - "RootRotationInProgress": true,
- "DataPathPort": 0,
- "DefaultAddrPool": [
- "string"
], - "SubnetSize": 0
}| Expected | string or null Commit ID of external tool expected by dockerd as set at build time. |
| ID | string or null Actual commit ID of external tool. |
{- "ID": "string",
- "Expected": "string"
}| ArgsEscaped | boolean or null Command is already escaped (Windows only) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AttachStderr | boolean or null Whether to attach to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AttachStdin | boolean or null Whether to attach to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AttachStdout | boolean or null Whether to attach to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cmd | Array of strings or null Command to run specified as a string or an array of strings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Domainname | string or null The domain name to use for the container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Entrypoint | Array of strings or null The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string ( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Env | Array of strings or null A list of environment variables to set inside the container in the form | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null An object mapping ports to an empty object in the form: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null A test to perform to check that the container is healthy. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container configuration that depends on the host we are running on | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Hostname | string or null The hostname to use for the container, as a valid RFC 1123 hostname. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Image | string or null The name of the image to use when creating the container | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null User-defined key/value metadata. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MacAddress | string or null MAC address of the container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NetworkDisabled | boolean or null Disable networking for the container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OnBuild | Array of strings or null
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenStdin | boolean or null Open | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Shell | Array of strings or null Shell for when | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StdinOnce | boolean or null Close | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StopSignal | string or null Signal to stop a container as a string or unsigned integer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StopTimeout | integer or null <int64> Timeout to stop a container in seconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Tty | boolean or null Attach standard streams to a TTY, including | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| User | string or null The user that commands are run as inside the container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null An object mapping mount point paths inside the container to empty objects. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| WorkingDir | string or null The working directory for commands to run in. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}| Data | string or null Base64-url-safe-encoded (RFC 4648) config data. | ||||
object or null User-defined key/value metadata. | |||||
| |||||
| Name | string or null User-defined name of the config. | ||||
object or null Driver represents a driver (network, logging, secrets). | |||||
| |||||
{- "Name": "string",
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "Data": "string",
- "Templating": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}| ArgsEscaped | boolean or null Command is already escaped (Windows only) | ||||||||||||
| AttachStderr | boolean or null Whether to attach to | ||||||||||||
| AttachStdin | boolean or null Whether to attach to | ||||||||||||
| AttachStdout | boolean or null Whether to attach to | ||||||||||||
| Cmd | Array of strings or null Command to run specified as a string or an array of strings. | ||||||||||||
| Domainname | string or null The domain name to use for the container. | ||||||||||||
| Entrypoint | Array of strings or null The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string ( | ||||||||||||
| Env | Array of strings or null A list of environment variables to set inside the container in the form | ||||||||||||
object or null An object mapping ports to an empty object in the form: | |||||||||||||
| |||||||||||||
object or null A test to perform to check that the container is healthy. | |||||||||||||
| |||||||||||||
| Hostname | string or null The hostname to use for the container, as a valid RFC 1123 hostname. | ||||||||||||
| Image | string or null The name (or reference) of the image to use when creating the container, or which was used when the container was created. | ||||||||||||
object or null User-defined key/value metadata. | |||||||||||||
| |||||||||||||
| MacAddress | string or null MAC address of the container. Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead. | ||||||||||||
| NetworkDisabled | boolean or null Disable networking for the container. | ||||||||||||
| OnBuild | Array of strings or null
| ||||||||||||
| OpenStdin | boolean or null Open | ||||||||||||
| Shell | Array of strings or null Shell for when | ||||||||||||
| StdinOnce | boolean or null Close | ||||||||||||
| StopSignal | string or null Signal to stop a container as a string or unsigned integer. | ||||||||||||
| StopTimeout | integer or null <int64> Timeout to stop a container in seconds. | ||||||||||||
| Tty | boolean or null Attach standard streams to a TTY, including | ||||||||||||
| User | string or null The user that commands are run as inside the container. | ||||||||||||
object or null An object mapping mount point paths inside the container to empty objects. | |||||||||||||
| |||||||||||||
| WorkingDir | string or null The working directory for commands to run in. | ||||||||||||
{- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}| AppArmorProfile | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Args | Array of strings or null The arguments to the command being run | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Configuration for a container that is portable between hosts. When used as | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Created | string or null The time the container was created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Driver | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ExecIDs | Array of strings or null IDs of exec instances that are running in the container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Information about the storage driver used to store the container's and image's filesystem. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Container configuration that depends on the host we are running on | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HostnamePath | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HostsPath | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Id | string or null The ID of the container | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Image | string or null The container's image ID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogPath | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MountLabel | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects or null (MountPoint) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null NetworkSettings exposes the network settings in the API | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Path | string or null The path to the command being run | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Platform | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessLabel | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ResolvConfPath | string or null | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RestartCount | integer or null <int64> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SizeRootFs | integer or null <int64> The total size of all the files in this container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SizeRw | integer or null <int64> The size of files that have been created or changed by this container. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the "inspect" command. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}| Dead | boolean or null | ||||||
| Error | string or null | ||||||
| ExitCode | integer or null <int64> The last exit code of this container | ||||||
| FinishedAt | string or null The time when this container last exited. | ||||||
object or null Health stores information about the container's healthcheck results. | |||||||
| |||||||
| OOMKilled | boolean or null Whether a process within this container has been killed because it ran out of memory since the container was last started. | ||||||
| Paused | boolean or null Whether this container is paused. | ||||||
| Pid | integer or null <int64> The process ID of this container | ||||||
| Restarting | boolean or null Whether this container is restarting. | ||||||
| Running | boolean or null Whether this container is running. Note that a running container can be paused. The | ||||||
| StartedAt | string or null The time when this container was last started. | ||||||
| Status | string or null Enum: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead" | ||||||
{- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}"EMPTY"| Command | string or null Command to run when starting the container | ||||||||||||||||
| Created | integer or null <int64> When the container was created | ||||||||||||||||
object or null | |||||||||||||||||
| |||||||||||||||||
| Id | string or null The ID of this container | ||||||||||||||||
| Image | string or null The name of the image used when creating this container | ||||||||||||||||
| ImageID | string or null The ID of the image that this container was created from | ||||||||||||||||
object or null User-defined key/value metadata. | |||||||||||||||||
| |||||||||||||||||
Array of objects or null (MountPoint) | |||||||||||||||||
Array
| |||||||||||||||||
| Names | Array of strings or null The names that this container has been given | ||||||||||||||||
object or null A summary of the container's network settings | |||||||||||||||||
| |||||||||||||||||
Array of objects or null (Port) The ports exposed by this container | |||||||||||||||||
Array
| |||||||||||||||||
| SizeRootFs | integer or null <int64> The total size of all the files in this container | ||||||||||||||||
| SizeRw | integer or null <int64> The size of files that have been created or changed by this container | ||||||||||||||||
| State | string or null The state of this container (e.g. | ||||||||||||||||
| Status | string or null Additional human-readable status of this container (e.g. | ||||||||||||||||
{- "Id": "string",
- "Names": [
- "string"
], - "Image": "string",
- "ImageID": "string",
- "Command": "string",
- "Created": 0,
- "Ports": [
- {
- "IP": "string",
- "PrivatePort": 0,
- "PublicPort": 0,
- "Type": "EMPTY"
}
], - "SizeRw": 0,
- "SizeRootFs": 0,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "State": "string",
- "Status": "string",
- "HostConfig": {
- "NetworkMode": "string"
}, - "NetworkSettings": {
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}, - "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
]
}object or null | |||
| |||
{- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}| AttachStderr | boolean or null Attach to stderr of the exec command. |
| AttachStdin | boolean or null Attach to |
| AttachStdout | boolean or null Attach to stdout of the exec command. |
| Cmd | Array of strings or null Command to run, as a string or array of strings. |
| DetachKeys | string or null Override the key sequence for detaching a container. Format is a single character |
| Env | Array of strings or null A list of environment variables in the form |
| Privileged | boolean or null Runs the exec process with extended privileges. |
| Tty | boolean or null Allocate a pseudo-TTY. |
| User | string or null The user, and optionally, group to run the exec process inside the container. Format is one
of: |
| WorkingDir | string or null The working directory for the exec process inside the container. |
{- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "Tty": true,
- "DetachKeys": "string",
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Privileged": true,
- "User": "string",
- "WorkingDir": "string"
}| advertise_addr required | string Address to advertise to other nodes | ||||||
| conf_dir required | string Config directory | ||||||
| docker_host | string Docker host to use | ||||||
| gateway required | string Host gateway automatically detected to host default gateway if not set | ||||||
| gid required | integer <int32> >= 0 Group id | ||||||
| hostname required | string Hostname to use for the node automatically detected if not set | ||||||
| hosts required | Array of strings List of hosts to listen on | ||||||
| nodes required | Array of strings List of nodes to join | ||||||
object or null | |||||||
| |||||||
| state_dir required | string Path to the state directory | ||||||
{- "hosts": [
- "string"
], - "state_dir": "string",
- "docker_host": "string",
- "gateway": "string",
- "hostname": "string",
- "nodes": [
- "string"
], - "advertise_addr": "string",
- "conf_dir": "string",
- "gid": 0,
- "ssl": {
- "Cert": "string",
- "CertKey": "string",
- "CertCa": "string"
}
}| CgroupPermissions | string or null |
| PathInContainer | string or null |
| PathOnHost | string or null |
{- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}| Capabilities | Array of strings or null[ items ] A list of capabilities; an OR list of AND lists of capabilities. | ||
| Count | integer or null <int64> | ||
| DeviceIDs | Array of strings or null | ||
| Driver | string or null | ||
object or null Driver-specific options, specified as a key/value pairs. These options are passed directly to the driver. | |||
| |||
{- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}| Name required | string Name of the driver. | ||
object or null Key/value map of driver-specific options. | |||
| |||
{- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}| IPv4Address | string or null |
| IPv6Address | string or null |
| LinkLocalIPs | Array of strings or null |
{- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}| Aliases | Array of strings or null | ||||||
| DNSNames | Array of strings or null List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname. These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending | ||||||
object or null DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific. | |||||||
| |||||||
| EndpointID | string or null Unique ID for the service endpoint in a Sandbox. | ||||||
| Gateway | string or null Gateway address for this network. | ||||||
| GlobalIPv6Address | string or null Global IPv6 address. | ||||||
| GlobalIPv6PrefixLen | integer or null <int64> Mask length of the global IPv6 address. | ||||||
| IPAddress | string or null IPv4 address. | ||||||
object or null EndpointIPAMConfig represents an endpoint's IPAM configuration. | |||||||
| |||||||
| IPPrefixLen | integer or null <int64> Mask length of the IPv4 address. | ||||||
| IPv6Gateway | string or null IPv6 gateway address. | ||||||
| Links | Array of strings or null | ||||||
| MacAddress | string or null MAC address for the endpoint on this network. The network driver might ignore this parameter. | ||||||
| NetworkID | string or null Unique ID of the network. | ||||||
{- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}| Action required | string Action is what action was taken/failed regarding to the regarding actor. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. | ||||||
object or null Actor is the actor that triggered the event | |||||||
| |||||||
| CreatedAt required | string <date-time> When the event was created. | ||||||
| ExpiresAt required | string <date-time> When the event expires. | ||||||
| Key required | string <uuid> Unique identifier of this event. | ||||||
| Kind required | string (EventKind) Enum: "error" "normal" "warning" Kind of event (Error, Normal, Warning), new types could be added in the future. | ||||||
object Standard metadata. | |||||||
| |||||||
| Note | string or null Human-readable description of the status of this operation | ||||||
| Reason required | string Reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. | ||||||
object or null Actor is the actor that triggered the event | |||||||
| |||||||
| ReportingController required | string Reporting Controller is the name of the controller that emitted this Event.
e.g. | ||||||
| ReportingNode required | string Reporting Node is the name of the node where the Event was generated. | ||||||
{- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "ReportingNode": "string",
- "ReportingController": "string",
- "Kind": "error",
- "Action": "string",
- "Reason": "string",
- "Note": "string",
- "Actor": {
- "Key": "string",
- "Kind": "Namespace",
- "Attributes": {
- "property1": "string",
- "property2": "string"
}
}, - "Related": {
- "Key": "string",
- "Kind": "Namespace",
- "Attributes": {
- "property1": "string",
- "property2": "string"
}
}, - "Metadata": {
- "property1": "string",
- "property2": "string"
}
}object | |||
| |||
| Key | string or null | ||
| Kind required | string (EventActorKind) Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage" Kind is the type of event related to the actor kind | ||
{- "Key": "string",
- "Kind": "Namespace",
- "Attributes": {
- "property1": "string",
- "property2": "string"
}
}Kind is the type of event related to the actor kind
"Namespace"required | Array of strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or objects (NativeEventAction) |
Array One of string Value: "create" Action is the action that triggered the event | |
| ActorKey | string or null |
| ActorKind | string or null Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage" Kind is the type of event related to the actor kind |
| Kind required | Array of strings (EventKind) Items Enum: "error" "normal" "warning" |
| RelatedKey | string or null |
| RelatedKind | string or null Enum: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage" Kind is the type of event related to the actor kind |
{- "ActorKey": "string",
- "ActorKind": "Namespace",
- "RelatedKey": "string",
- "RelatedKind": "Namespace",
- "Kind": [
- "error"
], - "Action": [
- "create"
]
}Kind of event (Error, Normal, Warning), new types could be added in the future.
"error"| CanRemove | boolean or null | ||||||||||
| ContainerID | string or null | ||||||||||
| DetachKeys | string or null | ||||||||||
| ExitCode | integer or null <int64> | ||||||||||
| ID | string or null | ||||||||||
| OpenStderr | boolean or null | ||||||||||
| OpenStdin | boolean or null | ||||||||||
| OpenStdout | boolean or null | ||||||||||
| Pid | integer or null <int64> The system process ID for the exec process. | ||||||||||
object or null | |||||||||||
| |||||||||||
| Running | boolean or null | ||||||||||
{- "CanRemove": true,
- "DetachKeys": "string",
- "ID": "string",
- "Running": true,
- "ExitCode": 0,
- "ProcessConfig": {
- "privileged": true,
- "user": "string",
- "tty": true,
- "entrypoint": "string",
- "arguments": [
- "string"
]
}, - "OpenStdin": true,
- "OpenStderr": true,
- "OpenStdout": true,
- "ContainerID": "string",
- "Pid": 0
}| limit | integer or null >= 0 Limit number of items default (100) | ||
| offset | integer or null >= 0 Offset to navigate through items | ||
object or null Where clause | |||
| |||
{- "where": {
- "property1": {
- "eq": "string"
}, - "property2": {
- "eq": "string"
}
}, - "limit": 0,
- "offset": 0
}object or null | |||||
| |||||
object or null | |||||
| |||||
{- "NamedResourceSpec": {
- "Kind": "string",
- "Value": "string"
}, - "DiscreteResourceSpec": {
- "Kind": "string",
- "Value": 0
}
}| Kind | string or null |
| Value | integer or null <int64> |
{- "Kind": "string",
- "Value": 0
}| Kind | string or null |
| Value | string or null |
{- "Kind": "string",
- "Value": "string"
}required | object Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only. | ||
| |||
| Name required | string Name of the storage driver. | ||
{- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}| FailingStreak | integer or null <int64> FailingStreak is the number of consecutive failures | ||||||||
Array of objects or null (HealthcheckResult) Log contains the last few results (oldest first) | |||||||||
Array
| |||||||||
| Status | string or null Enum: "EMPTY" "none" "starting" "healthy" "unhealthy" | ||||||||
{- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}| Interval | integer or null <int64> The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. |
| Retries | integer or null <int64> The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit. |
| StartInterval | integer or null <int64> The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. |
| StartPeriod | integer or null <int64> Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit. |
| Test | Array of strings or null The test to perform. Possible values are: - |
| Timeout | integer or null <int64> The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit. |
{- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}"EMPTY"| End | string or null (BollardDate) BollardDate |
| ExitCode | integer or null <int64> ExitCode meanings: - |
| Output | string or null Output from last check |
| Start | string or null (BollardDate) BollardDate |
{- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}object or null Arbitrary non-identifying metadata attached to container and provided to the runtime when the container is started. | |||||||||||||||||
| |||||||||||||||||
| AutoRemove | boolean or null Automatically remove the container when the container's process exits. This has no effect if | ||||||||||||||||
| Binds | Array of strings or null A list of volume bindings for this container. Each volume binding is a string in one of these forms: - | ||||||||||||||||
Array of objects or null (ThrottleDevice) Limit read rate (bytes per second) from a device, in the form: | |||||||||||||||||
Array
| |||||||||||||||||
Array of objects or null (ThrottleDevice) Limit read rate (IO per second) from a device, in the form: | |||||||||||||||||
Array
| |||||||||||||||||
Array of objects or null (ThrottleDevice) Limit write rate (bytes per second) to a device, in the form: | |||||||||||||||||
Array
| |||||||||||||||||
Array of objects or null (ThrottleDevice) Limit write rate (IO per second) to a device, in the form: | |||||||||||||||||
Array
| |||||||||||||||||
| BlkioWeight | integer or null <int32> >= 0 Block IO weight (relative weight). | ||||||||||||||||
Array of objects or null (ResourcesBlkioWeightDevice) Block IO weight (relative device weight) in the form: | |||||||||||||||||
Array
| |||||||||||||||||
| CapAdd | Array of strings or null A list of kernel capabilities to add to the container. Conflicts with option 'Capabilities'. | ||||||||||||||||
| CapDrop | Array of strings or null A list of kernel capabilities to drop from the container. Conflicts with option 'Capabilities'. | ||||||||||||||||
| Cgroup | string or null Cgroup to use for the container. | ||||||||||||||||
| CgroupnsMode | string or null Enum: "EMPTY" "private" "host" | ||||||||||||||||
| CgroupParent | string or null Path to | ||||||||||||||||
| ConsoleSize | Array of integers or null <int32> [ items <int32 > ] Initial console size, as an | ||||||||||||||||
| ContainerIDFile | string or null Path to a file where the container ID is written | ||||||||||||||||
| CpuCount | integer or null <int64> The number of usable CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is | ||||||||||||||||
| CpuPercent | integer or null <int64> The usable percentage of the available CPUs (Windows only). On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is | ||||||||||||||||
| CpuPeriod | integer or null <int64> The length of a CPU period in microseconds. | ||||||||||||||||
| CpuQuota | integer or null <int64> Microseconds of CPU time that the container can get in a CPU period. | ||||||||||||||||
| CpuRealtimePeriod | integer or null <int64> The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | ||||||||||||||||
| CpuRealtimeRuntime | integer or null <int64> The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks. | ||||||||||||||||
| CpusetCpus | string or null CPUs in which to allow execution (e.g., | ||||||||||||||||
| CpusetMems | string or null Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems. | ||||||||||||||||
| CpuShares | integer or null <int64> An integer value representing this container's relative CPU weight versus other containers. | ||||||||||||||||
| DeviceCgroupRules | Array of strings or null a list of cgroup rules to apply to the container | ||||||||||||||||
Array of objects or null (DeviceRequest) A list of requests for devices to be sent to device drivers. | |||||||||||||||||
Array
| |||||||||||||||||
Array of objects or null (DeviceMapping) A list of devices to add to the container. | |||||||||||||||||
Array
| |||||||||||||||||
| Dns | Array of strings or null A list of DNS servers for the container to use. | ||||||||||||||||
| DnsOptions | Array of strings or null A list of DNS options. | ||||||||||||||||
| DnsSearch | Array of strings or null A list of DNS search domains. | ||||||||||||||||
| ExtraHosts | Array of strings or null A list of hostnames/IP mappings to add to the container's | ||||||||||||||||
| GroupAdd | Array of strings or null A list of additional groups that the container process will run as. | ||||||||||||||||
| Init | boolean or null Run an init inside the container that forwards signals and reaps processes. This field is omitted if empty, and the default (as configured on the daemon) is used. | ||||||||||||||||
| IOMaximumBandwidth | integer or null <int64> Maximum IO in bytes per second for the container system drive (Windows only). | ||||||||||||||||
| IOMaximumIOps | integer or null <int64> Maximum IOps for the container system drive (Windows only) | ||||||||||||||||
| IpcMode | string or null IPC sharing mode for the container. Possible values are: - | ||||||||||||||||
| Isolation | string or null Enum: "EMPTY" "default" "process" "hyperv" | ||||||||||||||||
| KernelMemoryTCP | integer or null <int64> Hard limit for kernel TCP buffer memory (in bytes). Depending on the OCI runtime in use, this option may be ignored. It is no longer supported by the default (runc) runtime. This field is omitted when empty. | ||||||||||||||||
| Links | Array of strings or null A list of links for the container in the form | ||||||||||||||||
object or null The logging configuration for this container | |||||||||||||||||
| |||||||||||||||||
| MaskedPaths | Array of strings or null The list of paths to be masked inside the container (this overrides the default set of paths). | ||||||||||||||||
| Memory | integer or null <int64> Memory limit in bytes. | ||||||||||||||||
| MemoryReservation | integer or null <int64> Memory soft limit in bytes. | ||||||||||||||||
| MemorySwap | integer or null <int64> Total memory limit (memory + swap). Set as | ||||||||||||||||
| MemorySwappiness | integer or null <int64> Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. | ||||||||||||||||
Array of objects or null (Mount) Specification for mounts to be added to the container. | |||||||||||||||||
Array
| |||||||||||||||||
| NanoCpus | integer or null <int64> CPU quota in units of 10-9 CPUs. | ||||||||||||||||
| NetworkMode | string or null Network mode to use for this container. Supported standard values are: | ||||||||||||||||
| OomKillDisable | boolean or null Disable OOM Killer for the container. | ||||||||||||||||
| OomScoreAdj | integer or null <int64> An integer value containing the score given to the container in order to tune OOM killer preferences. | ||||||||||||||||
| PidMode | string or null Set the PID (Process) Namespace mode for the container. It can be either: - | ||||||||||||||||
| PidsLimit | integer or null <int64> Tune a container's PIDs limit. Set | ||||||||||||||||
object or null (PortMap) PortMap | |||||||||||||||||
| |||||||||||||||||
| Privileged | boolean or null Gives the container full access to the host. | ||||||||||||||||
| PublishAllPorts | boolean or null Allocates an ephemeral host port for all of a container's exposed ports. Ports are de-allocated when the container stops and allocated when the container starts. The allocated port might be changed when restarting the container. The port is selected from the ephemeral port range that depends on the kernel. For example, on Linux the range is defined by | ||||||||||||||||
| ReadonlyPaths | Array of strings or null The list of paths to be set as read-only inside the container (this overrides the default set of paths). | ||||||||||||||||
| ReadonlyRootfs | boolean or null Mount the container's root filesystem as read only. | ||||||||||||||||
object or null The behavior to apply when the container exits. The default is not to restart. An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server. | |||||||||||||||||
| |||||||||||||||||
| Runtime | string or null Runtime to use with this container. | ||||||||||||||||
| SecurityOpt | Array of strings or null A list of string values to customize labels for MLS systems, such as SELinux. | ||||||||||||||||
| ShmSize | integer or null <int64> Size of | ||||||||||||||||
object or null Storage driver options for this container, in the form | |||||||||||||||||
| |||||||||||||||||
object or null A list of kernel parameters (sysctls) to set in the container. For example: | |||||||||||||||||
| |||||||||||||||||
object or null A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: | |||||||||||||||||
| |||||||||||||||||
Array of objects or null (ResourcesUlimits) A list of resource limits to set in the container. For example: | |||||||||||||||||
Array
| |||||||||||||||||
| UsernsMode | string or null Sets the usernamespace mode for the container when usernamespace remapping option is enabled. | ||||||||||||||||
| UTSMode | string or null UTS namespace to use for the container. | ||||||||||||||||
| VolumeDriver | string or null Driver that this container uses to mount volumes. | ||||||||||||||||
| VolumesFrom | Array of strings or null A list of volumes to inherit from another container, specified in the form | ||||||||||||||||
{- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}"EMPTY""EMPTY"object or null | |||
| |||
| Type | string or null | ||
{- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}| Architecture | string or null Hardware architecture of the host, as returned by the Go runtime ( | ||||||||||||||||||||
| BridgeNfIp6tables | boolean or null Indicates if | ||||||||||||||||||||
| BridgeNfIptables | boolean or null Indicates if | ||||||||||||||||||||
| CDISpecDirs | Array of strings or null List of directories where (Container Device Interface) CDI specifications are located. These specifications define vendor-specific modifications to an OCI runtime specification for a container being created. An empty list indicates that CDI device injection is disabled. Note that since using CDI device injection requires the daemon to have experimental enabled. For non-experimental daemons an empty list will always be returned. | ||||||||||||||||||||
| CgroupDriver | string or null Enum: "EMPTY" "cgroupfs" "systemd" "none" | ||||||||||||||||||||
| CgroupVersion | string or null Enum: "EMPTY" "1" "2" | ||||||||||||||||||||
required | object (DaemonConfig) Configuration of the daemon It is used to configure the daemon | ||||||||||||||||||||
| |||||||||||||||||||||
object or null Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as | |||||||||||||||||||||
| |||||||||||||||||||||
| Containers | integer or null <int64> Total number of containers on the host. | ||||||||||||||||||||
| ContainersPaused | integer or null <int64> Number of containers with status | ||||||||||||||||||||
| ContainersRunning | integer or null <int64> Number of containers with status | ||||||||||||||||||||
| ContainersStopped | integer or null <int64> Number of containers with status | ||||||||||||||||||||
| CpuCfsPeriod | boolean or null Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host. | ||||||||||||||||||||
| CpuCfsQuota | boolean or null Indicates if CPU CFS(Completely Fair Scheduler) quota is supported by the host. | ||||||||||||||||||||
| CPUSet | boolean or null Indicates if CPUsets (cpuset.cpus, cpuset.mems) are supported by the host. See cpuset(7) | ||||||||||||||||||||
| CPUShares | boolean or null Indicates if CPU Shares limiting is supported by the host. | ||||||||||||||||||||
| Debug | boolean or null Indicates if the daemon is running in debug-mode / with debug-level logging enabled. | ||||||||||||||||||||
Array of objects or null (SystemInfoDefaultAddressPools) List of custom default address pools for local networks, which can be specified in the daemon.json file or dockerd option. Example: a Base "10.10.0.0/16" with Size 24 will define the set of 256 10.10.[0-255].0/24 address pools. | |||||||||||||||||||||
Array
| |||||||||||||||||||||
| DefaultRuntime | string or null Name of the default OCI runtime that is used when starting containers. The default can be overridden per-container at create time. | ||||||||||||||||||||
| DockerRootDir | string or null Root directory of persistent Docker state. Defaults to | ||||||||||||||||||||
| Driver | string or null Name of the storage driver in use. | ||||||||||||||||||||
| DriverStatus | Array of strings or null[ items ] Information specific to the storage driver, provided as "label" / "value" pairs. This information is provided by the storage driver, and formatted in a way consistent with the output of | ||||||||||||||||||||
| ExperimentalBuild | boolean or null Indicates if experimental features are enabled on the daemon. | ||||||||||||||||||||
object or null | |||||||||||||||||||||
| |||||||||||||||||||||
| HostGateway required | string HostGateway is the gateway address of the host | ||||||||||||||||||||
| HttpProxy | string or null HTTP-proxy configured for the daemon. This value is obtained from the | ||||||||||||||||||||
| HttpsProxy | string or null HTTPS-proxy configured for the daemon. This value is obtained from the | ||||||||||||||||||||
| ID | string or null Unique identifier of the daemon. | ||||||||||||||||||||
| Images | integer or null <int64> Total number of images on the host. Both tagged and untagged (dangling) images are counted. | ||||||||||||||||||||
| IndexServerAddress | string or null Address / URL of the index server that is used for image search, and as a default for user authentication for Docker Hub and Docker Cloud. | ||||||||||||||||||||
| InitBinary | string or null Name and, optional, path of the | ||||||||||||||||||||
object or null Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as | |||||||||||||||||||||
| |||||||||||||||||||||
| IPv4Forwarding | boolean or null Indicates IPv4 forwarding is enabled. | ||||||||||||||||||||
| Isolation | string or null Enum: "EMPTY" "default" "hyperv" "process" | ||||||||||||||||||||
| KernelMemoryTCP | boolean or null Indicates if the host has kernel memory TCP limit support enabled. This field is omitted if not supported. Kernel memory TCP limits are not supported when using cgroups v2, which does not support the corresponding | ||||||||||||||||||||
| KernelVersion | string or null Kernel version of the host. On Linux, this information obtained from | ||||||||||||||||||||
| Labels | Array of strings or null User-defined labels (key/value metadata) as set on the daemon. /nodes/(id) endpoint > on a manager node in the Swarm.
| ||||||||||||||||||||
| LiveRestoreEnabled | boolean or null Indicates if live restore is enabled. If enabled, containers are kept running when the daemon is shutdown or upon daemon start if running containers are detected. | ||||||||||||||||||||
| LoggingDriver | string or null The logging driver to use as a default for new containers. | ||||||||||||||||||||
| MemoryLimit | boolean or null Indicates if the host has memory limit support enabled. | ||||||||||||||||||||
| MemTotal | integer or null <int64> Total amount of physical memory available on the host, in bytes. | ||||||||||||||||||||
| Name | string or null Hostname of the host. | ||||||||||||||||||||
| NCPU | integer or null <int64> The number of logical CPUs usable by the daemon. The number of available CPUs is checked by querying the operating system when the daemon starts. Changes to operating system CPU allocation after the daemon is started are not reflected. | ||||||||||||||||||||
| NEventsListener | integer or null <int64> Number of event listeners subscribed. | ||||||||||||||||||||
| NFd | integer or null <int64> The total number of file Descriptors in use by the daemon process. This information is only returned if debug-mode is enabled. | ||||||||||||||||||||
| NGoroutines | integer or null <int64> The number of goroutines that currently exist. This information is only returned if debug-mode is enabled. | ||||||||||||||||||||
| NoProxy | string or null Comma-separated list of domain extensions for which no proxy should be used. This value is obtained from the | ||||||||||||||||||||
| OomKillDisable | boolean or null Indicates if OOM killer disable is supported on the host. | ||||||||||||||||||||
| OperatingSystem | string or null Name of the host's operating system, for example: "Ubuntu 16.04.2 LTS" or "Windows Server 2016 Datacenter" | ||||||||||||||||||||
| OSType | string or null Generic type of the operating system of the host, as returned by the Go runtime ( | ||||||||||||||||||||
| OSVersion | string or null Version of the host's operating system | ||||||||||||||||||||
| PidsLimit | boolean or null Indicates if the host kernel has PID limit support enabled. | ||||||||||||||||||||
object or null Available plugins per type. | |||||||||||||||||||||
| |||||||||||||||||||||
| ProductLicense | string or null Reports a summary of the product license on the daemon. If a commercial license has been applied to the daemon, information such as number of nodes, and expiration are included. | ||||||||||||||||||||
object or null RegistryServiceConfig stores daemon registry services configuration. | |||||||||||||||||||||
| |||||||||||||||||||||
object or null Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as | |||||||||||||||||||||
| |||||||||||||||||||||
object or null List of OCI compliant runtimes configured on the daemon. Keys hold the "name" used to reference the runtime. The Docker daemon relies on an OCI compliant runtime (invoked via the | |||||||||||||||||||||
| |||||||||||||||||||||
| SecurityOptions | Array of strings or null List of security features that are enabled on the daemon, such as apparmor, seccomp, SELinux, user-namespaces (userns), rootless and no-new-privileges. Additional configuration options for each security feature may be present, and are included as a comma-separated list of key/value pairs. | ||||||||||||||||||||
| ServerVersion | string or null Version string of the daemon. | ||||||||||||||||||||
| SwapLimit | boolean or null Indicates if the host has memory swap limit support enabled. | ||||||||||||||||||||
object or null Represents generic information about swarm. | |||||||||||||||||||||
| |||||||||||||||||||||
| SystemTime | string or null Current system-time in RFC 3339 format with nano-seconds. | ||||||||||||||||||||
| Warnings | Array of strings or null List of warnings / informational messages about missing features, or issues related to the daemon configuration. These messages can be printed by the client as information to the user. | ||||||||||||||||||||
{- "ID": "string",
- "Containers": 0,
- "ContainersRunning": 0,
- "ContainersPaused": 0,
- "ContainersStopped": 0,
- "Images": 0,
- "Driver": "string",
- "DriverStatus": [
- [
- "string"
]
], - "DockerRootDir": "string",
- "Plugins": {
- "Volume": [
- "string"
], - "Network": [
- "string"
], - "Authorization": [
- "string"
], - "Log": [
- "string"
]
}, - "MemoryLimit": true,
- "SwapLimit": true,
- "KernelMemoryTCP": true,
- "CpuCfsPeriod": true,
- "CpuCfsQuota": true,
- "CPUShares": true,
- "CPUSet": true,
- "PidsLimit": true,
- "OomKillDisable": true,
- "IPv4Forwarding": true,
- "BridgeNfIptables": true,
- "BridgeNfIp6tables": true,
- "Debug": true,
- "NFd": 0,
- "NGoroutines": 0,
- "SystemTime": "string",
- "LoggingDriver": "string",
- "CgroupDriver": "EMPTY",
- "CgroupVersion": "EMPTY",
- "NEventsListener": 0,
- "KernelVersion": "string",
- "OperatingSystem": "string",
- "OSVersion": "string",
- "OSType": "string",
- "Architecture": "string",
- "NCPU": 0,
- "MemTotal": 0,
- "IndexServerAddress": "string",
- "RegistryConfig": {
- "AllowNondistributableArtifactsCIDRs": [
- "string"
], - "AllowNondistributableArtifactsHostnames": [
- "string"
], - "InsecureRegistryCIDRs": [
- "string"
], - "IndexConfigs": {
- "property1": {
- "Name": "string",
- "Mirrors": [
- "string"
], - "Secure": true,
- "Official": true
}, - "property2": {
- "Name": "string",
- "Mirrors": [
- "string"
], - "Secure": true,
- "Official": true
}
}, - "Mirrors": [
- "string"
]
}, - "GenericResources": {
- "NamedResourceSpec": {
- "Kind": "string",
- "Value": "string"
}, - "DiscreteResourceSpec": {
- "Kind": "string",
- "Value": 0
}
}, - "HttpProxy": "string",
- "HttpsProxy": "string",
- "NoProxy": "string",
- "Name": "string",
- "Labels": [
- "string"
], - "ExperimentalBuild": true,
- "ServerVersion": "string",
- "Runtimes": {
- "property1": {
- "path": "string",
- "runtimeArgs": [
- "string"
], - "status": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "path": "string",
- "runtimeArgs": [
- "string"
], - "status": {
- "property1": "string",
- "property2": "string"
}
}
}, - "DefaultRuntime": "string",
- "Swarm": {
- "NodeID": "string",
- "NodeAddr": "string",
- "LocalNodeState": "EMPTY",
- "ControlAvailable": true,
- "Error": "string",
- "RemoteManagers": [
- {
- "NodeID": "string",
- "Addr": "string"
}
], - "Nodes": 0,
- "Managers": 0,
- "Cluster": {
- "ID": "string",
- "Version": {
- "Index": 0
}, - "CreatedAt": "2021-01-01T00:00:00.000000000Z",
- "UpdatedAt": "2021-01-01T00:00:00.000000000Z",
- "Spec": {
- "Name": "string",
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "Orchestration": {
- "TaskHistoryRetentionLimit": 0
}, - "Raft": {
- "SnapshotInterval": 0,
- "KeepOldSnapshots": 0,
- "LogEntriesForSlowFollowers": 0,
- "ElectionTick": 0,
- "HeartbeatTick": 0
}, - "Dispatcher": {
- "HeartbeatPeriod": 0
}, - "CAConfig": {
- "NodeCertExpiry": 0,
- "ExternalCAs": [
- {
- "Protocol": "EMPTY",
- "URL": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}, - "CACert": "string"
}
], - "SigningCACert": "string",
- "SigningCAKey": "string",
- "ForceRotate": 0
}, - "EncryptionConfig": {
- "AutoLockManagers": true
}, - "TaskDefaults": {
- "LogDriver": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}
}, - "TLSInfo": {
- "TrustRoot": "string",
- "CertIssuerSubject": "string",
- "CertIssuerPublicKey": "string"
}, - "RootRotationInProgress": true,
- "DataPathPort": 0,
- "DefaultAddrPool": [
- "string"
], - "SubnetSize": 0
}
}, - "LiveRestoreEnabled": true,
- "Isolation": "EMPTY",
- "InitBinary": "string",
- "ContainerdCommit": {
- "ID": "string",
- "Expected": "string"
}, - "RuncCommit": {
- "ID": "string",
- "Expected": "string"
}, - "InitCommit": {
- "ID": "string",
- "Expected": "string"
}, - "SecurityOptions": [
- "string"
], - "ProductLicense": "string",
- "DefaultAddressPools": [
- {
- "Base": "string",
- "Size": 0
}
], - "Warnings": [
- "string"
], - "CDISpecDirs": [
- "string"
], - "HostGateway": "string",
- "Config": {
- "hosts": [
- "string"
], - "state_dir": "string",
- "docker_host": "string",
- "gateway": "string",
- "hostname": "string",
- "nodes": [
- "string"
], - "advertise_addr": "string",
- "conf_dir": "string",
- "gid": 0,
- "ssl": {
- "Cert": "string",
- "CertKey": "string",
- "CertCa": "string"
}
}
}| Redirect | string or null Enum: "MovedPermanently" "Permanent" "Temporary" |
| Url required | string Url to target |
{- "Url": "string",
- "Redirect": "MovedPermanently"
}Policy for pulling images related to process objects (job, cargo, vm)
"Never"| Mirrors | Array of strings or null List of mirrors, expressed as URIs. |
| Name | string or null Name of the registry, such as "docker.io". |
| Official | boolean or null Indicates whether this is an official registry (i.e., Docker Hub / docker.io) |
| Secure | boolean or null Indicates if the registry is part of the list of insecure registries. If |
{- "Name": "string",
- "Mirrors": [
- "string"
], - "Secure": true,
- "Official": true
}Array of objects or null (IpamConfig) List of IPAM configuration options, specified as a map: | |||||||||
Array
| |||||||||
| Driver | string or null Name of the IPAM driver to use. | ||||||||
object or null Driver-specific options, specified as a map. | |||||||||
| |||||||||
{- "Driver": "string",
- "Config": [
- {
- "Subnet": "string",
- "IPRange": "string",
- "Gateway": "string",
- "AuxiliaryAddresses": {
- "property1": "string",
- "property2": "string"
}
}
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}object or null | |||
| |||
| Gateway | string or null | ||
| IPRange | string or null | ||
| Subnet | string or null | ||
{- "Subnet": "string",
- "IPRange": "string",
- "Gateway": "string",
- "AuxiliaryAddresses": {
- "property1": "string",
- "property2": "string"
}
}required | Array of objects (Config) Containers to run | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CreatedAt required | string <date-time> When the job have been created | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the job | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Schedule | string or null Schedule of the job (cron) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null Secrets to load as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ObjPsStatus) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ttl | integer or null >= 0 Remove the job after (x) seconds after execution | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UpdatedAt required | string <date-time> When the job have been updated | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}| InstanceFailed required | integer >= 0 Number of instance failed | ||||||||||||||||||||||
| InstanceRunning required | integer >= 0 Number of instance running | ||||||||||||||||||||||
required | Array of objects (Process) List of instances | ||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| InstanceSuccess required | integer >= 0 Number of instance that succeeded | ||||||||||||||||||||||
| InstanceTotal required | integer >= 0 Number of instances | ||||||||||||||||||||||
required | object (Job) A job is a collection of containers to run in sequence as a single unit to act like a command | ||||||||||||||||||||||
| |||||||||||||||||||||||
required | object (ObjPsStatus) | ||||||||||||||||||||||
| |||||||||||||||||||||||
{- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "InstanceTotal": 0,
- "InstanceSuccess": 0,
- "InstanceRunning": 0,
- "InstanceFailed": 0,
- "Spec": {
- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}, - "Instances": [
- {
- "Key": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Kind": "vm",
- "NodeKey": "string",
- "KindKey": "string",
- "Data": {
- "Id": "string",
- "Created": "string",
- "Path": "string",
- "Args": [
- "string"
], - "State": {
- "Status": "EMPTY",
- "Running": true,
- "Paused": true,
- "Restarting": true,
- "OOMKilled": true,
- "Dead": true,
- "Pid": 0,
- "ExitCode": 0,
- "Error": "string",
- "StartedAt": "string",
- "FinishedAt": "string",
- "Health": {
- "Status": "EMPTY",
- "FailingStreak": 0,
- "Log": [
- {
- "Start": "2021-01-01T00:00:00.000000000Z",
- "End": "2021-01-01T00:00:00.000000000Z",
- "ExitCode": 0,
- "Output": "string"
}
]
}
}, - "Image": "string",
- "ResolvConfPath": "string",
- "HostnamePath": "string",
- "HostsPath": "string",
- "LogPath": "string",
- "Name": "string",
- "RestartCount": 0,
- "Driver": "string",
- "Platform": "string",
- "MountLabel": "string",
- "ProcessLabel": "string",
- "AppArmorProfile": "string",
- "ExecIDs": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "GraphDriver": {
- "Name": "string",
- "Data": {
- "property1": "string",
- "property2": "string"
}
}, - "SizeRw": 0,
- "SizeRootFs": 0,
- "Mounts": [
- {
- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}
], - "Config": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]
}, - "NetworkSettings": {
- "Bridge": "string",
- "SandboxID": "string",
- "HairpinMode": true,
- "LinkLocalIPv6Address": "string",
- "LinkLocalIPv6PrefixLen": 0,
- "Ports": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "SandboxKey": "string",
- "SecondaryIPAddresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "SecondaryIPv6Addresses": [
- {
- "Addr": "string",
- "PrefixLen": 0
}
], - "EndpointID": "string",
- "Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "MacAddress": "string",
- "Networks": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
}
]
}required | Array of objects (Config) List of container to run | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullPolicy | string or null Enum: "Never" "Always" "IfNotPresent" Policy for pulling images related to process objects (job, cargo, vm) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImagePullSecret | string or null Secret to use when pulling the image | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Metadata (user defined) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Name required | string Name of the job | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Schedule | string or null Schedule of the job (cron) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Secrets | Array of strings or null Secrets to load as environment variables | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ttl | integer or null >= 0 Remove the job after (x) seconds after execution | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "Name": "string",
- "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}| InstanceFailed required | integer >= 0 Number of instance failed | ||||||||||||||||||||||
| InstanceRunning required | integer >= 0 Number of instance running | ||||||||||||||||||||||
| InstanceSuccess required | integer >= 0 Number of instance that succeeded | ||||||||||||||||||||||
| InstanceTotal required | integer >= 0 Number of instances | ||||||||||||||||||||||
required | object (Job) A job is a collection of containers to run in sequence as a single unit to act like a command | ||||||||||||||||||||||
| |||||||||||||||||||||||
{- "InstanceTotal": 0,
- "InstanceSuccess": 0,
- "InstanceRunning": 0,
- "InstanceFailed": 0,
- "Spec": {
- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Secrets": [
- "string"
], - "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "Schedule": "string",
- "Ttl": 0,
- "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Containers": [
- {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- "string"
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": null,
- "property2": null
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- "string"
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}
]
}
}Current local status of this node.
Enumeration of values.
Since this enum's variants do not hold data, we can easily define them them as #[repr(C)]
which helps with FFI.
"EMPTY"| DisableLogging | boolean or null Disable logging for this target |
| Key required | string The key of the cargo or the vm to target |
| Path | string or null The http path to target when using http |
| Port required | integer <int32> >= 0 The port of the cargo or the vm to target |
{- "Key": "string",
- "Port": 0,
- "Path": "string",
- "DisableLogging": true
}| commit | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commit_peak | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commitbytes | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commitpeakbytes | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| failcnt | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| max_usage | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| privateworkingset | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
(MemoryStatsStatsV1 (object or null)) or (MemoryStatsStatsV2 (object or null)) Granular memory statistics for the container. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| usage | integer or null <int64> >= 0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{- "stats": {
- "cache": 0,
- "dirty": 0,
- "mapped_file": 0,
- "total_inactive_file": 0,
- "pgpgout": 0,
- "rss": 0,
- "total_mapped_file": 0,
- "writeback": 0,
- "unevictable": 0,
- "pgpgin": 0,
- "total_unevictable": 0,
- "pgmajfault": 0,
- "total_rss": 0,
- "total_rss_huge": 0,
- "total_writeback": 0,
- "total_inactive_anon": 0,
- "rss_huge": 0,
- "hierarchical_memory_limit": 0,
- "total_pgfault": 0,
- "total_active_file": 0,
- "active_anon": 0,
- "total_active_anon": 0,
- "total_pgpgout": 0,
- "total_cache": 0,
- "total_dirty": 0,
- "inactive_anon": 0,
- "active_file": 0,
- "pgfault": 0,
- "inactive_file": 0,
- "total_pgmajfault": 0,
- "total_pgpgin": 0,
- "hierarchical_memsw_limit": 0,
- "shmem": 0,
- "total_shmem": 0
}, - "max_usage": 0,
- "usage": 0,
- "failcnt": 0,
- "limit": 0,
- "commit": 0,
- "commit_peak": 0,
- "commitbytes": 0,
- "commitpeakbytes": 0,
- "privateworkingset": 0
}| active_anon required | integer <int64> >= 0 |
| active_file required | integer <int64> >= 0 |
| cache required | integer <int64> >= 0 |
| dirty required | integer <int64> >= 0 |
| hierarchical_memory_limit required | integer <int64> >= 0 |
| hierarchical_memsw_limit | integer or null <int64> >= 0 |
| inactive_anon required | integer <int64> >= 0 |
| inactive_file required | integer <int64> >= 0 |
| mapped_file required | integer <int64> >= 0 |
| pgfault required | integer <int64> >= 0 |
| pgmajfault required | integer <int64> >= 0 |
| pgpgin required | integer <int64> >= 0 |
| pgpgout required | integer <int64> >= 0 |
| rss required | integer <int64> >= 0 |
| rss_huge required | integer <int64> >= 0 |
| shmem | integer or null <int64> >= 0 |
| total_active_anon required | integer <int64> >= 0 |
| total_active_file required | integer <int64> >= 0 |
| total_cache required | integer <int64> >= 0 |
| total_dirty required | integer <int64> >= 0 |
| total_inactive_anon required | integer <int64> >= 0 |
| total_inactive_file required | integer <int64> >= 0 |
| total_mapped_file required | integer <int64> >= 0 |
| total_pgfault required | integer <int64> >= 0 |
| total_pgmajfault required | integer <int64> >= 0 |
| total_pgpgin required | integer <int64> >= 0 |
| total_pgpgout required | integer <int64> >= 0 |
| total_rss required | integer <int64> >= 0 |
| total_rss_huge required | integer <int64> >= 0 |
| total_shmem | integer or null <int64> >= 0 |
| total_unevictable required | integer <int64> >= 0 |
| total_writeback required | integer <int64> >= 0 |
| unevictable required | integer <int64> >= 0 |
| writeback required | integer <int64> >= 0 |
{- "cache": 0,
- "dirty": 0,
- "mapped_file": 0,
- "total_inactive_file": 0,
- "pgpgout": 0,
- "rss": 0,
- "total_mapped_file": 0,
- "writeback": 0,
- "unevictable": 0,
- "pgpgin": 0,
- "total_unevictable": 0,
- "pgmajfault": 0,
- "total_rss": 0,
- "total_rss_huge": 0,
- "total_writeback": 0,
- "total_inactive_anon": 0,
- "rss_huge": 0,
- "hierarchical_memory_limit": 0,
- "total_pgfault": 0,
- "total_active_file": 0,
- "active_anon": 0,
- "total_active_anon": 0,
- "total_pgpgout": 0,
- "total_cache": 0,
- "total_dirty": 0,
- "inactive_anon": 0,
- "active_file": 0,
- "pgfault": 0,
- "inactive_file": 0,
- "total_pgmajfault": 0,
- "total_pgpgin": 0,
- "hierarchical_memsw_limit": 0,
- "shmem": 0,
- "total_shmem": 0
}| active_anon required | integer <int64> >= 0 |
| active_file required | integer <int64> >= 0 |
| cache required | integer <int64> >= 0 |
| dirty required | integer <int64> >= 0 |
| hierarchical_memory_limit required | integer <int64> >= 0 |
| hierarchical_memsw_limit | integer or null <int64> >= 0 |
| inactive_anon required | integer <int64> >= 0 |
| inactive_file required | integer <int64> >= 0 |
| mapped_file required | integer <int64> >= 0 |
| pgfault required | integer <int64> >= 0 |
| pgmajfault required | integer <int64> >= 0 |
| pgpgin required | integer <int64> >= 0 |
| pgpgout required | integer <int64> >= 0 |
| rss required | integer <int64> >= 0 |
| rss_huge required | integer <int64> >= 0 |
| shmem | integer or null <int64> >= 0 |
| total_active_anon required | integer <int64> >= 0 |
| total_active_file required | integer <int64> >= 0 |
| total_cache required | integer <int64> >= 0 |
| total_dirty required | integer <int64> >= 0 |
| total_inactive_anon required | integer <int64> >= 0 |
| total_inactive_file required | integer <int64> >= 0 |
| total_mapped_file required | integer <int64> >= 0 |
| total_pgfault required | integer <int64> >= 0 |
| total_pgmajfault required | integer <int64> >= 0 |
| total_pgpgin required | integer <int64> >= 0 |
| total_pgpgout required | integer <int64> >= 0 |
| total_rss required | integer <int64> >= 0 |
| total_rss_huge required | integer <int64> >= 0 |
| total_shmem | integer or null <int64> >= 0 |
| total_unevictable required | integer <int64> >= 0 |
| total_writeback required | integer <int64> >= 0 |
| unevictable required | integer <int64> >= 0 |
| writeback required | integer <int64> >= 0 |
{- "cache": 0,
- "dirty": 0,
- "mapped_file": 0,
- "total_inactive_file": 0,
- "pgpgout": 0,
- "rss": 0,
- "total_mapped_file": 0,
- "writeback": 0,
- "unevictable": 0,
- "pgpgin": 0,
- "total_unevictable": 0,
- "pgmajfault": 0,
- "total_rss": 0,
- "total_rss_huge": 0,
- "total_writeback": 0,
- "total_inactive_anon": 0,
- "rss_huge": 0,
- "hierarchical_memory_limit": 0,
- "total_pgfault": 0,
- "total_active_file": 0,
- "active_anon": 0,
- "total_active_anon": 0,
- "total_pgpgout": 0,
- "total_cache": 0,
- "total_dirty": 0,
- "inactive_anon": 0,
- "active_file": 0,
- "pgfault": 0,
- "inactive_file": 0,
- "total_pgmajfault": 0,
- "total_pgpgin": 0,
- "hierarchical_memsw_limit": 0,
- "shmem": 0,
- "total_shmem": 0
}| active_anon required | integer <int64> >= 0 |
| active_file required | integer <int64> >= 0 |
| anon required | integer <int64> >= 0 |
| anon_thp required | integer <int64> >= 0 |
| file required | integer <int64> >= 0 |
| file_dirty required | integer <int64> >= 0 |
| file_mapped required | integer <int64> >= 0 |
| file_writeback required | integer <int64> >= 0 |
| inactive_anon required | integer <int64> >= 0 |
| inactive_file required | integer <int64> >= 0 |
| kernel_stack required | integer <int64> >= 0 |
| pgactivate required | integer <int64> >= 0 |
| pgdeactivate required | integer <int64> >= 0 |
| pgfault required | integer <int64> >= 0 |
| pglazyfree required | integer <int64> >= 0 |
| pglazyfreed required | integer <int64> >= 0 |
| pgmajfault required | integer <int64> >= 0 |
| pgrefill required | integer <int64> >= 0 |
| pgscan required | integer <int64> >= 0 |
| pgsteal required | integer <int64> >= 0 |
| shmem required | integer <int64> >= 0 |
| slab required | integer <int64> >= 0 |
| slab_reclaimable required | integer <int64> >= 0 |
| slab_unreclaimable required | integer <int64> >= 0 |
| sock required | integer <int64> >= 0 |
| thp_collapse_alloc required | integer <int64> >= 0 |
| thp_fault_alloc required | integer <int64> >= 0 |
| unevictable required | integer <int64> >= 0 |
| workingset_activate required | integer <int64> >= 0 |
| workingset_nodereclaim required | integer <int64> >= 0 |
| workingset_refault required | integer <int64> >= 0 |
{- "anon": 0,
- "file": 0,
- "kernel_stack": 0,
- "slab": 0,
- "sock": 0,
- "shmem": 0,
- "file_mapped": 0,
- "file_dirty": 0,
- "file_writeback": 0,
- "anon_thp": 0,
- "inactive_anon": 0,
- "active_anon": 0,
- "inactive_file": 0,
- "active_file": 0,
- "unevictable": 0,
- "slab_reclaimable": 0,
- "slab_unreclaimable": 0,
- "pgfault": 0,
- "pgmajfault": 0,
- "workingset_refault": 0,
- "workingset_activate": 0,
- "workingset_nodereclaim": 0,
- "pgrefill": 0,
- "pgscan": 0,
- "pgsteal": 0,
- "pgactivate": 0,
- "pgdeactivate": 0,
- "pglazyfree": 0,
- "pglazyfreed": 0,
- "thp_fault_alloc": 0,
- "thp_collapse_alloc": 0
}| CreatedAt required | string <date-time> When the metric was created |
| Data required | any The data of the metric |
| ExpiresAt required | string <date-time> When the metric will expire |
| Key required | string <uuid> The key of the metric in the database |
| Kind required | string The kind of the metric |
| NodeName required | string The node where the metric come from |
| Note | string or null Optional note about the metric |
{- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "ExpiresAt": "2019-08-24T14:15:22Z",
- "NodeName": "string",
- "Kind": "string",
- "Data": null,
- "Note": "string"
}| Data required | any The data of the metric |
| Kind required | string The kind of the metric |
| Note | string or null Optional note about the metric |
{- "Kind": "string",
- "Data": null,
- "Note": "string"
}object or null Optional configuration for the | |||||||||||
| |||||||||||
| Consistency | string or null The consistency requirement for the mount: | ||||||||||
| ReadOnly | boolean or null Whether the mount should be read-only. | ||||||||||
| Source | string or null Mount source (e.g. a volume name, a host path). | ||||||||||
| Target | string or null Container path. | ||||||||||
object or null Optional configuration for the | |||||||||||
| |||||||||||
| Type | string or null Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster" | ||||||||||
object or null Optional configuration for the | |||||||||||
| |||||||||||
{- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}| CreateMountpoint | boolean or null Create mount point on host if missing |
| NonRecursive | boolean or null Disable recursive bind mount. |
| Propagation | string or null Enum: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave" |
| ReadOnlyForceRecursive | boolean or null Raise an error if the mount cannot be made recursively read-only. |
| ReadOnlyNonRecursive | boolean or null Make the mount non-recursively read-only, but still leave the mount recursive (unless NonRecursive is set to true in conjunction). |
{- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}"EMPTY"| Destination | string or null Destination is the path relative to the container root ( |
| Driver | string or null Driver is the volume driver used to create the volume (if it is a volume). |
| Mode | string or null Mode is a comma separated list of options supplied by the user when creating the bind/volume mount. The default is platform-specific ( |
| Name | string or null Name is the name reference to the underlying data defined by |
| Propagation | string or null Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the Linux kernel documentation for details. This field is not used on Windows. |
| RW | boolean or null Whether the mount is mounted writable (read-write). |
| Source | string or null Source location of the mount. For volumes, this contains the storage location of the volume (within |
| Type | string or null Enum: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster" |
{- "Type": "EMPTY",
- "Name": "string",
- "Source": "string",
- "Destination": "string",
- "Driver": "string",
- "Mode": "string",
- "RW": true,
- "Propagation": "string"
}"EMPTY"| Mode | integer or null <int64> The permission mode for the tmpfs mount in an integer. |
| SizeBytes | integer or null <int64> The size for the tmpfs mount in bytes. |
{- "SizeBytes": 0,
- "Mode": 0
}object or null Map of driver specific options | |||||
| |||||
object or null User-defined key/value metadata. | |||||
| |||||
| NoCopy | boolean or null Populate volume with data from the target. | ||||
{- "NoCopy": true,
- "Labels": {
- "property1": "string",
- "property2": "string"
}, - "DriverConfig": {
- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}
}| Name | string or null Name of the driver to use to create the volume. | ||
object or null key/value map of driver specific options. | |||
| |||
{- "Name": "string",
- "Options": {
- "property1": "string",
- "property2": "string"
}
}| CreatedAt required | string <date-time> When the namespace was created |
| Name required | string The name as primary key of the namespace |
{- "Name": "string",
- "CreatedAt": "2019-08-24T14:15:22Z"
}required | Array of objects (CargoInspect) Number of cargoes | ||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||
| Name required | string Name of the namespace | ||||||||||||||||||||||||||
required | object (Network) | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
{- "Name": "string",
- "Cargoes": [
- {
- "NamespaceName": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "InstanceTotal": 0,
- "InstanceRunning": 0,
- "Status": {
- "UpdatedAt": "2019-08-24T14:15:22Z",
- "Wanted": "create",
- "PrevWanted": "create",
- "Actual": "create",
- "PrevActual": "create"
}, - "Spec": {
- "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
- "CargoKey": "string",
- "Version": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Name": "string",
- "Metadata": {
- "property1": "string",
- "property2": "string"
}, - "InitContainer": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
], - "HostConfig": {
- "CpuShares": 0,
- "Memory": 0,
- "CgroupParent": "string",
- "BlkioWeight": 0,
- "BlkioWeightDevice": [
- {
- "Path": "string",
- "Weight": 0
}
], - "BlkioDeviceReadBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteBps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceReadIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "BlkioDeviceWriteIOps": [
- {
- "Path": "string",
- "Rate": 0
}
], - "CpuPeriod": 0,
- "CpuQuota": 0,
- "CpuRealtimePeriod": 0,
- "CpuRealtimeRuntime": 0,
- "CpusetCpus": "string",
- "CpusetMems": "string",
- "Devices": [
- {
- "PathOnHost": "string",
- "PathInContainer": "string",
- "CgroupPermissions": "string"
}
], - "DeviceCgroupRules": [
- "string"
], - "DeviceRequests": [
- {
- "Driver": "string",
- "Count": 0,
- "DeviceIDs": [
- "string"
], - "Capabilities": [
- [
- null
]
], - "Options": {
- "property1": "string",
- "property2": "string"
}
}
], - "KernelMemoryTCP": 0,
- "MemoryReservation": 0,
- "MemorySwap": 0,
- "MemorySwappiness": 0,
- "NanoCpus": 0,
- "OomKillDisable": true,
- "Init": true,
- "PidsLimit": 0,
- "Ulimits": [
- {
- "Name": "string",
- "Soft": 0,
- "Hard": 0
}
], - "CpuCount": 0,
- "CpuPercent": 0,
- "IOMaximumIOps": 0,
- "IOMaximumBandwidth": 0,
- "Binds": [
- "string"
], - "ContainerIDFile": "string",
- "LogConfig": {
- "Type": "string",
- "Config": {
- "property1": "string",
- "property2": "string"
}
}, - "NetworkMode": "string",
- "PortBindings": {
- "<port/tcp|udp>": [
- {
- "HostPort": "string",
- "HostIp": "string"
}
]
}, - "RestartPolicy": {
- "Name": "EMPTY",
- "MaximumRetryCount": 0
}, - "AutoRemove": true,
- "VolumeDriver": "string",
- "VolumesFrom": [
- "string"
], - "Mounts": [
- {
- "Target": "string",
- "Source": "string",
- "Type": "EMPTY",
- "ReadOnly": true,
- "Consistency": "string",
- "BindOptions": {
- "Propagation": "EMPTY",
- "NonRecursive": true,
- "CreateMountpoint": true,
- "ReadOnlyNonRecursive": true,
- "ReadOnlyForceRecursive": true
}, - "VolumeOptions": {
- "NoCopy": true,
- "Labels": {
- "property1": null,
- "property2": null
}, - "DriverConfig": {
- "Name": null,
- "Options": { }
}
}, - "TmpfsOptions": {
- "SizeBytes": 0,
- "Mode": 0
}
}
], - "ConsoleSize": [
- 0
], - "Annotations": {
- "property1": "string",
- "property2": "string"
}, - "CapAdd": [
- "string"
], - "CapDrop": [
- "string"
], - "CgroupnsMode": "EMPTY",
- "Dns": [
- "string"
], - "DnsOptions": [
- "string"
], - "DnsSearch": [
- "string"
], - "ExtraHosts": [
- "string"
], - "GroupAdd": [
- "string"
], - "IpcMode": "string",
- "Cgroup": "string",
- "Links": [
- "string"
], - "OomScoreAdj": 0,
- "PidMode": "string",
- "Privileged": true,
- "PublishAllPorts": true,
- "ReadonlyRootfs": true,
- "SecurityOpt": [
- "string"
], - "StorageOpt": {
- "property1": "string",
- "property2": "string"
}, - "Tmpfs": {
- "property1": "string",
- "property2": "string"
}, - "UTSMode": "string",
- "UsernsMode": "string",
- "ShmSize": 0,
- "Sysctls": {
- "property1": "string",
- "property2": "string"
}, - "Runtime": "string",
- "Isolation": "EMPTY",
- "MaskedPaths": [
- "string"
], - "ReadonlyPaths": [
- "string"
]
}, - "NetworkingConfig": {
- "EndpointsConfig": {
- "property1": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- null
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}, - "property2": {
- "IPAMConfig": {
- "IPv4Address": "string",
- "IPv6Address": "string",
- "LinkLocalIPs": [
- null
]
}, - "Links": [
- "string"
], - "MacAddress": "string",
- "Aliases": [
- "string"
], - "NetworkID": "string",
- "EndpointID": "string",
- "Gateway": "string",
- "IPAddress": "string",
- "IPPrefixLen": 0,
- "IPv6Gateway": "string",
- "GlobalIPv6Address": "string",
- "GlobalIPv6PrefixLen": 0,
- "DriverOpts": {
- "property1": "string",
- "property2": "string"
}, - "DNSNames": [
- "string"
]
}
}
}
}, - "Secrets": [
- "string"
], - "ImagePullSecret": "string",
- "ImagePullPolicy": "Never",
- "Container": {
- "Hostname": "string",
- "Domainname": "string",
- "User": "string",
- "AttachStdin": true,
- "AttachStdout": true,
- "AttachStderr": true,
- "ExposedPorts": {
- "property1": { },
- "property2": { }
}, - "Tty": true,
- "OpenStdin": true,
- "StdinOnce": true,
- "Env": [
- "string"
], - "Cmd": [
- "string"
], - "Healthcheck": {
- "Test": [
- "string"
], - "Interval": 0,
- "Timeout": 0,
- "Retries": 0,
- "StartPeriod": 0,
- "StartInterval": 0
}, - "ArgsEscaped": true,
- "Image": "string",
- "Volumes": {
- "property1": { },
- "property2": { }
}, - "WorkingDir": "string",
- "Entrypoint": [
- "string"
], - "NetworkDisabled": true,
- "MacAddress": "string",
- "OnBuild": [
- "string"
], - "Labels": {
- "property1": "string",
- "property2": "string"
}, - "StopSignal": "string",
- "StopTimeout": 0,
- "Shell": [
- "string"
]