Skip to Content

79 операции · 215 схемы · спецификация v0.18.1

Скачать OpenAPI YAML ↗
API docs by Redocly

Nanocl Daemon (v0.18.1)

nanocl contributors: [email protected] License: MIT OR Apache-2.0

Nanocl Daemon — это HTTP REST API.
Это API, используемый Nanocl Client: все возможности Nanocl Client доступны и через API.

Большинство команд клиента напрямую соответствуют конечным точкам API; например, nanocl ps соответствует GET /processes.
Важное исключение — запуск Cargo, состоящий из нескольких вызовов API.

Спецификация OpenAPI

API документирован в формате OpenAPI с помощью Utoipa.
Спецификация создаётся автоматически только в режиме разработки.
При выпуске версии созданный файл переносится в нашу документацию.

Совместное использование ресурсов между источниками

API поддерживает Cross-Origin Resource Sharing (CORS) в соответствии со спецификацией W3C.
Это позволяет выполнять междоменные запросы из браузера.
Все ответы разрешают любые источники, поэтому они полностью публичны и доступны всем, включая код любого сайта.

Cargoes

Получить список Cargo с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Общий фильтр.

namespace
string

Необязательный фильтр пространства имён; при отсутствии или пустом значении возвращаются все пространства имён.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать Cargo по его спецификации.

query Parameters
namespace
string

Пространство имён для создания Cargo; по умолчанию 'global'.

Request Body schema: application/json
required
required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления перед контейнерами приложения.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

object

Метаданные Cargo, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
One of
null
null or CargoPlacementSpec (object)
One of
null
null or HashMap (object)
One of
null
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "Replicas": 1,
  • "NetworkMode": { },
  • "PortBindings": { },
  • "Hostname": "string",
  • "Dns": [
    ],
  • "Secrets": [
    ],
  • "Placement": { },
  • "ResourceRequirement": { },
  • "InitContainers": [
    ],
  • "Containers": [
    ]
}

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Подсчитать Cargo с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "my-cargo" } } } }

Общий фильтр.

namespace
string

Необязательный фильтр пространства имён; при отсутствии или пустом значении возвращаются все пространства имён.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Откатить Cargo к определённой записи истории.

path Parameters
cargo_key
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

history_key
required
string

Ключ истории Cargo.

Ответы

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Обновить Cargo новой спецификацией и создать запись истории.

path Parameters
key
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

Request Body schema: application/json
required
required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления перед контейнерами приложения.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

object

Метаданные Cargo, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
One of
null
null or CargoPlacementSpec (object)
One of
null
null or HashMap (object)
One of
null
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "Replicas": 1,
  • "NetworkMode": { },
  • "PortBindings": { },
  • "Hostname": "string",
  • "Dns": [
    ],
  • "Secrets": [
    ],
  • "Placement": { },
  • "ResourceRequirement": { },
  • "InitContainers": [
    ],
  • "Containers": [
    ]
}

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Удалить Cargo по каноническому ключу.

path Parameters
key
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

query Parameters
force
required
boolean

Если true, принудительно удалить, даже если Cargo запущен.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Изменить Cargo по каноническому ключу и добавить запись истории.

path Parameters
key
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

Request Body schema: application/json
required
Массив objects or null (ContainerSpec)

Новое объявление контейнеров приложения.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

Dns
Массив strings or null

Новый набор DNS-серверов для владельца сети Cargo.

Hostname
string or null

Новое имя хоста Docker для владельца сети Cargo.

Массив objects or null (ContainerSpec)

Новое объявление упорядоченных контейнеров инициализации.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

object

Новые метаданные Cargo, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
string or null

Новое имя Cargo.

null or CargoNetworkMode (string)
One of
null
null or CargoPlacementSpec (object)
One of
null
null or HashMap (object)
One of
null
Replicas
integer or null >= 1

Новое число реплик.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Массив strings or null

Новый набор общих секретов на уровне Cargo.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "Replicas": 1,
  • "NetworkMode": { },
  • "PortBindings": { },
  • "Hostname": "string",
  • "Dns": [
    ],
  • "Secrets": [
    ],
  • "Placement": { },
  • "ResourceRequirement": { },
  • "InitContainers": [
    ],
  • "Containers": [
    ]
}

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Получить список историй Cargo.

path Parameters
key
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Получить подробные сведения о Cargo по каноническому ключу.

path Parameters
key
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

Ответы

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

Events

Конечные точки управления событиями.

Получить список событий с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "kind": { "eq": "normal" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Подсчитать события с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "namespace_name": { "eq": "global" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Следить за новыми событиями всех соседних узлов с необязательным условием остановки потока.

Request Body schema: application/json
Array
required
Массив 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 strings or strings or objects (NativeEventAction)
ActorKey
string or null
null or EventActorKind (string)
Kind
required
Массив strings (EventKind)
Допустимые элементы Допустимые значения: "error" "normal" "warning"
RelatedKey
string or null
null or EventActorKind (string)

Ответы

Примеры запросов

Content type
application/json
[
  • {
    }
]

Получить подробные сведения о событии.

path Parameters
key
required
string

Ключ события.

Ответы

Примеры ответов

Content type
application/json
{
  • "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": { },
  • "Related": { },
  • "Metadata": {
    }
}

Jobs

Конечные точки управления заданиями.

Получить список заданий с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "job-example" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать задание.

Request Body schema: application/json
required
required
Массив objects (Config)

Список запускаемых контейнеров.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or HealthConfig (object)
null or HostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or NetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

null or ImagePullPolicy (string)
One of
null
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя задания.

Schedule
string or null

Выражение cron с пятью полями или поддерживаемое сокращение; см. [crate::cron::validate_schedule].

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

Примеры ответов

Content type
application/json
{
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Подсчитать задания.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "key": { "eq": "job-example" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Удалить задание по имени.

path Parameters
name
required
string

Имя задания.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Получить подробные сведения о задании.

path Parameters
name
required
string

Имя задания.

Ответы

Примеры ответов

Content type
application/json
{
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    },
  • "Instances": [
    ]
}

Metrics

Конечные точки управления метриками.

Получить список метрик с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "kind": { "eq": "CPU" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать метрику.

Request Body schema: application/json
required
Data
required
any

Данные метрики.

Kind
required
string

Тип метрики.

Note
string or null

Необязательная заметка о метрике.

Ответы

Примеры запросов

Content type
application/json
{
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Примеры ответов

Content type
application/json
{
  • "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"
}

Подсчитать метрики с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "kind": { "eq": "ncproxy.io/http" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Получить подробные сведения о метрике.

path Parameters
key
required
string

Ключ метрики.

Ответы

Примеры ответов

Content type
application/json
{
  • "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"
}

Namespaces

Конечные точки управления пространствами имён.

Получить список пространств имён с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать пространство имён.

Request Body schema: application/json
required
Metadata
any

Метаданные, заданные пользователем.

Name
required
string

Имя пространства имён.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Metadata": null
}

Примеры ответов

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null
}

Подсчитать пространства имён.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Удалить пространство имён.

path Parameters
name
required
string

Имя удаляемого пространства имён.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Получить подробные сведения о пространстве имён.

path Parameters
name
required
string

Имя пространства имён для просмотра.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Networks

Конечные точки просмотра сетей Docker отдельных узлов.

Получить список сохранённых снимков сетей Docker для отдельных узлов.

query Parameters
filter
string
Пример: filter={ "where": { "node_name": { "eq": "node-a" } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Просмотреть сохранённую сеть Docker по её детерминированному ключу.

path Parameters
key
required
string

Ключ сети в формате node_name.network_name.

Ответы

Примеры ответов

Content type
application/json
{
  • "Key": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "NodeName": "string",
  • "Data": {
    },
  • "Metadata": null
}

Nodes

Конечные точки управления узлами.

Получить список узлов.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Запустить экземпляры Cargo на узле, используемом для связи между узлами.

Request Body schema: application/json
required
CargoKey
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

required
Массив objects (CargoReplicaTask)

Точные устойчивые реплики, назначенные этому узлу и упорядоченные по порядковому номеру.

Array
Key
required
string <uuid>

Сохранённая устойчивая идентичность реплики Cargo.

Ordinal
required
integer <int32>

Устойчивый порядковый номер реплики, уникальный в пределах Cargo.

Ответы

Примеры запросов

Content type
application/json
{
  • "CargoKey": "string",
  • "Replicas": [
    ]
}

Подсчитать узлы.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Processes

Конечные точки управления процессами.

Запустить экземпляр exec Docker и подключиться к нему через WebSocket RFC6455.

Двоичные кадры клиента содержат необработанный stdin. Текстовые команды управления: stdin_eof, resize и detach. Двоичные кадры сервера начинаются с 0x01 для stdout, 0x02 для stderr или 0x03 для console; текстовые команды сообщают exit, detached или error.

path Parameters
id
required
string

Идентификатор экземпляра exec Docker.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Запустить экземпляр exec Docker без подключения потоков.

path Parameters
id
required
string

Идентификатор экземпляра exec Docker.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Получить статистику процесса по имени ключа.

path Parameters
name
required
string
Пример: deploy-example

Имя процесса.

query Parameters
one_shot
boolean

Вернуть статистику только один раз.

stream
boolean

Вернуть поток статистики.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Получить список процессов с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "where": { "name": { "eq": "test" } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Подсчитать процессы.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Получить журналы процессов для типа и канонического ключа ресурса.

path Parameters
key
required
string
Пример: global.deploy-example

Канонический ключ ресурса в формате {namespace}.{name}; задания используют ключ без пространства имён.

kind
required
string
Пример: cargo

Тип процесса.

query Parameters
follow
boolean

Логическое значение, определяющее, нужно ли возвращать поток.

since
integer <int64>

Возвращать только журналы начиная с указанной временной метки.

tail
string

Возвращать только последние n строк журнала (целое число) или все ('all').

timestamps
boolean

Добавлять временную метку к каждой строке журнала.

until
integer <int64>

Возвращать только журналы до указанной временной метки.

Ответы

Перезапустить все процессы для типа и канонического ключа ресурса.

path Parameters
key
required
string
Пример: global.deploy-example

Канонический ключ ресурса в формате {namespace}.{name}; задания используют ключ без пространства имён.

kind
required
string
Пример: cargo

Тип процесса.

Ответы

Запустить все процессы для типа и канонического ключа ресурса.

path Parameters
key
required
string
Пример: global.deploy-example

Канонический ключ ресурса в формате {namespace}.{name}; задания используют ключ без пространства имён.

kind
required
string
Пример: cargo

Тип процесса.

Ответы

Получить статистику всех процессов для типа и канонического ключа ресурса.

path Parameters
key
required
string
Пример: global.deploy-example

Канонический ключ ресурса в формате {namespace}.{name}; задания используют ключ без пространства имён.

kind
required
string
Пример: cargo

Тип процесса.

query Parameters
one_shot
boolean

Вернуть статистику только один раз.

stream
boolean

Вернуть поток статистики.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Остановить все процессы для типа и канонического ключа ресурса.

path Parameters
key
required
string
Пример: global.deploy-example

Канонический ключ ресурса в формате {namespace}.{name}; задания используют ключ без пространства имён.

kind
required
string
Пример: cargo

Тип процесса.

Ответы

Дождаться перехода всех процессов в определённое состояние.

path Parameters
key
required
string

Канонический ключ ресурса в формате {namespace}.{name}; задания используют ключ без пространства имён.

kind
required
string
Пример: cargo

Тип экземпляра процесса, например cargo, job или vm.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Подключиться к процессу через WebSocket.

path Parameters
name
required
string

Имя или идентификатор контейнера.

Ответы

Создать экземпляр exec для определённого имени или идентификатора процесса.

path Parameters
name
required
string

Имя или идентификатор контейнера.

Request Body schema: application/json
required
AttachStderr
boolean or null

Подключиться к стандартному потоку ошибок.

AttachStdin
boolean or null

Подключиться к стандартному вводу.

AttachStdout
boolean or null

Подключиться к стандартному выводу.

Cmd
Массив strings or null

Команда и аргументы для выполнения.

DetachKeys
string or null

Последовательность клавиш отключения, совместимая с Docker.

Env
Массив strings or null

Переменные окружения в формате NAME=value.

Privileged
boolean or null

Выполнить команду с расширенными привилегиями.

Tty
boolean or null

Выделить псевдо-TTY.

User
string or null

Пользователь и необязательная группа для команды.

WorkingDir
string or null

Рабочий каталог внутри процесса.

Ответы

Примеры запросов

Content type
application/json
{
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "Tty": true,
  • "DetachKeys": "string",
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Privileged": true,
  • "User": "string",
  • "WorkingDir": "string"
}

Примеры ответов

Content type
application/json
{
  • "Id": "string"
}

Получить подробные сведения о процессе по имени.

path Parameters
name
required
string

Имя процесса.

Ответы

Примеры ответов

Content type
application/json
{
  • "Key": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "Kind": "vm",
  • "NodeName": "string",
  • "KindKey": "string",
  • "IpAddress": "string",
  • "Data": {
    }
}

Отправить сигнал одному процессу по имени или идентификатору.

path Parameters
name
required
string
Пример: system.nstore.c

Имя или идентификатор контейнера.

Request Body schema: application/json
required
signal
required
string

Сигнал процессу; по умолчанию SIGKILL.

Ответы

Примеры запросов

Content type
application/json
{
  • "signal": "string"
}

Получить журналы одного экземпляра процесса по имени или идентификатору.

path Parameters
name
required
string
Пример: deploy-example

Имя процесса.

query Parameters
follow
boolean

Логическое значение, определяющее, нужно ли возвращать поток.

since
integer <int64>

Возвращать только журналы начиная с указанной временной метки.

tail
string

Возвращать только последние n строк журнала (целое число) или все ('all').

timestamps
boolean

Добавлять временную метку к каждой строке журнала.

until
integer <int64>

Возвращать только журналы до указанной временной метки.

Ответы

Запустить один процесс по имени или идентификатору.

path Parameters
pk
required
string
Пример: 1234567890

Первичный ключ процесса.

Ответы

ResourceKinds

Получить список типов ресурсов.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать тип ресурса.

Request Body schema: application/json
required
required
object (ResourceKindSpec)

Спецификация типа ресурса.

object

JSONSchema ресурса данного типа и версии.

Url
string or null

Служба, вызываемая при создании, обновлении или удалении ресурса данного типа и версии.

object

Метаданные типа ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя типа ресурса.

Version
required
string

Версия типа ресурса.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

Примеры ответов

Content type
application/json
{
  • "Name": "string",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null,
  • "Data": {
    }
}

Подсчитать типы ресурсов.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Удалить тип ресурса.

path Parameters
domain
required
string

Домен типа ресурса.

name
required
string

Имя типа ресурса.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Получить подробные сведения о типе ресурса.

path Parameters
domain
required
string

Домен типа ресурса.

name
required
string

Имя типа ресурса.

Ответы

Примеры ответов

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Versions": [
    ]
}

Получить подробные сведения о версии типа ресурса.

path Parameters
domain
required
string

Домен типа ресурса.

name
required
string

Имя типа ресурса.

version
required
string

Версия типа ресурса.

Ответы

Примеры ответов

Content type
application/json
{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "KindKey": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

Resources

Конечные точки управления ресурсами.

Получить список ресурсов с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "kind": { "eq": "ncproxy.io/rule" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать ресурс.

Request Body schema: application/json
required
required
object

Данные ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Kind
required
string

Тип ресурса.

object

Метаданные ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя ресурса.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Kind": "string",
  • "Data": {
    },
  • "Metadata": {
    }
}

Примеры ответов

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Подсчитать ресурсы.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Создать спецификацию ресурса и добавить запись истории.

path Parameters
name
required
string

Имя ресурса.

Request Body schema: application/json
required
required
object

Спецификация ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

object

Метаданные ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Ответы

Примеры запросов

Content type
application/json
{
  • "Data": {
    },
  • "Metadata": {
    }
}

Примеры ответов

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Удалить ресурс по имени.

path Parameters
name
required
string

Имя удаляемого ресурса.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Получить историю ресурса.

path Parameters
name
required
string

Имя ресурса для получения истории.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Откатить ресурс к определённой записи истории.

path Parameters
id
required
string

Идентификатор записи истории для отката ресурса.

name
required
string

Имя ресурса для отката.

Ответы

Примеры ответов

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Получить подробные сведения о ресурсе.

path Parameters
name
required
string

Имя ресурса для просмотра.

Ответы

Примеры ответов

Content type
application/json
{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

Secrets

Конечные точки управления секретами.

Получить список секретов с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "kind": { "eq": "Env" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать секрет.

Request Body schema: application/json
required
required
object

Данные секрета.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Immutable
boolean

Секрет нельзя обновить.

Kind
required
string

Тип секрета.

object

Метаданные ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя секрета.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

Примеры ответов

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

Подсчитать секреты.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Общий фильтр.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Удалить секрет.

path Parameters
key
required
string

Ключ секрета.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Обновить секрет.

path Parameters
key
required
string

Ключ секрета.

Request Body schema: application/json
required
required
object

Данные секрета в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

object

Метаданные секрета, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Ответы

Примеры запросов

Content type
application/json
{
  • "Metadata": {
    },
  • "Data": {
    }
}

Примеры ответов

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

Получить подробные сведения о секрете.

path Parameters
key
required
string

Ключ секрета.

Ответы

Примеры ответов

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

System

Общие конечные точки системы.

Проверить доступность сервера с помощью ping.

Ответы

Получить системные сведения о хосте или узле.

Ответы

Примеры ответов

Content type
application/json
{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": { },
  • "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": { },
  • "CgroupVersion": { },
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": { },
  • "GenericResources": { },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": { },
  • "LiveRestoreEnabled": true,
  • "Isolation": { },
  • "InitBinary": "string",
  • "ContainerdCommit": { },
  • "RuncCommit": { },
  • "InitCommit": { },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ],
  • "HostGateway": "string",
  • "Network": {
    },
  • "Config": {
    }
}

Получить сведения о версии.

Ответы

Примеры ответов

Content type
application/json
{
  • "Arch": "string",
  • "Channel": "string",
  • "Version": "string",
  • "CommitId": "string"
}

Vms

Конечные точки управления виртуальными машинами.

Получить список виртуальных машин с необязательным фильтром.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "my-vm" } } } }

Общий фильтр.

namespace
string

Необязательный фильтр пространства имён; при отсутствии или пустом значении возвращаются все пространства имён.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Создать виртуальную машину.

query Parameters
namespace
string

Пространство имён виртуальной машины.

Request Body schema: application/json
required
null or VmHostConfig (object)
One of
null
Hostname
string or null

Имя хоста VM; по умолчанию создаётся из имени.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
MacAddress
string or null

MAC-адрес VM; по умолчанию создаётся автоматически.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию: cloud.

SshKey
string or null

Открытый ключ SSH пользователя по умолчанию; рекомендуется.

User
string or null

Пользователь VM по умолчанию: cloud.

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "InitContainer": { },
  • "Image": "string",
  • "MacAddress": "string",
  • "Labels": {
    },
  • "HostConfig": { }
}

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Подсчитать образы VM.

query Parameters
filter
string
Пример: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Общий фильтр.

namespace
string

Необязательный фильтр пространства имён; при отсутствии или пустом значении возвращаются все пространства имён.

Ответы

Примеры ответов

Content type
application/json
{
  • "Count": 0
}

Удалить виртуальную машину по каноническому ключу.

path Parameters
key
required
string

Канонический ключ VM в формате {namespace}.{name}.

Ответы

Примеры ответов

Content type
application/json
{
  • "msg": "string"
}

Изменить конфигурацию виртуальной машины, объединив текущую конфигурацию с новой, и добавить запись истории.

path Parameters
key
required
string

Канонический ключ VM в формате {namespace}.{name}.

Request Body schema: application/json
required
null or VmHostConfig (object)
One of
null
Hostname
string or null

Имя хоста VM.

null or Config (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
string or null

Имя VM.

Password
string or null

Пароль VM по умолчанию (cloud).

SshKey
string or null

Ключ SSH пользователя по умолчанию.

User
string or null

Пользователь VM по умолчанию (cloud).

Ответы

Примеры запросов

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "InitContainer": { },
  • "Labels": {
    },
  • "HostConfig": { }
}

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

Получить список историй виртуальных машин.

path Parameters
key
required
string

Канонический ключ VM в формате {namespace}.{name}.

Ответы

Примеры ответов

Content type
application/json
[
  • {
    }
]

Получить подробные сведения о виртуальной машине.

path Parameters
key
required
string

Канонический ключ VM в формате {namespace}.{name}.

Ответы

Примеры ответов

Content type
application/json
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

Схемы

Address

Addr
string or null

IP-адрес.

PrefixLen
integer or null <int64>

Длина маски IP-адреса.

{
  • "Addr": "string",
  • "PrefixLen": 0
}

Any

One of
string

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Example
{
  • "property1": "string",
  • "property2": "string"
}

ApiError

msg
required
string
{
  • "msg": "string"
}

BinaryInfo

Arch
required
string

Arch — архитектура текущего двоичного файла.

Channel
required
string

Channel — канал текущего двоичного файла.

CommitId
required
string

CommitID — идентификатор коммита текущего двоичного файла.

Version
required
string

Version — версия текущего двоичного файла.

{
  • "Arch": "string",
  • "Channel": "string",
  • "Version": "string",
  • "CommitId": "string"
}

BlkioStats

Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Массив objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
{
  • "io_service_bytes_recursive": [
    ],
  • "io_serviced_recursive": [
    ],
  • "io_queue_recursive": [
    ],
  • "io_service_time_recursive": [
    ],
  • "io_wait_time_recursive": [
    ],
  • "io_merged_recursive": [
    ],
  • "io_time_recursive": [
    ],
  • "sectors_recursive": [
    ]
}

BlkioStatsEntry

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
}

CPUStats

required
object (CPUUsage)

Статистика использования CPU контейнером.

percpu_usage
Массив 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
online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

Статистика ограничения CPU.

periods
required
integer <int64> >= 0
throttled_periods
required
integer <int64> >= 0
throttled_time
required
integer <int64> >= 0
{
  • "cpu_usage": {
    },
  • "system_cpu_usage": 0,
  • "online_cpus": 0,
  • "throttling_data": {
    }
}

CPUUsage

percpu_usage
Массив 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": [
    ],
  • "usage_in_usermode": 0,
  • "total_usage": 0,
  • "usage_in_kernelmode": 0
}

Cargo

CreatedAt
required
string <date-time>

Время создания Cargo.

NamespaceName
required
string

Имя пространства имён.

required
object (CargoSpecRevision)

Спецификация Cargo.

CargoKey
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

CreatedAt
required
string <date-time>

Дата создания спецификации Cargo.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления.

Key
required
string <uuid>

Уникальный идентификатор спецификации Cargo.

object

Метаданные Cargo, заданные пользователем.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Version
required
string

Версия спецификации.

required
object (ObjPsStatus)

Состояние Cargo.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

CargoInspect

CreatedAt
required
string <date-time>

Время создания Cargo.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

required
Массив objects (Process)

Список экземпляров.

Array
CreatedAt
required
string <date-time>

Дата создания.

required
object (ContainerInspectResponse)

Данные процесса: ContainerInspect.

IpAddress
string or null

Фактический IP-адрес, полученный из последнего наблюдаемого состояния процесса.

Key
required
string

Ключ процесса.

Kind
required
string (ProcessKind)
Допустимые значения: "vm" "job" "cargo"

Тип процесса (Job, Vm, Cargo).

KindKey
required
string

Канонический ключ ресурса для Cargo и VM; задания используют своё имя.

Name
required
string

Имя процесса.

NodeName
required
string

Имя узла, на котором работает контейнер.

UpdatedAt
required
string <date-time>

Время последнего обновления экземпляра.

InstanceTotal
required
integer >= 0

Число экземпляров.

NamespaceName
required
string

Имя пространства имён.

required
object (CargoSpecRevision)

Спецификация Cargo.

CargoKey
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

CreatedAt
required
string <date-time>

Дата создания спецификации Cargo.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления.

Key
required
string <uuid>

Уникальный идентификатор спецификации Cargo.

object

Метаданные Cargo, заданные пользователем.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Version
required
string

Версия спецификации.

required
object (ObjPsStatus)

Состояние Cargo.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

CargoNetworkMode

string (CargoNetworkMode)

Сетевой режим Docker, используемый Cargo.

Помимо встроенных режимов Docker принимает любое непустое имя сети. Nanocl резервирует container:<id>, поскольку пользователи не должны напрямую присоединяться к сетевому пространству имён, принадлежащему контейнеру.

"string"

CargoPlacementSelectorSpec

Cargoes
Массив strings or null

Выбирать по Cargo, работающим на узлах.

Массив objects or null (NodeConstraint)

Необязательные расширенные ограничения в формате ключ/оператор/значение.

Array
Key
required
string

Ключ ограничения, например "region", "label" или "group".

Operator
required
string (ConstraintOp)
Допустимые значения: "Eq" "Ne"

Оператор ограничения (Eq/Ne).

Value
required
string

Значение ограничения.

Groups
Массив strings or null

Выбирать по группам.

Labels
Массив strings or null

Выбирать по меткам.

Regions
Массив strings or null

Выбирать по регионам.

Vms
Массив strings or null

Выбирать по VM, работающим на узлах.

{
  • "Labels": [
    ],
  • "Regions": [
    ],
  • "Groups": [
    ],
  • "Cargoes": [
    ],
  • "Vms": [
    ],
  • "Constraints": [
    ]
}

CargoPlacementSpec

null or CargoPlacementSelectorSpec (object)
One of
null
Regions
Массив strings or null

Регионы для развёртывания Cargo.

null or CargoPlacementSelectorSpec (object)
One of
null
null or (CargoPlacementStrategy (CargoPlacementStrategy (string) or CargoPlacementStrategy (string) or CargoPlacementStrategy (string) or CargoPlacementStrategy (object)))
One of
null
{
  • "Strategy": { },
  • "Regions": [
    ],
  • "Require": { },
  • "Prefer": { }
}

CargoPlacementStrategy

One of
string
Значение: "Distinct"

Перечисление, задающее стратегию размещения Cargo на узлах.

{
  • "UserDefined": "string"
}

CargoReplicaTask

Key
required
string <uuid>

Сохранённая устойчивая идентичность реплики Cargo.

Ordinal
required
integer <int32>

Устойчивый порядковый номер реплики, уникальный в пределах Cargo.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "Ordinal": 0
}

CargoResourceRequirementSpec

CpuCores
integer or null >= 0

Требуемое число ядер CPU.

CpuUtilizationCap
number or null <float>

Максимально допустимое среднее использование CPU на целевом узле (0.0 - 1.0).

CpuWeight
number or null <float>

Необязательный вес CPU при сбалансированном размещении (0.0 - 1.0).

MemoryBytes
integer or null >= 0

Требуемая память в байтах.

MemoryUtilizationCap
number or null <float>

Максимально допустимое среднее использование памяти на целевом узле (0.0 - 1.0).

MemoryWeight
number or null <float>

Необязательный вес памяти при сбалансированном размещении (0.0 - 1.0).

StorageBytes
integer or null >= 0

Требуемое хранилище в байтах.

{
  • "CpuCores": 0,
  • "CpuUtilizationCap": 0,
  • "MemoryBytes": 0,
  • "MemoryUtilizationCap": 0,
  • "CpuWeight": 0,
  • "MemoryWeight": 0,
  • "StorageBytes": 0
}

CargoSpec

required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления перед контейнерами приложения.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

object

Метаданные Cargo, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
One of
null
null or CargoPlacementSpec (object)
One of
null
null or HashMap (object)
One of
null
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Replicas": 1,
  • "NetworkMode": { },
  • "PortBindings": { },
  • "Hostname": "string",
  • "Dns": [
    ],
  • "Secrets": [
    ],
  • "Placement": { },
  • "ResourceRequirement": { },
  • "InitContainers": [
    ],
  • "Containers": [
    ]
}

CargoSpecPatch

Массив objects or null (ContainerSpec)

Новое объявление контейнеров приложения.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

Dns
Массив strings or null

Новый набор DNS-серверов для владельца сети Cargo.

Hostname
string or null

Новое имя хоста Docker для владельца сети Cargo.

Массив objects or null (ContainerSpec)

Новое объявление упорядоченных контейнеров инициализации.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

object

Новые метаданные Cargo, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
string or null

Новое имя Cargo.

null or CargoNetworkMode (string)
One of
null
null or CargoPlacementSpec (object)
One of
null
null or HashMap (object)
One of
null
Replicas
integer or null >= 1

Новое число реплик.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Массив strings or null

Новый набор общих секретов на уровне Cargo.

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Replicas": 1,
  • "NetworkMode": { },
  • "PortBindings": { },
  • "Hostname": "string",
  • "Dns": [
    ],
  • "Secrets": [
    ],
  • "Placement": { },
  • "ResourceRequirement": { },
  • "InitContainers": [
    ],
  • "Containers": [
    ]
}

CargoSpecRevision

CargoKey
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

CreatedAt
required
string <date-time>

Дата создания спецификации Cargo.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or ContainerSpecHealthConfig (object)
null or ContainerSpecHostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

Key
required
string <uuid>

Уникальный идентификатор спецификации Cargo.

object

Метаданные Cargo, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
One of
null
null or CargoPlacementSpec (object)
One of
null
null or HashMap (object)
One of
null
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Version
required
string

Версия спецификации.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CargoKey": "string",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "Metadata": {
    },
  • "Replicas": 1,
  • "NetworkMode": { },
  • "PortBindings": { },
  • "Hostname": "string",
  • "Dns": [
    ],
  • "Secrets": [
    ],
  • "Placement": { },
  • "ResourceRequirement": { },
  • "InitContainers": [
    ],
  • "Containers": [
    ]
}

CargoSummary

CreatedAt
required
string <date-time>

Время создания Cargo.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

InstanceTotal
required
integer >= 0

Число экземпляров.

NamespaceName
required
string

Имя пространства имён.

required
object (CargoSpecRevision)

Спецификация Cargo.

CargoKey
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

CreatedAt
required
string <date-time>

Дата создания спецификации Cargo.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления.

Key
required
string <uuid>

Уникальный идентификатор спецификации Cargo.

object

Метаданные Cargo, заданные пользователем.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Version
required
string

Версия спецификации.

required
object (ObjPsStatus)

Состояние Cargo.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "Status": {
    },
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Spec": {
    }
}

ClusterInfo

null or String (string)
One of
null
DataPathPort
integer or null <int32> >= 0

DataPathPort задаёт номер порта для передачи данных. Допустимый диапазон — от 1024 до 49151. Если порт не задан или равен 0, используется порт по умолчанию (4789).

DefaultAddrPool
Массив strings or null

Default Address Pool задаёт пулы подсетей по умолчанию для сетей глобальной области.

ID
string or null

Идентификатор swarm.

RootRotationInProgress
boolean or null

Показывает, выполняется ли сейчас ротация корневого центра сертификации swarm.

null or SwarmSpec (object)
One of
null
SubnetSize
integer or null <int32> >= 0

SubnetSize задаёт размер подсетей, создаваемых из пула подсетей по умолчанию.

null or TlsInfo (object)
One of
null
null or String (string)
One of
null
null or ObjectVersion (object)
One of
null
{
  • "ID": "string",
  • "Version": { },
  • "CreatedAt": { },
  • "UpdatedAt": { },
  • "Spec": { },
  • "TLSInfo": { },
  • "RootRotationInProgress": true,
  • "DataPathPort": 0,
  • "DefaultAddrPool": [
    ],
  • "SubnetSize": 0
}

Commit

Expected
string or null

Идентификатор коммита внешнего инструмента, ожидаемый dockerd и заданный при сборке.

ID
string or null

Фактический идентификатор коммита внешнего инструмента.

{
  • "ID": "string",
  • "Expected": "string"
}

Config

ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

additional property
object
null or HealthConfig (object)
One of
null
null or HostConfig (object)
One of
null
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
MacAddress
string or null

MAC-адрес контейнера.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or NetworkingConfig_String (object)
One of
null
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

additional property
object
WorkingDir
string or null

Рабочий каталог для выполнения команд.

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": { },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ],
  • "HostConfig": { },
  • "NetworkingConfig": { }
}

ConstraintOp

string (ConstraintOp)
Допустимые значения: "Eq" "Ne"

Общий оператор ограничений для выбора узлов. Позволяет задавать более сложные условия, чем простые селекторы.

"Eq"

ContainerConfig

ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

additional property
object
null or HealthConfig (object)
One of
null
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя или ссылка на образ для создания контейнера либо образ, использованный при его создании.

object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
MacAddress
string or null

MAC-адрес контейнера. Поле устарело начиная с API v1.44; используйте EndpointSettings.MacAddress.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

additional property
object
WorkingDir
string or null

Рабочий каталог для выполнения команд.

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": { },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ]
}

ContainerInspectResponse

AppArmorProfile
string or null
Args
Массив strings or null

Аргументы выполняемой команды.

null or ContainerConfig (object)
One of
null
Created
string or null

Время создания контейнера.

Driver
string or null
ExecIDs
Массив strings or null

Идентификаторы экземпляров exec, работающих в контейнере.

null or GraphDriverData (object)
One of
null
null or HostConfig (object)
One of
null
HostnamePath
string or null
HostsPath
string or null
Id
string or null

Идентификатор контейнера.

Image
string or null

Идентификатор образа контейнера.

LogPath
string or null
MountLabel
string or null
Массив objects or null (MountPoint)
Array
Destination
string or null

Destination — путь относительно корня контейнера (/), по которому Source подключается внутри контейнера.

Driver
string or null

Driver — драйвер томов, используемый для создания тома, если это том.

Mode
string or null

Mode — разделённый запятыми список параметров, заданных пользователем при создании подключения пути хоста или тома. Значение по умолчанию зависит от платформы: \"z\" в Linux, пустое в Windows.

Name
string or null

Name — имя, ссылающееся на данные, определяемые Source, например имя тома.

Propagation
string or null

Propagation описывает распространение монтирований с хоста в точку монтирования и обратно. Подробности приведены в документации ядра Linux. Поле не используется в Windows.

RW
boolean or null

Показывает, доступно ли подключение для записи, то есть для чтения и записи.

Source
string or null

Источник монтирования. Для томов содержит место хранения тома внутри /var/lib/docker/volumes/. Для привязанных путей и npipe содержит исходную часть монтирования на хосте. Для точек tmpfs поле пустое.

null or MountPointTypeEnum (string)
Name
string or null
null or NetworkSettings (object)
One of
null
Path
string or null

Путь выполняемой команды.

Platform
string or null
ProcessLabel
string or null
ResolvConfPath
string or null
RestartCount
integer or null <int64>
SizeRootFs
integer or null <int64>

Общий размер всех файлов контейнера.

SizeRw
integer or null <int64>

Размер файлов, созданных или изменённых контейнером.

null or ContainerState (object)
One of
null
{
  • "Id": "string",
  • "Created": "string",
  • "Path": "string",
  • "Args": [
    ],
  • "State": { },
  • "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": [
    ],
  • "HostConfig": { },
  • "GraphDriver": { },
  • "SizeRw": 0,
  • "SizeRootFs": 0,
  • "Mounts": [
    ],
  • "Config": { },
  • "NetworkSettings": { }
}

ContainerSpec

ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

Essential
boolean
По умолчанию: true

Показывает, делает ли сбой этого контейнера реплику Cargo неработоспособной.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

additional property
object
null or ContainerSpecHealthConfig (object)
One of
null
null or ContainerSpecHostConfig (object)
One of
null
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

ImagePullPolicy
string
По умолчанию: "IfNotPresent"
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образа этого контейнера.

null or string

Секрет, используемый для загрузки образа контейнера.

One of
null

Секрет, используемый для загрузки образа контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
MacAddress
string or null

MAC-адрес контейнера.

Name
required
string

Имя, уникальное в пределах объявления Cargo.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or ContainerSpecNetworkingConfig_String (object)
One of
null
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Secrets
Массив strings
По умолчанию: []

Секреты, внедряемые только в этот контейнер.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

additional property
object
WorkingDir
string or null

Рабочий каталог для выполнения команд.

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": { },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ],
  • "HostConfig": { },
  • "NetworkingConfig": { },
  • "Name": "string",
  • "Essential": true,
  • "Secrets": [ ],
  • "ImagePullSecret": { },
  • "ImagePullPolicy": "Never"
}

ContainerSpecDeviceMapping

CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
{
  • "PathOnHost": "string",
  • "PathInContainer": "string",
  • "CgroupPermissions": "string"
}

ContainerSpecDeviceRequest

Capabilities
Массив strings or null[ items ]

Список возможностей: объединение по OR списков, внутри которых возможности объединены по AND.

Count
integer or null <int64>
DeviceIDs
Массив strings or null
Driver
string or null
object or null

Параметры драйвера в виде пар ключ/значение. Они передаются непосредственно драйверу.

property name*
additional property
string
{
  • "Driver": "string",
  • "Count": 0,
  • "DeviceIDs": [
    ],
  • "Capabilities": [
    ],
  • "Options": {
    }
}

ContainerSpecEndpointIpamConfig

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
Массив strings or null
{
  • "IPv4Address": "string",
  • "IPv6Address": "string",
  • "LinkLocalIPs": [
    ]
}

ContainerSpecEndpointSettings

Aliases
Массив strings or null
DNSNames
Массив strings or null

Список всех DNS-имён конечной точки в определённой сети. Он основан на имени контейнера, сетевых псевдонимах, коротком идентификаторе контейнера и имени хоста. Эти имена не являются полностью квалифицированными, но могут содержать несколько точек. Чтобы получить полное DNS-имя, добавьте .<network-name>. Например, если контейнер называется my.ctr, а сеть — testnet, то DNSNames содержит my.ctr, а FQDN равен my.ctr.testnet.

object or null

DriverOpts сопоставляет параметры драйвера и их значения. Эти параметры относятся к конкретному драйверу и передаются ему непосредственно.

property name*
additional property
string
EndpointID
string or null

Уникальный идентификатор конечной точки службы в Sandbox.

Gateway
string or null

Адрес шлюза этой сети.

GlobalIPv6Address
string or null

Глобальный адрес IPv6.

GlobalIPv6PrefixLen
integer or null <int64>

Длина маски глобального адреса IPv6.

IPAddress
string or null

Адрес IPv4.

null or ContainerSpecEndpointIpamConfig (object)
One of
null
IPPrefixLen
integer or null <int64>

Длина маски адреса IPv4.

IPv6Gateway
string or null

Адрес шлюза IPv6.

Links
Массив strings or null
MacAddress
string or null

MAC-адрес конечной точки в этой сети. Драйвер сети может игнорировать параметр.

NetworkID
string or null

Уникальный идентификатор сети.

{
  • "IPAMConfig": { },
  • "Links": [
    ],
  • "MacAddress": "string",
  • "Aliases": [
    ],
  • "NetworkID": "string",
  • "EndpointID": "string",
  • "Gateway": "string",
  • "IPAddress": "string",
  • "IPPrefixLen": 0,
  • "IPv6Gateway": "string",
  • "GlobalIPv6Address": "string",
  • "GlobalIPv6PrefixLen": 0,
  • "DriverOpts": {
    },
  • "DNSNames": [
    ]
}

ContainerSpecHashMap

additional property
null or Массив objects
One of
null
{
  • "property1": { },
  • "property2": { }
}

ContainerSpecHealthConfig

Interval
integer or null <int64>

Интервал между проверками в наносекундах. Должен быть равен 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

Retries
integer or null <int64>

Число последовательных неудачных проверок, после которых контейнер считается неработоспособным. 0 означает наследование значения.

StartInterval
integer or null <int64>

Интервал между проверками в начальный период, в наносекундах. Должен быть равен 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

StartPeriod
integer or null <int64>

Начальный период инициализации контейнера перед отсчётом повторных проверок работоспособности, в наносекундах. Должен быть равен 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

Test
Массив strings or null

Выполняемая проверка. Возможные значения: - []: наследовать проверку образа или родительского образа - [\"NONE\"]: отключить проверку работоспособности - [\"CMD\", args...]: выполнить аргументы непосредственно - [\"CMD-SHELL\", command]: выполнить команду в оболочке системы по умолчанию.

Timeout
integer or null <int64>

Время ожидания до признания проверки зависшей. Должно быть равно 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

{
  • "Test": [
    ],
  • "Interval": 0,
  • "Timeout": 0,
  • "Retries": 0,
  • "StartPeriod": 0,
  • "StartInterval": 0
}

ContainerSpecHostConfig

object or null

Произвольные неидентифицирующие метаданные контейнера, передаваемые среде выполнения при его запуске.

property name*
additional property
string
AutoRemove
boolean or null

Автоматически удалять контейнер после завершения его процесса. Не действует, если задан RestartPolicy.

Binds
Массив strings or null

Список подключений томов для контейнера. Каждое подключение задаётся строкой одного из следующих форматов: - host-src:container-dest[:options] — подключение пути хоста в контейнер. host-src и container-dest должны быть абсолютными путями. - volume-name:container-dest[:options] — подключение в контейнер тома, управляемого драйвером томов. container-dest должен быть абсолютным путём. options — необязательный список следующих параметров, разделённых запятыми: - nocopy отключает автоматическое копирование данных из пути контейнера в том. Флаг nocopy применяется только к именованным томам. - [ro|rw] подключает том только для чтения или для чтения и записи соответственно. Если параметр отсутствует или равен rw, том подключается для чтения и записи. - [z|Z] применяет метки SELinux, разрешающие или запрещающие нескольким контейнерам читать и записывать один том. - z: содержимому назначается общая метка. Она означает, что несколько контейнеров могут совместно читать и записывать содержимое тома. - Z: назначается частная, не разделяемая метка. Она означает, что частный том может использовать только текущий контейнер. Системы вроде SELinux требуют соответствующих меток для содержимого томов, подключаемых в контейнер. Без метки система безопасности может запретить процессам контейнера использовать содержимое. По умолчанию метки, заданные операционной системой хоста, не изменяются. - [[r]shared|[r]slave|[r]private] задаёт распространение монтирования. Это относится только к привязанным путям хоста, а не к внутренним или именованным томам. Для распространения исходная точка монтирования, где исходный каталог подключён в ОС хоста, должна иметь правильные свойства распространения. Для общих томов исходная точка должна быть shared. Для подчинённых томов она должна быть shared или slave.

Массив objects or null (ContainerSpecThrottleDevice)

Ограничить скорость чтения устройства в байтах в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

Массив objects or null (ContainerSpecThrottleDevice)

Ограничить скорость чтения устройства в операциях ввода-вывода в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

Массив objects or null (ContainerSpecThrottleDevice)

Ограничить скорость записи на устройство в байтах в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

Массив objects or null (ContainerSpecThrottleDevice)

Ограничить скорость записи на устройство в операциях ввода-вывода в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

BlkioWeight
integer or null <int32> >= 0

Относительный вес блочного ввода-вывода.

Массив objects or null (ContainerSpecResourcesBlkioWeightDevice)

Вес блочного ввода-вывода, относительный для устройства, в формате: [{\"Path\": \"device_path\", \"Weight\": weight}]

Array
Path
string or null
Weight
integer or null >= 0
CapAdd
Массив strings or null

Список возможностей ядра, добавляемых контейнеру. Несовместим с параметром 'Capabilities'.

CapDrop
Массив strings or null

Список возможностей ядра, удаляемых у контейнера. Несовместим с параметром 'Capabilities'.

Cgroup
string or null

Cgroup для контейнера.

null or ContainerSpecHostConfigCgroupnsModeEnum (string)
One of
null
CgroupParent
string or null

Путь cgroups, в котором создаётся cgroup контейнера. Если путь не абсолютный, он считается относительным к пути cgroups процесса init. Если cgroups отсутствуют, они создаются.

ConsoleSize
Массив integers or null <int32> [ items <int32 > ]

Исходный размер консоли в виде массива [height, width].

ContainerIDFile
string or null

Путь к файлу, в который записывается идентификатор контейнера.

CpuCount
integer or null <int64>

Число доступных CPU; только для Windows. В контейнерах Windows Server ограничения ресурсов процессора взаимоисключающие. Приоритет: сначала CPUCount, затем CPUShares, последним CPUPercent.

CpuPercent
integer or null <int64>

Доступный процент имеющихся CPU; только для Windows. В контейнерах Windows Server ограничения ресурсов процессора взаимоисключающие. Приоритет: сначала CPUCount, затем CPUShares, последним CPUPercent.

CpuPeriod
integer or null <int64>

Длительность периода CPU в микросекундах.

CpuQuota
integer or null <int64>

Микросекунды процессорного времени, доступные контейнеру за один период CPU.

CpuRealtimePeriod
integer or null <int64>

Длительность периода CPU реального времени в микросекундах. Значение 0 означает, что время задачам реального времени не выделяется.

CpuRealtimeRuntime
integer or null <int64>

Длительность выполнения CPU реального времени в микросекундах. Значение 0 означает, что время задачам реального времени не выделяется.

CpusetCpus
string or null

CPU, на которых разрешено выполнение, например 0-3 или 0,1.

CpusetMems
string or null

Узлы памяти (MEMs), на которых разрешено выполнение (0-3, 0,1). Действует только в системах NUMA.

CpuShares
integer or null <int64>

Целое число, представляющее относительный вес CPU контейнера по сравнению с другими контейнерами.

DeviceCgroupRules
Массив strings or null

Список правил cgroup для контейнера.

Массив objects or null (ContainerSpecDeviceRequest)

Список запросов устройств, передаваемых драйверам устройств.

Array
Capabilities
Массив strings or null[ items ]

Список возможностей: объединение по OR списков, внутри которых возможности объединены по AND.

Count
integer or null <int64>
DeviceIDs
Массив strings or null
Driver
string or null
object or null

Параметры драйвера в виде пар ключ/значение. Они передаются непосредственно драйверу.

Массив objects or null (ContainerSpecDeviceMapping)

Список устройств, добавляемых в контейнер.

Array
CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
Dns
Массив strings or null

Список DNS-серверов для контейнера.

DnsOptions
Массив strings or null

Список параметров DNS.

DnsSearch
Массив strings or null

Список доменов поиска DNS.

ExtraHosts
Массив strings or null

Список сопоставлений имён хостов и IP-адресов, добавляемых в файл /etc/hosts контейнера. Формат: [\"hostname:IP\"].

GroupAdd
Массив strings or null

Список дополнительных групп, от имени которых работает процесс контейнера.

Init
boolean or null

Запускать внутри контейнера процесс init, передающий сигналы и собирающий завершённые процессы. Пустое поле не включается в запрос; используется настройка демона по умолчанию.

IOMaximumBandwidth
integer or null <int64>

Максимальная скорость ввода-вывода системного диска контейнера в байтах в секунду; только для Windows.

IOMaximumIOps
integer or null <int64>

Максимальное число операций ввода-вывода в секунду для системного диска контейнера; только для Windows.

IpcMode
string or null

Режим общего использования IPC для контейнера. Возможные значения: - \"none\": собственное частное пространство имён IPC без подключения /dev/shm - \"private\": собственное частное пространство имён IPC - \"shareable\": собственное частное пространство имён IPC с возможностью совместного использования другими контейнерами - \"container:<name|id>\": присоединиться к разделяемому пространству имён IPC другого контейнера - \"host\": использовать пространство имён IPC хоста. Если значение не задано, используется значение по умолчанию демона: \"private\" или \"shareable\", в зависимости от его версии и конфигурации.

null or ContainerSpecHostConfigIsolationEnum (string)
One of
null
KernelMemoryTCP
integer or null <int64>

Жёсткое ограничение памяти TCP-буфера ядра в байтах. Параметр может игнорироваться в зависимости от среды выполнения OCI. Он больше не поддерживается средой по умолчанию (runc). Пустое поле не включается в ответ.

Links
Массив strings or null

Список связей контейнера в формате container_name:alias.

null or ContainerSpecHostConfigLogConfig (object)
One of
null
MaskedPaths
Массив strings or null

Список путей, скрываемых внутри контейнера; переопределяет набор путей по умолчанию.

Memory
integer or null <int64>

Ограничение памяти в байтах.

MemoryReservation
integer or null <int64>

Мягкое ограничение памяти в байтах.

MemorySwap
integer or null <int64>

Общее ограничение памяти, включая память и swap. Значение -1 разрешает неограниченный swap.

MemorySwappiness
integer or null <int64>

Настроить swappiness памяти контейнера. Допускается целое число от 0 до 100.

Массив objects or null (ContainerSpecMount)

Спецификация подключений, добавляемых в контейнер.

Array
null or ContainerSpecMountBindOptions (object)
Consistency
string or null

Требование согласованности монтирования: default, consistent, cached или delegated.

ReadOnly
boolean or null

Показывает, должно ли подключение быть доступно только для чтения.

Source
string or null

Источник монтирования, например имя тома или путь хоста.

Target
string or null

Путь в контейнере.

null or ContainerSpecMountTmpfsOptions (object)
null or ContainerSpecMountTypeEnum (string)
null or ContainerSpecMountVolumeOptions (object)
NanoCpus
integer or null <int64>

Квота CPU в единицах 10-9 процессора.

NetworkMode
string or null

Сетевой режим контейнера. Поддерживаемые стандартные значения: bridge, host, none и container:<name|id>. Любое другое значение считается именем пользовательской сети, к которой должен подключиться контейнер.

OomKillDisable
boolean or null

Отключить OOM killer для контейнера.

OomScoreAdj
integer or null <int64>

Целочисленная оценка контейнера для настройки приоритетов OOM killer.

PidMode
string or null

Задать режим пространства имён PID (процессов) для контейнера. Возможные значения: - \"container:<name|id>\": присоединиться к пространству имён PID другого контейнера - \"host\": использовать пространство имён PID хоста внутри контейнера.

PidsLimit
integer or null <int64>

Настроить ограничение PID контейнера. 0 или -1 означает отсутствие ограничения, null — не изменять.

null or ContainerSpecHashMap (object)
One of
null
Privileged
boolean or null

Предоставляет контейнеру полный доступ к хосту.

PublishAllPorts
boolean or null

Выделяет временный порт хоста для каждого открытого порта контейнера. Порты освобождаются при остановке контейнера и выделяются при запуске. При перезапуске выделенный порт может измениться. Порт выбирается из диапазона временных портов, зависящего от ядра. Например, в Linux диапазон задаётся в /proc/sys/net/ipv4/ip_local_port_range.

ReadonlyPaths
Массив strings or null

Список путей, доступных внутри контейнера только для чтения; переопределяет набор путей по умолчанию.

ReadonlyRootfs
boolean or null

Подключить корневую файловую систему контейнера только для чтения.

null or ContainerSpecRestartPolicy (object)
One of
null
Runtime
string or null

Среда выполнения для этого контейнера.

SecurityOpt
Массив strings or null

Список строк для настройки меток в системах MLS, например SELinux.

ShmSize
integer or null <int64>

Размер /dev/shm в байтах. Если не задан, система использует 64 МБ.

object or null

Параметры драйвера хранения контейнера в формате {\"size\": \"120G\"}.

property name*
additional property
string
object or null

Список параметров ядра (sysctls), задаваемых в контейнере. Например: {\"net.ipv4.ip_forward\": \"1\"}

property name*
additional property
string
object or null

Сопоставление каталогов контейнера, заменяемых подключениями tmpfs, и соответствующих параметров монтирования. Например: { \"/run\": \"rw,noexec,nosuid,size=65536k\" }

property name*
additional property
string
Массив objects or null (ContainerSpecResourcesUlimits)

Список ограничений ресурсов контейнера. Например: {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}

Array
Hard
integer or null <int64>

Жёсткое ограничение.

Name
string or null

Имя ulimit.

Soft
integer or null <int64>

Мягкое ограничение.

UsernsMode
string or null

Задаёт режим пространства имён пользователя контейнера, когда включено переназначение пространств имён пользователей.

UTSMode
string or null

Пространство имён UTS контейнера.

VolumeDriver
string or null

Драйвер, используемый контейнером для подключения томов.

VolumesFrom
Массив strings or null

Список томов, наследуемых от другого контейнера, в формате <container name>[:<ro|rw>].

{
  • "CpuShares": 0,
  • "Memory": 0,
  • "CgroupParent": "string",
  • "BlkioWeight": 0,
  • "BlkioWeightDevice": [
    ],
  • "BlkioDeviceReadBps": [
    ],
  • "BlkioDeviceWriteBps": [
    ],
  • "BlkioDeviceReadIOps": [
    ],
  • "BlkioDeviceWriteIOps": [
    ],
  • "CpuPeriod": 0,
  • "CpuQuota": 0,
  • "CpuRealtimePeriod": 0,
  • "CpuRealtimeRuntime": 0,
  • "CpusetCpus": "string",
  • "CpusetMems": "string",
  • "Devices": [
    ],
  • "DeviceCgroupRules": [
    ],
  • "DeviceRequests": [
    ],
  • "KernelMemoryTCP": 0,
  • "MemoryReservation": 0,
  • "MemorySwap": 0,
  • "MemorySwappiness": 0,
  • "NanoCpus": 0,
  • "OomKillDisable": true,
  • "Init": true,
  • "PidsLimit": 0,
  • "Ulimits": [
    ],
  • "CpuCount": 0,
  • "CpuPercent": 0,
  • "IOMaximumIOps": 0,
  • "IOMaximumBandwidth": 0,
  • "Binds": [
    ],
  • "ContainerIDFile": "string",
  • "LogConfig": { },
  • "NetworkMode": "string",
  • "PortBindings": { },
  • "RestartPolicy": { },
  • "AutoRemove": true,
  • "VolumeDriver": "string",
  • "VolumesFrom": [
    ],
  • "Mounts": [
    ],
  • "ConsoleSize": [
    ],
  • "Annotations": {
    },
  • "CapAdd": [
    ],
  • "CapDrop": [
    ],
  • "CgroupnsMode": { },
  • "Dns": [
    ],
  • "DnsOptions": [
    ],
  • "DnsSearch": [
    ],
  • "ExtraHosts": [
    ],
  • "GroupAdd": [
    ],
  • "IpcMode": "string",
  • "Cgroup": "string",
  • "Links": [
    ],
  • "OomScoreAdj": 0,
  • "PidMode": "string",
  • "Privileged": true,
  • "PublishAllPorts": true,
  • "ReadonlyRootfs": true,
  • "SecurityOpt": [
    ],
  • "StorageOpt": {
    },
  • "Tmpfs": {
    },
  • "UTSMode": "string",
  • "UsernsMode": "string",
  • "ShmSize": 0,
  • "Sysctls": {
    },
  • "Runtime": "string",
  • "Isolation": { },
  • "MaskedPaths": [
    ],
  • "ReadonlyPaths": [
    ]
}

ContainerSpecHostConfigCgroupnsModeEnum

string (ContainerSpecHostConfigCgroupnsModeEnum)
Допустимые значения: "EMPTY" "private" "host"
"EMPTY"

ContainerSpecHostConfigIsolationEnum

string (ContainerSpecHostConfigIsolationEnum)
Допустимые значения: "EMPTY" "default" "process" "hyperv"
"EMPTY"

ContainerSpecHostConfigLogConfig

object or null
property name*
additional property
string
Type
string or null
{
  • "Type": "string",
  • "Config": {
    }
}

ContainerSpecMount

null or ContainerSpecMountBindOptions (object)
One of
null
Consistency
string or null

Требование согласованности монтирования: default, consistent, cached или delegated.

ReadOnly
boolean or null

Показывает, должно ли подключение быть доступно только для чтения.

Source
string or null

Источник монтирования, например имя тома или путь хоста.

Target
string or null

Путь в контейнере.

null or ContainerSpecMountTmpfsOptions (object)
One of
null
null or ContainerSpecMountTypeEnum (string)
One of
null
null or ContainerSpecMountVolumeOptions (object)
One of
null
{
  • "Target": "string",
  • "Source": "string",
  • "Type": { },
  • "ReadOnly": true,
  • "Consistency": "string",
  • "BindOptions": { },
  • "VolumeOptions": { },
  • "TmpfsOptions": { }
}

ContainerSpecMountBindOptions

CreateMountpoint
boolean or null

Создать точку монтирования на хосте, если она отсутствует.

NonRecursive
boolean or null

Отключить рекурсивное привязанное монтирование.

null or ContainerSpecMountBindOptionsPropagationEnum (string)
One of
null
ReadOnlyForceRecursive
boolean or null

Выдать ошибку, если подключение нельзя сделать рекурсивно доступным только для чтения.

ReadOnlyNonRecursive
boolean or null

Сделать само подключение доступным только для чтения, не распространяя это рекурсивно, но сохранив рекурсивное монтирование, если одновременно NonRecursive не равно true. Добавлено в v1.44; ранее все подключения только для чтения по умолчанию были нерекурсивными. Для совместимости с прежним поведением значение по умолчанию для клиентов версий до v1.44 — true.

{
  • "Propagation": { },
  • "NonRecursive": true,
  • "CreateMountpoint": true,
  • "ReadOnlyNonRecursive": true,
  • "ReadOnlyForceRecursive": true
}

ContainerSpecMountBindOptionsPropagationEnum

string (ContainerSpecMountBindOptionsPropagationEnum)
Допустимые значения: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
"EMPTY"

ContainerSpecMountTmpfsOptions

Mode
integer or null <int64>

Режим прав доступа к tmpfs в виде целого числа.

SizeBytes
integer or null <int64>

Размер tmpfs в байтах.

{
  • "SizeBytes": 0,
  • "Mode": 0
}

ContainerSpecMountTypeEnum

string (ContainerSpecMountTypeEnum)
Допустимые значения: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

ContainerSpecMountVolumeOptions

null or ContainerSpecMountVolumeOptionsDriverConfig (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
NoCopy
boolean or null

Заполнить том данными из целевого пути.

Subpath
string or null

Исходный путь внутри тома. Должен быть относительным, без переходов в родительские каталоги.

{
  • "NoCopy": true,
  • "Labels": {
    },
  • "DriverConfig": { },
  • "Subpath": "string"
}

ContainerSpecMountVolumeOptionsDriverConfig

Name
string or null

Имя драйвера для создания тома.

object or null

Отображение ключ/значение параметров драйвера.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

ContainerSpecNetworkingConfig_String

required
object
additional property
object (ContainerSpecEndpointSettings)

Конфигурация конечной точки сети.

{
  • "EndpointsConfig": {
    }
}

ContainerSpecResourcesBlkioWeightDevice

Path
string or null
Weight
integer or null >= 0
{
  • "Path": "string",
  • "Weight": 0
}

ContainerSpecResourcesUlimits

Hard
integer or null <int64>

Жёсткое ограничение.

Name
string or null

Имя ulimit.

Soft
integer or null <int64>

Мягкое ограничение.

{
  • "Name": "string",
  • "Soft": 0,
  • "Hard": 0
}

ContainerSpecRestartPolicy

MaximumRetryCount
integer or null <int64>

Если используется on-failure, число повторных попыток до отказа.

null or ContainerSpecRestartPolicyNameEnum (string)
One of
null
{
  • "Name": { },
  • "MaximumRetryCount": 0
}

ContainerSpecRestartPolicyNameEnum

string (ContainerSpecRestartPolicyNameEnum)
Допустимые значения: "EMPTY" "no" "always" "unless-stopped" "on-failure"
"EMPTY"

ContainerSpecThrottleDevice

Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

{
  • "Path": "string",
  • "Rate": 0
}

ContainerState

Dead
boolean or null
Error
string or null
ExitCode
integer or null <int64>

Последний код завершения контейнера.

FinishedAt
string or null

Время последнего завершения контейнера.

null or Health (object)
One of
null
OOMKilled
boolean or null

Показывает, был ли процесс в контейнере завершён из-за нехватки памяти с момента последнего запуска контейнера.

Paused
boolean or null

Показывает, приостановлен ли контейнер.

Pid
integer or null <int64>

Идентификатор процесса контейнера.

Restarting
boolean or null

Показывает, перезапускается ли контейнер.

Running
boolean or null

Показывает, работает ли контейнер. Работающий контейнер может быть приостановлен. Логические значения Running и Paused не взаимоисключающие: при приостановке в Linux cgroup freezer приостанавливает все процессы контейнера. Для заморозки процесс должен работать. Поэтому приостановленные контейнеры одновременно имеют Running и Paused. Для определения состояния "running" используйте поле Status.

StartedAt
string or null

Время последнего запуска контейнера.

null or ContainerStateStatusEnum (string)
One of
null
{
  • "Status": { },
  • "Running": true,
  • "Paused": true,
  • "Restarting": true,
  • "OOMKilled": true,
  • "Dead": true,
  • "Pid": 0,
  • "ExitCode": 0,
  • "Error": "string",
  • "StartedAt": "string",
  • "FinishedAt": "string",
  • "Health": { }
}

ContainerStateStatusEnum

string (ContainerStateStatusEnum)
Допустимые значения: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead"
"EMPTY"

DaemonConfig

advertise_addr
required
string

Адрес, объявляемый другим узлам.

conf_dir
required
string

Каталог конфигурации.

docker_host
string

Используемый хост Docker.

gateway
required
string

Шлюз хоста, автоматически определяемый как шлюз хоста по умолчанию, если значение не задано.

gid
required
integer <int32> >= 0

Идентификатор группы.

hostname
required
string

Имя хоста для узла; определяется автоматически, если не задано.

hosts
required
Массив strings

Список хостов для прослушивания.

nodes
required
Массив strings

Список узлов для присоединения.

null or SslConfig (object)
One of
null
state_dir
required
string

Путь к каталогу состояния.

store_addr
string or null

Адрес хранилища для подключения.

{
  • "hosts": [
    ],
  • "state_dir": "string",
  • "docker_host": "string",
  • "store_addr": "string",
  • "gateway": "string",
  • "hostname": "string",
  • "nodes": [
    ],
  • "advertise_addr": "string",
  • "conf_dir": "string",
  • "gid": 0,
  • "ssl": { }
}

DeviceMapping

CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
{
  • "PathOnHost": "string",
  • "PathInContainer": "string",
  • "CgroupPermissions": "string"
}

DeviceRequest

Capabilities
Массив strings or null[ items ]

Список возможностей: объединение по OR списков, внутри которых возможности объединены по AND.

Count
integer or null <int64>
DeviceIDs
Массив strings or null
Driver
string or null
object or null

Параметры драйвера в виде пар ключ/значение. Они передаются непосредственно драйверу.

property name*
additional property
string
{
  • "Driver": "string",
  • "Count": 0,
  • "DeviceIDs": [
    ],
  • "Capabilities": [
    ],
  • "Options": {
    }
}

DnsEntry

required
string or object or object (NetworkKind)
One of
string

Селектор сетевой привязки.

Name
required
string
{
  • "Name": "string",
  • "IpAddress": "string"
}

EndpointIpamConfig

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
Массив strings or null
{
  • "IPv4Address": "string",
  • "IPv6Address": "string",
  • "LinkLocalIPs": [
    ]
}

EndpointSettings

Aliases
Массив strings or null
DNSNames
Массив strings or null

Список всех DNS-имён конечной точки в определённой сети. Он основан на имени контейнера, сетевых псевдонимах, коротком идентификаторе контейнера и имени хоста. Эти имена не являются полностью квалифицированными, но могут содержать несколько точек. Чтобы получить полное DNS-имя, добавьте .<network-name>. Например, если контейнер называется my.ctr, а сеть — testnet, то DNSNames содержит my.ctr, а FQDN равен my.ctr.testnet.

object or null

DriverOpts сопоставляет параметры драйвера и их значения. Эти параметры относятся к конкретному драйверу и передаются ему непосредственно.

property name*
additional property
string
EndpointID
string or null

Уникальный идентификатор конечной точки службы в Sandbox.

Gateway
string or null

Адрес шлюза этой сети.

GlobalIPv6Address
string or null

Глобальный адрес IPv6.

GlobalIPv6PrefixLen
integer or null <int64>

Длина маски глобального адреса IPv6.

IPAddress
string or null

Адрес IPv4.

null or EndpointIpamConfig (object)
One of
null
IPPrefixLen
integer or null <int64>

Длина маски адреса IPv4.

IPv6Gateway
string or null

Адрес шлюза IPv6.

Links
Массив strings or null
MacAddress
string or null

MAC-адрес конечной точки в этой сети. Драйвер сети может игнорировать параметр.

NetworkID
string or null

Уникальный идентификатор сети.

{
  • "IPAMConfig": { },
  • "Links": [
    ],
  • "MacAddress": "string",
  • "Aliases": [
    ],
  • "NetworkID": "string",
  • "EndpointID": "string",
  • "Gateway": "string",
  • "IPAddress": "string",
  • "IPPrefixLen": 0,
  • "IPv6Gateway": "string",
  • "GlobalIPv6Address": "string",
  • "GlobalIPv6PrefixLen": 0,
  • "DriverOpts": {
    },
  • "DNSNames": [
    ]
}

Event

Action
required
string

Action — выполненное или неудавшееся действие в отношении соответствующего участника. Значение предназначено для машинной обработки. Для новых событий поле не может быть пустым и допускает не более 128 символов.

null or EventActor (object)
One of
null
CreatedAt
required
string <date-time>

Время создания события.

ExpiresAt
required
string <date-time>

Время истечения события.

Key
required
string <uuid>

Уникальный идентификатор события.

Kind
required
string (EventKind)
Допустимые значения: "error" "normal" "warning"

Тип события (Error, Normal, Warning); в будущем могут появиться новые типы. Значение предназначено для машинной обработки. Для новых событий поле не может быть пустым.

object

Стандартные метаданные.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Note
string or null

Понятное человеку описание состояния операции.

Reason
required
string

Reason — причина выполнения действия, понятная человеку. Для новых событий поле не может быть пустым и допускает не более 128 символов.

null or EventActor (object)
One of
null
ReportingController
required
string

Reporting Controller — имя контроллера, создавшего событие, например nanocl.io/core. Для новых событий поле не может быть пустым.

ReportingNode
required
string

Reporting Node — имя узла, на котором создано событие.

{
  • "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": { },
  • "Related": { },
  • "Metadata": {
    }
}

EventActor

object
additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Key
string or null
Kind
required
string (EventActorKind)
Допустимые значения: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind — тип события, связанный с типом участника.

{
  • "Key": "string",
  • "Kind": "Namespace",
  • "Attributes": {
    }
}

EventActorKind

string (EventActorKind)
Допустимые значения: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind — тип события, связанный с типом участника.

"Namespace"

EventCondition

required
Массив 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 strings or strings or objects (NativeEventAction)
Array
One of
string
Значение: "create"

Action — действие, вызвавшее событие.

ActorKey
string or null
null or EventActorKind (string)
One of
null
Kind
required
Массив strings (EventKind)
Допустимые элементы Допустимые значения: "error" "normal" "warning"
RelatedKey
string or null
null or EventActorKind (string)
One of
null
{
  • "ActorKey": "string",
  • "ActorKind": { },
  • "RelatedKey": "string",
  • "RelatedKind": { },
  • "Kind": [
    ],
  • "Action": [
    ]
}

EventKind

string (EventKind)
Допустимые значения: "error" "normal" "warning"

Тип события (Error, Normal, Warning); в будущем могут появиться новые типы.

"error"

GenericCount

Count
required
integer <int64>

Число элементов.

{
  • "Count": 0
}

GenericResourcesInner

null or GenericResourcesInnerDiscreteResourceSpec (object)
One of
null
null or GenericResourcesInnerNamedResourceSpec (object)
One of
null
{
  • "NamedResourceSpec": { },
  • "DiscreteResourceSpec": { }
}

GenericResourcesInnerDiscreteResourceSpec

Kind
string or null
Value
integer or null <int64>
{
  • "Kind": "string",
  • "Value": 0
}

GenericResourcesInnerNamedResourceSpec

Kind
string or null
Value
string or null
{
  • "Kind": "string",
  • "Value": "string"
}

GraphDriverData

required
object

Низкоуровневые метаданные хранения в виде пар ключ/значение. Они зависят от используемого драйвера хранения и предназначены только для справочной информации.

property name*
additional property
string
Name
required
string

Имя драйвера хранения.

{
  • "Name": "string",
  • "Data": {
    }
}

HashMap

additional property
null or Массив objects
One of
null
{
  • "property1": { },
  • "property2": { }
}

Health

FailingStreak
integer or null <int64>

FailingStreak — число последовательных неудачных проверок.

Массив objects or null (HealthcheckResult)

Log содержит последние результаты, начиная с самого старого.

Array
null or String (string)
ExitCode
integer or null <int64>

Значения ExitCode: - 0 работоспособен - 1 неработоспособен - 2 зарезервировано, считается неработоспособным - остальные значения: ошибка выполнения проверки.

Output
string or null

Вывод последней проверки.

null or String (string)
null or HealthStatusEnum (string)
One of
null
{
  • "Status": { },
  • "FailingStreak": 0,
  • "Log": [
    ]
}

HealthConfig

Interval
integer or null <int64>

Интервал между проверками в наносекундах. Должен быть равен 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

Retries
integer or null <int64>

Число последовательных неудачных проверок, после которых контейнер считается неработоспособным. 0 означает наследование значения.

StartInterval
integer or null <int64>

Интервал между проверками в начальный период, в наносекундах. Должен быть равен 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

StartPeriod
integer or null <int64>

Начальный период инициализации контейнера перед отсчётом повторных проверок работоспособности, в наносекундах. Должен быть равен 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

Test
Массив strings or null

Выполняемая проверка. Возможные значения: - []: наследовать проверку образа или родительского образа - [\"NONE\"]: отключить проверку работоспособности - [\"CMD\", args...]: выполнить аргументы непосредственно - [\"CMD-SHELL\", command]: выполнить команду в оболочке системы по умолчанию.

Timeout
integer or null <int64>

Время ожидания до признания проверки зависшей. Должно быть равно 0 или не менее 1000000 (1 мс). 0 означает наследование значения.

{
  • "Test": [
    ],
  • "Interval": 0,
  • "Timeout": 0,
  • "Retries": 0,
  • "StartPeriod": 0,
  • "StartInterval": 0
}

HealthStatusEnum

string (HealthStatusEnum)
Допустимые значения: "EMPTY" "none" "starting" "healthy" "unhealthy"
"EMPTY"

HealthcheckResult

null or String (string)
One of
null
ExitCode
integer or null <int64>

Значения ExitCode: - 0 работоспособен - 1 неработоспособен - 2 зарезервировано, считается неработоспособным - остальные значения: ошибка выполнения проверки.

Output
string or null

Вывод последней проверки.

null or String (string)
One of
null
{
  • "Start": { },
  • "End": { },
  • "ExitCode": 0,
  • "Output": "string"
}

HostConfig

object or null

Произвольные неидентифицирующие метаданные контейнера, передаваемые среде выполнения при его запуске.

property name*
additional property
string
AutoRemove
boolean or null

Автоматически удалять контейнер после завершения его процесса. Не действует, если задан RestartPolicy.

Binds
Массив strings or null

Список подключений томов для контейнера. Каждое подключение задаётся строкой одного из следующих форматов: - host-src:container-dest[:options] — подключение пути хоста в контейнер. host-src и container-dest должны быть абсолютными путями. - volume-name:container-dest[:options] — подключение в контейнер тома, управляемого драйвером томов. container-dest должен быть абсолютным путём. options — необязательный список следующих параметров, разделённых запятыми: - nocopy отключает автоматическое копирование данных из пути контейнера в том. Флаг nocopy применяется только к именованным томам. - [ro|rw] подключает том только для чтения или для чтения и записи соответственно. Если параметр отсутствует или равен rw, том подключается для чтения и записи. - [z|Z] применяет метки SELinux, разрешающие или запрещающие нескольким контейнерам читать и записывать один том. - z: содержимому назначается общая метка. Она означает, что несколько контейнеров могут совместно читать и записывать содержимое тома. - Z: назначается частная, не разделяемая метка. Она означает, что частный том может использовать только текущий контейнер. Системы вроде SELinux требуют соответствующих меток для содержимого томов, подключаемых в контейнер. Без метки система безопасности может запретить процессам контейнера использовать содержимое. По умолчанию метки, заданные операционной системой хоста, не изменяются. - [[r]shared|[r]slave|[r]private] задаёт распространение монтирования. Это относится только к привязанным путям хоста, а не к внутренним или именованным томам. Для распространения исходная точка монтирования, где исходный каталог подключён в ОС хоста, должна иметь правильные свойства распространения. Для общих томов исходная точка должна быть shared. Для подчинённых томов она должна быть shared или slave.

Массив objects or null (ThrottleDevice)

Ограничить скорость чтения устройства в байтах в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

Массив objects or null (ThrottleDevice)

Ограничить скорость чтения устройства в операциях ввода-вывода в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

Массив objects or null (ThrottleDevice)

Ограничить скорость записи на устройство в байтах в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

Массив objects or null (ThrottleDevice)

Ограничить скорость записи на устройство в операциях ввода-вывода в секунду, в формате: [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

BlkioWeight
integer or null <int32> >= 0

Относительный вес блочного ввода-вывода.

Массив objects or null (ResourcesBlkioWeightDevice)

Вес блочного ввода-вывода, относительный для устройства, в формате: [{\"Path\": \"device_path\", \"Weight\": weight}]

Array
Path
string or null
Weight
integer or null >= 0
CapAdd
Массив strings or null

Список возможностей ядра, добавляемых контейнеру. Несовместим с параметром 'Capabilities'.

CapDrop
Массив strings or null

Список возможностей ядра, удаляемых у контейнера. Несовместим с параметром 'Capabilities'.

Cgroup
string or null

Cgroup для контейнера.

null or HostConfigCgroupnsModeEnum (string)
One of
null
CgroupParent
string or null

Путь cgroups, в котором создаётся cgroup контейнера. Если путь не абсолютный, он считается относительным к пути cgroups процесса init. Если cgroups отсутствуют, они создаются.

ConsoleSize
Массив integers or null <int32> [ items <int32 > ]

Исходный размер консоли в виде массива [height, width].

ContainerIDFile
string or null

Путь к файлу, в который записывается идентификатор контейнера.

CpuCount
integer or null <int64>

Число доступных CPU; только для Windows. В контейнерах Windows Server ограничения ресурсов процессора взаимоисключающие. Приоритет: сначала CPUCount, затем CPUShares, последним CPUPercent.

CpuPercent
integer or null <int64>

Доступный процент имеющихся CPU; только для Windows. В контейнерах Windows Server ограничения ресурсов процессора взаимоисключающие. Приоритет: сначала CPUCount, затем CPUShares, последним CPUPercent.

CpuPeriod
integer or null <int64>

Длительность периода CPU в микросекундах.

CpuQuota
integer or null <int64>

Микросекунды процессорного времени, доступные контейнеру за один период CPU.

CpuRealtimePeriod
integer or null <int64>

Длительность периода CPU реального времени в микросекундах. Значение 0 означает, что время задачам реального времени не выделяется.

CpuRealtimeRuntime
integer or null <int64>

Длительность выполнения CPU реального времени в микросекундах. Значение 0 означает, что время задачам реального времени не выделяется.

CpusetCpus
string or null

CPU, на которых разрешено выполнение, например 0-3 или 0,1.

CpusetMems
string or null

Узлы памяти (MEMs), на которых разрешено выполнение (0-3, 0,1). Действует только в системах NUMA.

CpuShares
integer or null <int64>

Целое число, представляющее относительный вес CPU контейнера по сравнению с другими контейнерами.

DeviceCgroupRules
Массив strings or null

Список правил cgroup для контейнера.

Массив objects or null (DeviceRequest)

Список запросов устройств, передаваемых драйверам устройств.

Array
Capabilities
Массив strings or null[ items ]

Список возможностей: объединение по OR списков, внутри которых возможности объединены по AND.

Count
integer or null <int64>
DeviceIDs
Массив strings or null
Driver
string or null
object or null

Параметры драйвера в виде пар ключ/значение. Они передаются непосредственно драйверу.

Массив objects or null (DeviceMapping)

Список устройств, добавляемых в контейнер.

Array
CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
Dns
Массив strings or null

Список DNS-серверов для контейнера.

DnsOptions
Массив strings or null

Список параметров DNS.

DnsSearch
Массив strings or null

Список доменов поиска DNS.

ExtraHosts
Массив strings or null

Список сопоставлений имён хостов и IP-адресов, добавляемых в файл /etc/hosts контейнера. Формат: [\"hostname:IP\"].

GroupAdd
Массив strings or null

Список дополнительных групп, от имени которых работает процесс контейнера.

Init
boolean or null

Запускать внутри контейнера процесс init, передающий сигналы и собирающий завершённые процессы. Пустое поле не включается в запрос; используется настройка демона по умолчанию.

IOMaximumBandwidth
integer or null <int64>

Максимальная скорость ввода-вывода системного диска контейнера в байтах в секунду; только для Windows.

IOMaximumIOps
integer or null <int64>

Максимальное число операций ввода-вывода в секунду для системного диска контейнера; только для Windows.

IpcMode
string or null

Режим общего использования IPC для контейнера. Возможные значения: - \"none\": собственное частное пространство имён IPC без подключения /dev/shm - \"private\": собственное частное пространство имён IPC - \"shareable\": собственное частное пространство имён IPC с возможностью совместного использования другими контейнерами - \"container:<name|id>\": присоединиться к разделяемому пространству имён IPC другого контейнера - \"host\": использовать пространство имён IPC хоста. Если значение не задано, используется значение по умолчанию демона: \"private\" или \"shareable\", в зависимости от его версии и конфигурации.

null or HostConfigIsolationEnum (string)
One of
null
KernelMemoryTCP
integer or null <int64>

Жёсткое ограничение памяти TCP-буфера ядра в байтах. Параметр может игнорироваться в зависимости от среды выполнения OCI. Он больше не поддерживается средой по умолчанию (runc). Пустое поле не включается в ответ.

Links
Массив strings or null

Список связей контейнера в формате container_name:alias.

null or HostConfigLogConfig (object)
One of
null
MaskedPaths
Массив strings or null

Список путей, скрываемых внутри контейнера; переопределяет набор путей по умолчанию.

Memory
integer or null <int64>

Ограничение памяти в байтах.

MemoryReservation
integer or null <int64>

Мягкое ограничение памяти в байтах.

MemorySwap
integer or null <int64>

Общее ограничение памяти, включая память и swap. Значение -1 разрешает неограниченный swap.

MemorySwappiness
integer or null <int64>

Настроить swappiness памяти контейнера. Допускается целое число от 0 до 100.

Массив objects or null (Mount)

Спецификация подключений, добавляемых в контейнер.

Array
null or MountBindOptions (object)
Consistency
string or null

Требование согласованности монтирования: default, consistent, cached или delegated.

ReadOnly
boolean or null

Показывает, должно ли подключение быть доступно только для чтения.

Source
string or null

Источник монтирования, например имя тома или путь хоста.

Target
string or null

Путь в контейнере.

null or MountTmpfsOptions (object)
null or MountTypeEnum (string)
null or MountVolumeOptions (object)
NanoCpus
integer or null <int64>

Квота CPU в единицах 10-9 процессора.

NetworkMode
string or null

Сетевой режим контейнера. Поддерживаемые стандартные значения: bridge, host, none и container:<name|id>. Любое другое значение считается именем пользовательской сети, к которой должен подключиться контейнер.

OomKillDisable
boolean or null

Отключить OOM killer для контейнера.

OomScoreAdj
integer or null <int64>

Целочисленная оценка контейнера для настройки приоритетов OOM killer.

PidMode
string or null

Задать режим пространства имён PID (процессов) для контейнера. Возможные значения: - \"container:<name|id>\": присоединиться к пространству имён PID другого контейнера - \"host\": использовать пространство имён PID хоста внутри контейнера.

PidsLimit
integer or null <int64>

Настроить ограничение PID контейнера. 0 или -1 означает отсутствие ограничения, null — не изменять.

null or HashMap (object)
One of
null
Privileged
boolean or null

Предоставляет контейнеру полный доступ к хосту.

PublishAllPorts
boolean or null

Выделяет временный порт хоста для каждого открытого порта контейнера. Порты освобождаются при остановке контейнера и выделяются при запуске. При перезапуске выделенный порт может измениться. Порт выбирается из диапазона временных портов, зависящего от ядра. Например, в Linux диапазон задаётся в /proc/sys/net/ipv4/ip_local_port_range.

ReadonlyPaths
Массив strings or null

Список путей, доступных внутри контейнера только для чтения; переопределяет набор путей по умолчанию.

ReadonlyRootfs
boolean or null

Подключить корневую файловую систему контейнера только для чтения.

null or RestartPolicy (object)
One of
null
Runtime
string or null

Среда выполнения для этого контейнера.

SecurityOpt
Массив strings or null

Список строк для настройки меток в системах MLS, например SELinux.

ShmSize
integer or null <int64>

Размер /dev/shm в байтах. Если не задан, система использует 64 МБ.

object or null

Параметры драйвера хранения контейнера в формате {\"size\": \"120G\"}.

property name*
additional property
string
object or null

Список параметров ядра (sysctls), задаваемых в контейнере. Например: {\"net.ipv4.ip_forward\": \"1\"}

property name*
additional property
string
object or null

Сопоставление каталогов контейнера, заменяемых подключениями tmpfs, и соответствующих параметров монтирования. Например: { \"/run\": \"rw,noexec,nosuid,size=65536k\" }

property name*
additional property
string
Массив objects or null (ResourcesUlimits)

Список ограничений ресурсов контейнера. Например: {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}

Array
Hard
integer or null <int64>

Жёсткое ограничение.

Name
string or null

Имя ulimit.

Soft
integer or null <int64>

Мягкое ограничение.

UsernsMode
string or null

Задаёт режим пространства имён пользователя контейнера, когда включено переназначение пространств имён пользователей.

UTSMode
string or null

Пространство имён UTS контейнера.

VolumeDriver
string or null

Драйвер, используемый контейнером для подключения томов.

VolumesFrom
Массив strings or null

Список томов, наследуемых от другого контейнера, в формате <container name>[:<ro|rw>].

{
  • "CpuShares": 0,
  • "Memory": 0,
  • "CgroupParent": "string",
  • "BlkioWeight": 0,
  • "BlkioWeightDevice": [
    ],
  • "BlkioDeviceReadBps": [
    ],
  • "BlkioDeviceWriteBps": [
    ],
  • "BlkioDeviceReadIOps": [
    ],
  • "BlkioDeviceWriteIOps": [
    ],
  • "CpuPeriod": 0,
  • "CpuQuota": 0,
  • "CpuRealtimePeriod": 0,
  • "CpuRealtimeRuntime": 0,
  • "CpusetCpus": "string",
  • "CpusetMems": "string",
  • "Devices": [
    ],
  • "DeviceCgroupRules": [
    ],
  • "DeviceRequests": [
    ],
  • "KernelMemoryTCP": 0,
  • "MemoryReservation": 0,
  • "MemorySwap": 0,
  • "MemorySwappiness": 0,
  • "NanoCpus": 0,
  • "OomKillDisable": true,
  • "Init": true,
  • "PidsLimit": 0,
  • "Ulimits": [
    ],
  • "CpuCount": 0,
  • "CpuPercent": 0,
  • "IOMaximumIOps": 0,
  • "IOMaximumBandwidth": 0,
  • "Binds": [
    ],
  • "ContainerIDFile": "string",
  • "LogConfig": { },
  • "NetworkMode": "string",
  • "PortBindings": { },
  • "RestartPolicy": { },
  • "AutoRemove": true,
  • "VolumeDriver": "string",
  • "VolumesFrom": [
    ],
  • "Mounts": [
    ],
  • "ConsoleSize": [
    ],
  • "Annotations": {
    },
  • "CapAdd": [
    ],
  • "CapDrop": [
    ],
  • "CgroupnsMode": { },
  • "Dns": [
    ],
  • "DnsOptions": [
    ],
  • "DnsSearch": [
    ],
  • "ExtraHosts": [
    ],
  • "GroupAdd": [
    ],
  • "IpcMode": "string",
  • "Cgroup": "string",
  • "Links": [
    ],
  • "OomScoreAdj": 0,
  • "PidMode": "string",
  • "Privileged": true,
  • "PublishAllPorts": true,
  • "ReadonlyRootfs": true,
  • "SecurityOpt": [
    ],
  • "StorageOpt": {
    },
  • "Tmpfs": {
    },
  • "UTSMode": "string",
  • "UsernsMode": "string",
  • "ShmSize": 0,
  • "Sysctls": {
    },
  • "Runtime": "string",
  • "Isolation": { },
  • "MaskedPaths": [
    ],
  • "ReadonlyPaths": [
    ]
}

HostConfigCgroupnsModeEnum

string (HostConfigCgroupnsModeEnum)
Допустимые значения: "EMPTY" "private" "host"
"EMPTY"

HostConfigIsolationEnum

string (HostConfigIsolationEnum)
Допустимые значения: "EMPTY" "default" "process" "hyperv"
"EMPTY"

HostConfigLogConfig

object or null
property name*
additional property
string
Type
string or null
{
  • "Type": "string",
  • "Config": {
    }
}

HostInfo

Architecture
string or null

Аппаратная архитектура хоста, возвращаемая средой Go (GOARCH). Полный список значений приведён в документации Go.

BridgeNfIp6tables
boolean or null

Показывает, доступен ли bridge-nf-call-ip6tables на хосте.

BridgeNfIptables
boolean or null

Показывает, доступен ли bridge-nf-call-iptables на хосте.

CDISpecDirs
Массив strings or null

Список каталогов со спецификациями CDI (Container Device Interface). Они определяют изменения спецификации OCI создаваемого контейнера для конкретного поставщика. Пустой список означает, что внедрение устройств CDI отключено. Для него требуется экспериментальный режим демона. Неэкспериментальные демоны всегда возвращают пустой список.

null or SystemInfoCgroupDriverEnum (string)
One of
null
null or SystemInfoCgroupVersionEnum (string)
One of
null
required
object (DaemonConfig)

Конфигурация демона.

advertise_addr
required
string

Адрес, объявляемый другим узлам.

conf_dir
required
string

Каталог конфигурации.

docker_host
string

Используемый хост Docker.

gateway
required
string

Шлюз хоста, автоматически определяемый как шлюз хоста по умолчанию, если значение не задано.

gid
required
integer <int32> >= 0

Идентификатор группы.

hostname
required
string

Имя хоста для узла; определяется автоматически, если не задано.

hosts
required
Массив strings

Список хостов для прослушивания.

nodes
required
Массив strings

Список узлов для присоединения.

null or SslConfig (object)
state_dir
required
string

Путь к каталогу состояния.

store_addr
string or null

Адрес хранилища для подключения.

null or Commit (object)
One of
null
Containers
integer or null <int64>

Общее число контейнеров на хосте.

ContainersPaused
integer or null <int64>

Число контейнеров со статусом \"paused\".

ContainersRunning
integer or null <int64>

Число контейнеров со статусом \"running\".

ContainersStopped
integer or null <int64>

Число контейнеров со статусом \"stopped\".

CpuCfsPeriod
boolean or null

Показывает, поддерживает ли хост период CPU CFS (Completely Fair Scheduler).

CpuCfsQuota
boolean or null

Показывает, поддерживает ли хост квоту CPU CFS (Completely Fair Scheduler).

CPUSet
boolean or null

Показывает, поддерживает ли хост CPUsets (cpuset.cpus, cpuset.mems). См. cpuset(7).

CPUShares
boolean or null

Показывает, поддерживает ли хост ограничение долей CPU.

Debug
boolean or null

Показывает, работает ли демон в режиме отладки с уровнем журналирования debug.

Массив objects or null (SystemInfoDefaultAddressPools)

Список пользовательских пулов адресов по умолчанию для локальных сетей, задаваемых в daemon.json или параметром dockerd. Например, Base "10.10.0.0/16" с Size 24 задаёт 256 пулов адресов 10.10.[0-255].0/24.

Array
Base
string or null

Адрес сети в формате CIDR.

Size
integer or null <int64>

Размер пула сети.

DefaultRuntime
string or null

Имя среды выполнения OCI по умолчанию, используемой при запуске контейнеров. Его можно переопределить для конкретного контейнера при создании.

DockerRootDir
string or null

Корневой каталог постоянного состояния Docker. По умолчанию /var/lib/docker в Linux и C:\\ProgramData\\docker в Windows.

Driver
string or null

Имя используемого драйвера хранения.

DriverStatus
Массив strings or null[ items ]

Сведения драйвера хранения в виде пар "label" / "value". Драйвер предоставляет их в формате, согласованном с выводом docker info в командной строке.


> Примечание: сведения в этом поле, включая формат значений и меток, не следует считать стабильными; они могут измениться без уведомления.

ExperimentalBuild
boolean or null

Показывает, включены ли экспериментальные функции демона.

null or GenericResourcesInner (object)
One of
null
HostGateway
required
string

HostGateway — адрес шлюза хоста.

HttpProxy
string or null

HTTP-прокси демона. Значение берётся из переменной окружения HTTP_PROXY. Учётные данные в компоненте сведений о пользователе URL прокси маскируются в ответе API. Контейнеры не наследуют эту конфигурацию автоматически.

HttpsProxy
string or null

HTTPS-прокси демона. Значение берётся из переменной окружения HTTPS_PROXY. Учётные данные в компоненте сведений о пользователе URL прокси маскируются в ответе API. Контейнеры не наследуют эту конфигурацию автоматически.

ID
string or null

Уникальный идентификатор демона.


> Примечание: формат идентификатора не является частью API и не должен считаться стабильным.

Images
integer or null <int64>

Общее число образов на хосте. Учитываются образы с тегами и без тегов, включая висячие образы.

IndexServerAddress
string or null

Адрес или URL сервера индекса, используемого для поиска образов и по умолчанию для аутентификации пользователей в Docker Hub и Docker Cloud.

InitBinary
string or null

Имя и необязательный путь двоичного файла docker-init. Если путь отсутствует, демон ищет файл в $PATH хоста и использует первый результат.

null or Commit (object)
One of
null
IPv4Forwarding
boolean or null

Показывает, включена ли пересылка IPv4.

null or SystemInfoIsolationEnum (string)
One of
null
KernelMemoryTCP
boolean or null

Показывает, поддерживает ли хост ограничение TCP-памяти ядра. Поле отсутствует, если ограничение не поддерживается. Ограничения TCP-памяти ядра недоступны с cgroups v2, где нет соответствующего cgroup memory.kmem.tcp.limit_in_bytes.

KernelVersion
string or null

Версия ядра хоста. В Linux сведения получаются из uname. В Windows они читаются из значения реестра HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\, например "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Labels
Массив strings or null

Пользовательские метки демона в виде метаданных ключ/значение.


> Примечание: в Swarm узлы могут иметь метки демона, заданные его конфигурацией, и метки узла, заданные управляющим узлом Swarm. Метки узла в это поле не включены. Их можно получить конечной точкой /nodes/(id) на управляющем узле Swarm.

LiveRestoreEnabled
boolean or null

Показывает, включён ли live restore. Если включён, контейнеры продолжают работать при остановке демона, а также при его запуске, если обнаружены работающие контейнеры.

LoggingDriver
string or null

Драйвер журналирования по умолчанию для новых контейнеров.

MemoryLimit
boolean or null

Показывает, поддерживает ли хост ограничения памяти.

MemTotal
integer or null <int64>

Общий объём физической памяти хоста в байтах.

Name
string or null

Имя хоста.

NCPU
integer or null <int64>

Число логических CPU, доступных демону. Оно определяется запросом к операционной системе при запуске демона. Изменения распределения CPU после запуска не отражаются.

required
object (Network)

Конфигурация сети.

Attachable
boolean or null
object or null
null or String (string)
Driver
string or null
EnableIPv6
boolean or null
Id
string or null
Ingress
boolean or null
Internal
boolean or null
null or Ipam (object)
object or null
Name
string or null
object or null
Scope
string or null
NEventsListener
integer or null <int64>

Число подписанных слушателей событий.

NFd
integer or null <int64>

Общее число файловых дескрипторов, используемых процессом демона. Сведения возвращаются только в режиме отладки.

NGoroutines
integer or null <int64>

Текущее число goroutines. Сведения возвращаются только в режиме отладки.

NoProxy
string or null

Разделённый запятыми список расширений доменов, для которых прокси не используется. Значение берётся из переменной окружения NO_PROXY. Контейнеры не наследуют эту конфигурацию автоматически.

OomKillDisable
boolean or null

Показывает, поддерживается ли отключение OOM killer на хосте.

OperatingSystem
string or null

Имя операционной системы хоста, например "Ubuntu 16.04.2 LTS" или "Windows Server 2016 Datacenter".

OSType
string or null

Тип операционной системы хоста, возвращаемый средой Go (GOOS). Сейчас возвращаются значения "linux" и "windows". Полный список возможных значений приведён в документации Go.

OSVersion
string or null

Версия операционной системы хоста.


> Примечание: сведения в этом поле, включая само его наличие и формат значений, не следует считать стабильными; они могут измениться без уведомления.

PidsLimit
boolean or null

Показывает, поддерживает ли ядро хоста ограничение PID.

null or PluginsInfo (object)
One of
null
ProductLicense
string or null

Краткие сведения о лицензии продукта на демоне. Если применена коммерческая лицензия, включаются такие сведения, как число узлов и срок действия.

null or RegistryServiceConfig (object)
One of
null
null or Commit (object)
One of
null
object or null

Список сред выполнения, совместимых с OCI и настроенных на демоне. Ключи содержат "name", используемое для обращения к среде. Демон Docker использует совместимую с OCI среду, вызываемую через демон containerd, как интерфейс к пространствам имён ядра Linux, cgroups и SELinux. Среда по умолчанию — runc — настраивается автоматически. Дополнительные среды, настроенные пользователем, перечисляются здесь.

additional property
object (Runtime)

Runtime описывает среду выполнения, совместимую с OCI. Демон вызывает её через демон containerd. Среды OCI служат интерфейсом к пространствам имён ядра Linux, cgroups и SELinux.

SecurityOptions
Массив strings or null

Список функций безопасности, включённых на демоне, например apparmor, seccomp, SELinux, пространства имён пользователей (userns), rootless и no-new-privileges. Дополнительные параметры каждой функции могут быть включены в виде разделённого запятыми списка пар ключ/значение.

ServerVersion
string or null

Строка версии демона.

SwapLimit
boolean or null

Показывает, поддерживает ли хост ограничения swap.

null or SwarmInfo (object)
One of
null
SystemTime
string or null

Текущее системное время в формате RFC 3339, с наносекундами.

Warnings
Массив strings or null

Список предупреждений и информационных сообщений об отсутствующих функциях или проблемах конфигурации демона. Клиент может показать их пользователю.

{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": { },
  • "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": { },
  • "CgroupVersion": { },
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": { },
  • "GenericResources": { },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": { },
  • "LiveRestoreEnabled": true,
  • "Isolation": { },
  • "InitBinary": "string",
  • "ContainerdCommit": { },
  • "RuncCommit": { },
  • "InitCommit": { },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ],
  • "HostGateway": "string",
  • "Network": {
    },
  • "Config": {
    }
}

Hsts

One of
string
Значение: "Recommended"
{
  • "Config": {
    }
}

HstsConfig

Always
required
boolean
IncludeSubDomains
required
boolean
MaxAge
required
integer <int64> >= 0
Preload
required
boolean
{
  • "MaxAge": 0,
  • "Preload": true,
  • "Always": true,
  • "IncludeSubDomains": true
}

HttpTarget

null or UrlRedirect (string)
One of
null
Url
required
string

Целевой URL.

{
  • "Url": "string",
  • "Redirect": { }
}

ImagePullPolicy

string (ImagePullPolicy)
Допустимые значения: "Never" "Always" "IfNotPresent"

Политика загрузки образов объектов процессов (job, cargo, vm).

"Never"

IndexInfo

Mirrors
Массив strings or null

Список зеркал в виде URI.

Name
string or null

Имя реестра, например "docker.io".

Official
boolean or null

Показывает, является ли реестр официальным, то есть Docker Hub / docker.io.

Secure
boolean or null

Показывает, входит ли реестр в список небезопасных реестров. Если false, реестр небезопасен. Такие реестры допускают незашифрованные соединения HTTP и/или недоверенные соединения HTTPS с сертификатами неизвестных центров сертификации. > Предупреждение: небезопасные реестры полезны при локальном запуске, но создают уязвимости и должны включаться ТОЛЬКО для тестирования. Для большей безопасности добавьте свой центр сертификации в список доверенных центров системы вместо включения этого параметра.

{
  • "Name": "string",
  • "Mirrors": [
    ],
  • "Secure": true,
  • "Official": true
}

Ipam

Массив objects or null (IpamConfig)

Список параметров конфигурации IPAM в виде отображения: {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>}

Array
object or null
Gateway
string or null
IPRange
string or null
Subnet
string or null
Driver
string or null

Имя используемого драйвера IPAM.

object or null

Параметры драйвера в виде отображения.

property name*
additional property
string
{
  • "Driver": "string",
  • "Config": [
    ],
  • "Options": {
    }
}

IpamConfig

object or null
property name*
additional property
string
Gateway
string or null
IPRange
string or null
Subnet
string or null
{
  • "Subnet": "string",
  • "IPRange": "string",
  • "Gateway": "string",
  • "AuxiliaryAddresses": {
    }
}

Job

CreatedAt
required
string <date-time>

Время создания задания.

required
object (JobSpec)

Спецификация задания.

required
Массив objects (Config)

Запускаемые контейнеры.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

Name
required
string

Имя задания.

Schedule
string or null

Расписание задания (cron).

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

required
object (ObjPsStatus)

Состояние задания.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>

Время обновления задания.

{
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

JobInspect

CreatedAt
required
string <date-time>

Время создания задания.

InstanceFailed
required
integer >= 0

Число неудачных экземпляров.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

required
Массив objects (Process)

Список экземпляров.

Array
CreatedAt
required
string <date-time>

Дата создания.

required
object (ContainerInspectResponse)

Данные процесса: ContainerInspect.

IpAddress
string or null

Фактический IP-адрес, полученный из последнего наблюдаемого состояния процесса.

Key
required
string

Ключ процесса.

Kind
required
string (ProcessKind)
Допустимые значения: "vm" "job" "cargo"

Тип процесса (Job, Vm, Cargo).

KindKey
required
string

Канонический ключ ресурса для Cargo и VM; задания используют своё имя.

Name
required
string

Имя процесса.

NodeName
required
string

Имя узла, на котором работает контейнер.

UpdatedAt
required
string <date-time>

Время последнего обновления экземпляра.

InstanceSuccess
required
integer >= 0

Число успешно завершённых экземпляров.

InstanceTotal
required
integer >= 0

Число экземпляров.

required
object (JobSpec)

Спецификация задания.

required
Массив objects (Config)

Запускаемые контейнеры.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

Name
required
string

Имя задания.

Schedule
string or null

Расписание задания (cron).

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

required
object (ObjPsStatus)

Состояние задания.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>

Время обновления задания.

{
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    },
  • "Instances": [
    ]
}

JobPartial

required
Массив objects (Config)

Список запускаемых контейнеров.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or HealthConfig (object)
null or HostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or NetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

null or ImagePullPolicy (string)
One of
null
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя задания.

Schedule
string or null

Выражение cron с пятью полями или поддерживаемое сокращение; см. [crate::cron::validate_schedule].

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

JobSpec

required
Массив objects (Config)

Запускаемые контейнеры.

Array
ArgsEscaped
boolean or null

Команда уже экранирована; только для Windows.

AttachStderr
boolean or null

Показывает, следует ли подключиться к stderr.

AttachStdin
boolean or null

Показывает, следует ли подключиться к stdin.

AttachStdout
boolean or null

Показывает, следует ли подключиться к stdout.

Cmd
Массив strings or null

Выполняемая команда в виде строки или массива строк.

Domainname
string or null

Доменное имя контейнера.

Entrypoint
Массив strings or null

Точка входа контейнера в виде строки или массива строк. Если массив содержит ровно одну пустую строку ([\"\"]), точка входа сбрасывается к системному значению по умолчанию, используемому Docker, когда инструкция ENTRYPOINT отсутствует в Dockerfile.

Env
Массив strings or null

Список переменных окружения, задаваемых в контейнере, в формате [\"VAR=value\", ...]. Переменная без = удаляется из окружения, а не получает пустое значение.

object or null

Объект, сопоставляющий порты с пустым объектом в формате: {\"<port>/<tcp|udp|sctp>\": {}}

null or HealthConfig (object)
null or HostConfig (object)
Hostname
string or null

Имя хоста контейнера, соответствующее RFC 1123.

Image
string or null

Имя образа для создания контейнера.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес контейнера.

NetworkDisabled
boolean or null

Отключить сеть для контейнера.

null or NetworkingConfig_String (object)
OnBuild
Массив strings or null

Метаданные ONBUILD, определённые в Dockerfile образа.

OpenStdin
boolean or null

Открыть stdin.

Shell
Массив strings or null

Оболочка для случаев, когда RUN, CMD и ENTRYPOINT используют оболочку.

StdinOnce
boolean or null

Закрыть stdin после отключения одного подключённого клиента.

StopSignal
string or null

Сигнал остановки контейнера в виде строки или беззнакового целого числа.

StopTimeout
integer or null <int64>

Время ожидания остановки контейнера в секундах.

Tty
boolean or null

Подключить стандартные потоки к TTY, включая stdin, если он не закрыт.

User
string or null

Пользователь, от имени которого выполняются команды в контейнере.

object or null

Объект, сопоставляющий пути точек монтирования внутри контейнера с пустыми объектами.

WorkingDir
string or null

Рабочий каталог для выполнения команд.

null or ImagePullPolicy (string)
One of
null
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя задания.

Schedule
string or null

Расписание задания (cron).

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

JobSummary

CreatedAt
required
string <date-time>

Время создания задания.

InstanceFailed
required
integer >= 0

Число неудачных экземпляров.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

InstanceSuccess
required
integer >= 0

Число успешно завершённых экземпляров.

InstanceTotal
required
integer >= 0

Число экземпляров.

required
object (JobSpec)

Спецификация задания.

required
Массив objects (Config)

Запускаемые контейнеры.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

Name
required
string

Имя задания.

Schedule
string or null

Расписание задания (cron).

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

required
object (ObjPsStatus)

Состояние задания.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>

Время обновления задания.

{
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    }
}

LimitReq

Burst
required
integer >= 0

Размер всплеска.

Delay
integer or null >= 0

Время ожидания перед повторной попыткой.

{
  • "Burst": 0,
  • "Delay": 0
}

LimitReqZone

Rate
required
integer >= 0

Максимальное число запросов в секунду.

Size
required
integer >= 0

Максимальный размер кэша в мегабайтах.

{
  • "Size": 0,
  • "Rate": 0
}

LocalNodeState

string (LocalNodeState)
Допустимые значения: "EMPTY" "inactive" "pending" "active" "error" "locked"

Текущее локальное состояние узла. Перечисление значений. Варианты перечисления не содержат данных, поэтому их можно определить как #[repr(C)], что упрощает работу с FFI.

"EMPTY"

LocationTarget

One of
DisableLogging
boolean or null

Отключить журналирование для этой цели.

Key
required
string

Ключ целевого Cargo или VM.

Path
string or null

Целевой путь HTTP при использовании HTTP.

Port
required
integer <int32> >= 0

Порт целевого Cargo или VM.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
Example
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true,
  • "Ssl": { }
}

MemoryStats

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
null or (MemoryStatsStats (MemoryStatsStatsV1 (object) or MemoryStatsStatsV2 (object)))
One of
null
usage
integer or null <int64> >= 0
{
  • "stats": { },
  • "max_usage": 0,
  • "usage": 0,
  • "failcnt": 0,
  • "limit": 0,
  • "commit": 0,
  • "commit_peak": 0,
  • "commitbytes": 0,
  • "commitpeakbytes": 0,
  • "privateworkingset": 0
}

MemoryStatsStats

One of
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
Example
{
  • "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
}

MemoryStatsStatsV1

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
}

MemoryStatsStatsV2

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
}

Metric

CreatedAt
required
string <date-time>

Время создания метрики.

Data
required
any

Данные метрики.

ExpiresAt
required
string <date-time>

Время истечения метрики.

Key
required
string <uuid>

Ключ метрики в базе данных UUID.

Kind
required
string

Тип метрики.

NodeName
required
string

Узел, с которого получена метрика.

Note
string or null

Необязательная заметка о метрике.

{
  • "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"
}

MetricPartial

Data
required
any

Данные метрики.

Kind
required
string

Тип метрики.

Note
string or null

Необязательная заметка о метрике.

{
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Mount

null or MountBindOptions (object)
One of
null
Consistency
string or null

Требование согласованности монтирования: default, consistent, cached или delegated.

ReadOnly
boolean or null

Показывает, должно ли подключение быть доступно только для чтения.

Source
string or null

Источник монтирования, например имя тома или путь хоста.

Target
string or null

Путь в контейнере.

null or MountTmpfsOptions (object)
One of
null
null or MountTypeEnum (string)
One of
null
null or MountVolumeOptions (object)
One of
null
{
  • "Target": "string",
  • "Source": "string",
  • "Type": { },
  • "ReadOnly": true,
  • "Consistency": "string",
  • "BindOptions": { },
  • "VolumeOptions": { },
  • "TmpfsOptions": { }
}

MountBindOptions

CreateMountpoint
boolean or null

Создать точку монтирования на хосте, если она отсутствует.

NonRecursive
boolean or null

Отключить рекурсивное привязанное монтирование.

null or MountBindOptionsPropagationEnum (string)
One of
null
ReadOnlyForceRecursive
boolean or null

Выдать ошибку, если подключение нельзя сделать рекурсивно доступным только для чтения.

ReadOnlyNonRecursive
boolean or null

Сделать само подключение доступным только для чтения, не распространяя это рекурсивно, но сохранив рекурсивное монтирование, если одновременно NonRecursive не равно true. Добавлено в v1.44; ранее все подключения только для чтения по умолчанию были нерекурсивными. Для совместимости с прежним поведением значение по умолчанию для клиентов версий до v1.44 — true.

{
  • "Propagation": { },
  • "NonRecursive": true,
  • "CreateMountpoint": true,
  • "ReadOnlyNonRecursive": true,
  • "ReadOnlyForceRecursive": true
}

MountBindOptionsPropagationEnum

string (MountBindOptionsPropagationEnum)
Допустимые значения: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
"EMPTY"

MountPoint

Destination
string or null

Destination — путь относительно корня контейнера (/), по которому Source подключается внутри контейнера.

Driver
string or null

Driver — драйвер томов, используемый для создания тома, если это том.

Mode
string or null

Mode — разделённый запятыми список параметров, заданных пользователем при создании подключения пути хоста или тома. Значение по умолчанию зависит от платформы: \"z\" в Linux, пустое в Windows.

Name
string or null

Name — имя, ссылающееся на данные, определяемые Source, например имя тома.

Propagation
string or null

Propagation описывает распространение монтирований с хоста в точку монтирования и обратно. Подробности приведены в документации ядра Linux. Поле не используется в Windows.

RW
boolean or null

Показывает, доступно ли подключение для записи, то есть для чтения и записи.

Source
string or null

Источник монтирования. Для томов содержит место хранения тома внутри /var/lib/docker/volumes/. Для привязанных путей и npipe содержит исходную часть монтирования на хосте. Для точек tmpfs поле пустое.

null or MountPointTypeEnum (string)
One of
null
{
  • "Type": { },
  • "Name": "string",
  • "Source": "string",
  • "Destination": "string",
  • "Driver": "string",
  • "Mode": "string",
  • "RW": true,
  • "Propagation": "string"
}

MountPointTypeEnum

string (MountPointTypeEnum)
Допустимые значения: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountTmpfsOptions

Mode
integer or null <int64>

Режим прав доступа к tmpfs в виде целого числа.

SizeBytes
integer or null <int64>

Размер tmpfs в байтах.

{
  • "SizeBytes": 0,
  • "Mode": 0
}

MountTypeEnum

string (MountTypeEnum)
Допустимые значения: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountVolumeOptions

null or MountVolumeOptionsDriverConfig (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
NoCopy
boolean or null

Заполнить том данными из целевого пути.

Subpath
string or null

Исходный путь внутри тома. Должен быть относительным, без переходов в родительские каталоги.

{
  • "NoCopy": true,
  • "Labels": {
    },
  • "DriverConfig": { },
  • "Subpath": "string"
}

MountVolumeOptionsDriverConfig

Name
string or null

Имя драйвера для создания тома.

object or null

Отображение ключ/значение параметров драйвера.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

Namespace

CreatedAt
required
string <date-time>

Время создания пространства имён.

Metadata
any

Метаданные, заданные пользователем.

Name
required
string

Имя, являющееся первичным ключом пространства имён.

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null
}

NamespaceInspect

required
Массив objects (CargoInspect)

Число Cargo.

Array
CreatedAt
required
string <date-time>

Время создания Cargo.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

required
Массив objects (Process)

Список экземпляров.

InstanceTotal
required
integer >= 0

Число экземпляров.

NamespaceName
required
string

Имя пространства имён.

required
object (CargoSpecRevision)

Спецификация Cargo.

required
object (ObjPsStatus)

Состояние Cargo.

Name
required
string

Имя пространства имён.

{
  • "Name": "string",
  • "Cargoes": [
    ]
}

NamespacePartial

Metadata
any

Метаданные, заданные пользователем.

Name
required
string

Имя пространства имён.

{
  • "Name": "string",
  • "Metadata": null
}

NamespaceSummary

Cargoes
required
integer >= 0

Число Cargo.

CreatedAt
required
string <date-time>

Время создания пространства имён.

Instances
required
integer >= 0

Число экземпляров.

Name
required
string

Имя пространства имён.

{
  • "Name": "string",
  • "Cargoes": 0,
  • "Instances": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z"
}

NativeEventAction

One of
string
Значение: "create"

Action — действие, вызвавшее событие.

{
  • "other": "string"
}

Network

Attachable
boolean or null
object or null
additional property
object (NetworkContainer)
null or String (string)
One of
null
Driver
string or null
EnableIPv6
boolean or null
Id
string or null
Ingress
boolean or null
Internal
boolean or null
null or Ipam (object)
One of
null
object or null
property name*
additional property
string
Name
string or null
object or null
property name*
additional property
string
Scope
string or null
{
  • "Name": "string",
  • "Id": "string",
  • "Created": { },
  • "Scope": "string",
  • "Driver": "string",
  • "EnableIPv6": true,
  • "IPAM": { },
  • "Internal": true,
  • "Attachable": true,
  • "Ingress": true,
  • "Containers": {
    },
  • "Options": {
    },
  • "Labels": {
    }
}

NetworkContainer

EndpointID
string or null
IPv4Address
string or null
IPv6Address
string or null
MacAddress
string or null
Name
string or null
{
  • "Name": "string",
  • "EndpointID": "string",
  • "MacAddress": "string",
  • "IPv4Address": "string",
  • "IPv6Address": "string"
}

NetworkKind

One of
string

Зарезервированный селектор, IP-адрес или имя сети, заданное пользователем.

{
  • "Other": "string"
}

NetworkSettings

Bridge
string or null

Имя интерфейса bridge по умолчанию, если у dockerd задан флаг --bridge.

EndpointID
string or null

EndpointID однозначно обозначает конечную точку службы в Sandbox.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

Gateway
string or null

Адрес шлюза сети "bridge" по умолчанию.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

GlobalIPv6Address
string or null

Глобальный адрес IPv6 сети "bridge" по умолчанию.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

GlobalIPv6PrefixLen
integer or null <int64>

Длина маски глобального адреса IPv6.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

HairpinMode
boolean or null

Показывает, следует ли включить hairpin NAT на виртуальном интерфейсе. Устарело: поле никогда не задаётся и будет удалено в будущем выпуске.

IPAddress
string or null

Адрес IPv4 сети "bridge" по умолчанию.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

IPPrefixLen
integer or null <int64>

Длина маски адреса IPv4.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

IPv6Gateway
string or null

Адрес шлюза IPv6 этой сети.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

LinkLocalIPv6Address
string or null

Одноадресный адрес IPv6 с префиксом локального канала. Устарело: поле никогда не задаётся и будет удалено в будущем выпуске.

LinkLocalIPv6PrefixLen
integer or null <int64>

Длина префикса одноадресного адреса IPv6. Устарело: поле никогда не задаётся и будет удалено в будущем выпуске.

MacAddress
string or null

MAC-адрес контейнера в сети "bridge" по умолчанию.


> Устарело: поле передаётся только при подключении к сети "bridge" по умолчанию. Вместо него используйте сведения о сети "bridge" в отображении Networks, содержащем те же данные. Поле устарело в Docker 1.9; удаление запланировано в Docker 17.12.0.

object or null

Сведения обо всех сетях, к которым подключён контейнер.

additional property
object (EndpointSettings)

Конфигурация конечной точки сети.

null or HashMap (object)
One of
null
SandboxID
string or null

SandboxID однозначно обозначает сетевой стек контейнера.

SandboxKey
string or null

SandboxKey — полный путь дескриптора netns.

Массив objects or null (Address)

Устарело: это поле никогда не задаётся и будет удалено в будущем выпуске.

Array
Addr
string or null

IP-адрес.

PrefixLen
integer or null <int64>

Длина маски IP-адреса.

Массив objects or null (Address)

Устарело: это поле никогда не задаётся и будет удалено в будущем выпуске.

Array
Addr
string or null

IP-адрес.

PrefixLen
integer or null <int64>

Длина маски IP-адреса.

{
  • "Bridge": "string",
  • "SandboxID": "string",
  • "HairpinMode": true,
  • "LinkLocalIPv6Address": "string",
  • "LinkLocalIPv6PrefixLen": 0,
  • "Ports": { },
  • "SandboxKey": "string",
  • "SecondaryIPAddresses": [
    ],
  • "SecondaryIPv6Addresses": [
    ],
  • "EndpointID": "string",
  • "Gateway": "string",
  • "GlobalIPv6Address": "string",
  • "GlobalIPv6PrefixLen": 0,
  • "IPAddress": "string",
  • "IPPrefixLen": 0,
  • "IPv6Gateway": "string",
  • "MacAddress": "string",
  • "Networks": {
    }
}

NetworkStats

rx_bytes
required
integer <int64> >= 0
rx_dropped
required
integer <int64> >= 0
rx_errors
required
integer <int64> >= 0
rx_packets
required
integer <int64> >= 0
tx_bytes
required
integer <int64> >= 0
tx_dropped
required
integer <int64> >= 0
tx_errors
required
integer <int64> >= 0
tx_packets
required
integer <int64> >= 0
{
  • "rx_dropped": 0,
  • "rx_bytes": 0,
  • "rx_errors": 0,
  • "tx_packets": 0,
  • "tx_dropped": 0,
  • "rx_packets": 0,
  • "tx_errors": 0,
  • "tx_bytes": 0
}

NetworkingConfig_String

required
object
additional property
object (EndpointSettings)

Конфигурация конечной точки сети.

{
  • "EndpointsConfig": {
    }
}

NginxDuration

string (NginxDuration)

Проверенное значение времени ожидания nginx, например 900s или 5m.

"string"

NginxSize

string (NginxSize)

Проверенное значение размера nginx, например 0, 10m или 2g.

"string"

Node

CreatedAt
required
string <date-time>

Дата создания.

Endpoint
required
string

Конечная точка для подключения к узлу.

Metadata
any

Метаданные, заданные пользователем.

Name
required
string

Имя узла.

Version
required
string

Версия узла.

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Endpoint": "string",
  • "Version": "string",
  • "Metadata": null
}

NodeConstraint

Key
required
string

Ключ ограничения, например "region", "label" или "group".

Operator
required
string (ConstraintOp)
Допустимые значения: "Eq" "Ne"

Оператор ограничения (Eq/Ne).

Value
required
string

Значение ограничения.

{
  • "Key": "string",
  • "Operator": "Eq",
  • "Value": "string"
}

ObjPsHealthStatusKind

string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
"healthy"

ObjPsStatus

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Wanted": "create",
  • "PrevWanted": "create",
  • "Actual": "create",
  • "PrevActual": "create",
  • "Health": "healthy"
}

ObjPsStatusKind

string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
"create"

ObjectVersion

Index
integer or null <int64> >= 0
{
  • "Index": 0
}

PeerNode

Addr
string or null

IP-адрес и порты, по которым доступен узел.

NodeID
string or null

Уникальный идентификатор узла в swarm.

{
  • "NodeID": "string",
  • "Addr": "string"
}

PidsStats

current
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
{
  • "current": 0,
  • "limit": 0
}

PluginsInfo

Authorization
Массив strings or null

Имена доступных плагинов авторизации.

Log
Массив strings or null

Имена доступных драйверов и плагинов журналирования.

Network
Массив strings or null

Имена доступных драйверов и плагинов сети.

Volume
Массив strings or null

Имена доступных драйверов томов и плагинов сети.

{
  • "Volume": [
    ],
  • "Network": [
    ],
  • "Authorization": [
    ],
  • "Log": [
    ]
}

Primitive

One of
string
true

Process

CreatedAt
required
string <date-time>

Дата создания.

required
object (ContainerInspectResponse)

Данные процесса: ContainerInspect.

AppArmorProfile
string or null
Args
Массив strings or null

Аргументы выполняемой команды.

null or ContainerConfig (object)
Created
string or null

Время создания контейнера.

Driver
string or null
ExecIDs
Массив strings or null

Идентификаторы экземпляров exec, работающих в контейнере.

null or GraphDriverData (object)
null or HostConfig (object)
HostnamePath
string or null
HostsPath
string or null
Id
string or null

Идентификатор контейнера.

Image
string or null

Идентификатор образа контейнера.

LogPath
string or null
MountLabel
string or null
Массив objects or null (MountPoint)
Name
string or null
null or NetworkSettings (object)
Path
string or null

Путь выполняемой команды.

Platform
string or null
ProcessLabel
string or null
ResolvConfPath
string or null
RestartCount
integer or null <int64>
SizeRootFs
integer or null <int64>

Общий размер всех файлов контейнера.

SizeRw
integer or null <int64>

Размер файлов, созданных или изменённых контейнером.

null or ContainerState (object)
IpAddress
string or null

Фактический IP-адрес, полученный из последнего наблюдаемого состояния процесса.

Key
required
string

Ключ процесса.

Kind
required
string (ProcessKind)
Допустимые значения: "vm" "job" "cargo"

Тип процесса (Job, Vm, Cargo).

KindKey
required
string

Канонический ключ ресурса для Cargo и VM; задания используют своё имя.

Name
required
string

Имя процесса.

NodeName
required
string

Имя узла, на котором работает контейнер.

UpdatedAt
required
string <date-time>

Время последнего обновления экземпляра.

{
  • "Key": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "Kind": "vm",
  • "NodeName": "string",
  • "KindKey": "string",
  • "IpAddress": "string",
  • "Data": {
    }
}

ProcessExecCreateOptions

AttachStderr
boolean or null

Подключиться к стандартному потоку ошибок.

AttachStdin
boolean or null

Подключиться к стандартному вводу.

AttachStdout
boolean or null

Подключиться к стандартному выводу.

Cmd
Массив strings or null

Команда и аргументы для выполнения.

DetachKeys
string or null

Последовательность клавиш отключения, совместимая с Docker.

Env
Массив strings or null

Переменные окружения в формате NAME=value.

Privileged
boolean or null

Выполнить команду с расширенными привилегиями.

Tty
boolean or null

Выделить псевдо-TTY.

User
string or null

Пользователь и необязательная группа для команды.

WorkingDir
string or null

Рабочий каталог внутри процесса.

{
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "Tty": true,
  • "DetachKeys": "string",
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Privileged": true,
  • "User": "string",
  • "WorkingDir": "string"
}

ProcessExecCreated

Id
required
string

Идентификатор экземпляра exec, принадлежащего Docker.

{
  • "Id": "string"
}

ProcessKillOptions

signal
required
string

Сигнал процессу; по умолчанию SIGKILL.

{
  • "signal": "string"
}

ProcessKind

string (ProcessKind)
Допустимые значения: "vm" "job" "cargo"

Тип процесса (Vm, Job, Cargo).

"vm"

ProcessStats

Name
required
string
required
object (Stats)

Статистика контейнера.

required
object (BlkioStats)

Статистика ввода-вывода контейнера.

required
object (CPUStats)

Общая статистика CPU контейнера.

id
string
required
object (MemoryStats)

Общая статистика памяти контейнера.

name
string
null or NetworkStats (object)
object or null
num_procs
required
integer <int32> >= 0
required
object (PidsStats)

Статистика идентификаторов процессов контейнера.

required
object (CPUStats)

Общая статистика CPU контейнера.

preread
required
string
read
required
string
required
object (StorageStats)

Статистика файлового ввода-вывода контейнера.

{
  • "Name": "string",
  • "Stats": {
    }
}

ProxyCache

string (ProxyCache)

Проверенное значение кэша прокси nginx: off или настроенная зона кэша.

"string"

ProxyHttp3

One of
boolean

Включает HTTP/3 с настройками по умолчанию.

Example
true

ProxyHttp3Config

ActiveConnectionIdLimit
integer or null >= 0

Параметр транспорта QUIC active_connection_id_limit.

Bpf
boolean or null

Включить маршрутизацию пакетов QUIC с помощью eBPF; Linux 5.7 и новее.

Gso
boolean or null

Включить Generic Segmentation Offload для QUIC; Linux с UDP_SEGMENT.

HostKey
string or null

Путь к файлу ключа хоста QUIC.

Hq
boolean or null

Включает согласование протокола HTTP/0.9, используемое в тестах совместимости QUIC.

MaxConcurrentStreams
integer or null >= 0

Максимальное число одновременных потоков HTTP/3 на соединение.

Retry
boolean or null

Включить проверку адреса QUIC (retry).

StreamBufferSize
string or null

Размер буфера потоков QUIC, например "64k" или "8k".

{
  • "Hq": true,
  • "MaxConcurrentStreams": 0,
  • "StreamBufferSize": "string",
  • "ActiveConnectionIdLimit": 0,
  • "Bpf": true,
  • "Gso": true,
  • "HostKey": "string",
  • "Retry": true
}

ProxyHttpLocation

AllowedIps
Массив strings or null

Разрешённый IP-адрес.

null or ProxyCache (string)
One of
null
null or NginxDuration (string)
One of
null
null or NginxSize (string)
One of
null
null or NginxDuration (string)
One of
null
Headers
Массив strings or null

Дополнительные заголовки.

InterceptErrors
boolean or null

Перехватывать ошибки вышестоящего сервера.

null or LimitReq (object)
One of
null
null or ProxyNextUpstream (string)
One of
null
Path
required
string

Путь.

null or NginxDuration (string)
One of
null
RequestBuffering
boolean or null

Буферизовать тела клиентских запросов.

ResponseBuffering
boolean or null

Буферизовать ответы вышестоящего сервера.

null or NginxDuration (string)
One of
null
required
object or object or object (LocationTarget)
One of
DisableLogging
boolean or null

Отключить журналирование для этой цели.

Key
required
string

Ключ целевого Cargo или VM.

Path
string or null

Целевой путь HTTP при использовании HTTP.

Port
required
integer <int32> >= 0

Порт целевого Cargo или VM.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
Version
number or null <double>

Используемая версия HTTP.

{
  • "Path": "string",
  • "Target": {
    },
  • "LimitReq": { },
  • "AllowedIps": [
    ],
  • "Headers": [
    ],
  • "Version": 0,
  • "ClientMaxBodySize": { },
  • "ClientBodyTimeout": { },
  • "RequestBuffering": true,
  • "ResponseBuffering": true,
  • "Cache": { },
  • "ReadTimeout": { },
  • "SendTimeout": { },
  • "ConnectTimeout": { },
  • "NextUpstream": { },
  • "InterceptErrors": true
}

ProxyNextUpstream

string (ProxyNextUpstream)
Значение: "off"

Поддерживаемые значения proxy_next_upstream на уровне location.

"off"

ProxyRule

One of
Domain
string or null

Домен.

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
One of
null
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
One of
null
Includes
Массив strings or null

Путь к дополнительному файлу конфигурации для включения.

null or LimitReqZone (object)
One of
null
required
Массив objects (ProxyHttpLocation)

Locations для обработки нескольких путей.

Array
AllowedIps
Массив strings or null

Разрешённый IP-адрес.

null or ProxyCache (string)
null or NginxDuration (string)
null or NginxSize (string)
null or NginxDuration (string)
Headers
Массив strings or null

Дополнительные заголовки.

InterceptErrors
boolean or null

Перехватывать ошибки вышестоящего сервера.

null or LimitReq (object)
null or ProxyNextUpstream (string)
Path
required
string

Путь.

null or NginxDuration (string)
RequestBuffering
boolean or null

Буферизовать тела клиентских запросов.

ResponseBuffering
boolean or null

Буферизовать ответы вышестоящего сервера.

null or NginxDuration (string)
required
object or object or object (LocationTarget)
Version
number or null <double>

Используемая версия HTTP.

required
string or object or object (NetworkKind)
One of
string

Тип сетевой привязки.

Port
integer or null <int32> >= 0

Порт для прослушивания; по умолчанию 80 или 443.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
Example
{
  • "Domain": "string",
  • "Port": 0,
  • "Hsts": { },
  • "Network": "string",
  • "LimitReqZone": { },
  • "Locations": [
    ],
  • "Ssl": { },
  • "Http3": { },
  • "Includes": [
    ]
}

ProxyRuleHttp

Domain
string or null

Домен.

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
One of
null
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
One of
null
Includes
Массив strings or null

Путь к дополнительному файлу конфигурации для включения.

null or LimitReqZone (object)
One of
null
required
Массив objects (ProxyHttpLocation)

Locations для обработки нескольких путей.

Array
AllowedIps
Массив strings or null

Разрешённый IP-адрес.

null or ProxyCache (string)
null or NginxDuration (string)
null or NginxSize (string)
null or NginxDuration (string)
Headers
Массив strings or null

Дополнительные заголовки.

InterceptErrors
boolean or null

Перехватывать ошибки вышестоящего сервера.

null or LimitReq (object)
null or ProxyNextUpstream (string)
Path
required
string

Путь.

null or NginxDuration (string)
RequestBuffering
boolean or null

Буферизовать тела клиентских запросов.

ResponseBuffering
boolean or null

Буферизовать ответы вышестоящего сервера.

null or NginxDuration (string)
required
object or object or object (LocationTarget)
Version
number or null <double>

Используемая версия HTTP.

required
string or object or object (NetworkKind)
One of
string

Тип сетевой привязки.

Port
integer or null <int32> >= 0

Порт для прослушивания; по умолчанию 80 или 443.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
{
  • "Domain": "string",
  • "Port": 0,
  • "Hsts": { },
  • "Network": "string",
  • "LimitReqZone": { },
  • "Locations": [
    ],
  • "Ssl": { },
  • "Http3": { },
  • "Includes": [
    ]
}

ProxyRuleStream

required
string or object or object (NetworkKind)
One of
string

Тип сетевой привязки.

Port
required
integer <int32> >= 0

Порт, открываемый на узлах.

Protocol
required
string (ProxyStreamProtocol)
Допустимые значения: "Tcp" "Udp"

Используемый протокол: Tcp или Udp.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
required
object or object or object (StreamTarget)
One of
DisableLogging
boolean or null

Отключить журналирование для этой цели.

Key
required
string

Ключ целевого Cargo или VM.

Path
string or null

Целевой путь HTTP при использовании HTTP.

Port
required
integer <int32> >= 0

Порт целевого Cargo или VM.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
{
  • "Network": "string",
  • "Protocol": "Tcp",
  • "Port": 0,
  • "Ssl": { },
  • "Target": {
    }
}

ProxySsl

One of
Certificate
required
string

Содержимое сертификата, сохранённого в секрете TLS.

CertificateClient
string or null

Содержимое сертификата центра сертификации, сохранённого в секрете TLS.

CertificateKey
required
string

Содержимое закрытого ключа, сохранённого в секрете TLS.

Dhparam
string or null

Содержимое параметров DH, сохранённых в секрете TLS.

VerifyClient
boolean or null

Включить или отключить проверку клиента.

Example
{
  • "Certificate": "string",
  • "CertificateKey": "string",
  • "CertificateClient": "string",
  • "VerifyClient": true,
  • "Dhparam": "string"
}

ProxySslConfig

Certificate
required
string

Содержимое сертификата, сохранённого в секрете TLS.

CertificateClient
string or null

Содержимое сертификата центра сертификации, сохранённого в секрете TLS.

CertificateKey
required
string

Содержимое закрытого ключа, сохранённого в секрете TLS.

Dhparam
string or null

Содержимое параметров DH, сохранённых в секрете TLS.

VerifyClient
boolean or null

Включить или отключить проверку клиента.

{
  • "Certificate": "string",
  • "CertificateKey": "string",
  • "CertificateClient": "string",
  • "VerifyClient": true,
  • "Dhparam": "string"
}

ProxyStreamProtocol

string (ProxyStreamProtocol)
Допустимые значения: "Tcp" "Udp"

Режимы правил прокси.

"Tcp"

RegistryServiceConfig

AllowNondistributableArtifactsCIDRs
Массив strings or null

Список диапазонов IP, в которые можно отправлять нераспространяемые артефакты, в формате CIDR RFC 4632. Некоторые образы, например базовые образы Windows, содержат артефакты, распространение которых ограничено лицензией. При отправке образа в реестр такие артефакты обычно не включаются. Эта конфигурация меняет поведение и позволяет демону отправлять их во все реестры, чьи IP-адреса, полученные при разрешении имён, входят в указанную подсеть CIDR. Параметр полезен для реестра в изолированной сети: хосты могут загрузить образы, не подключаясь к другому серверу. > Предупреждение: для нераспространяемых артефактов обычно ограничены способы и места распространения и совместного использования. Применяйте функцию только для частных реестров и соблюдайте все условия, регулирующие повторное распространение таких артефактов.

AllowNondistributableArtifactsHostnames
Массив strings or null

Список имён хостов реестров, в которые можно отправлять нераспространяемые артефакты, в формате <hostname>[:<port>] или <IP address>[:<port>]. Некоторые образы, например базовые образы Windows, содержат артефакты, распространение которых ограничено лицензией. При отправке образа в реестр такие артефакты обычно не включаются. Эта конфигурация меняет поведение для указанных реестров. Параметр полезен для реестра в изолированной сети: хосты могут загрузить образы, не подключаясь к другому серверу. > Предупреждение: для нераспространяемых артефактов обычно ограничены способы и места распространения и совместного использования. Применяйте функцию только для частных реестров и соблюдайте все условия, регулирующие повторное распространение таких артефактов.

object or null
additional property
object (IndexInfo)

IndexInfo содержит сведения о реестре.

InsecureRegistryCIDRs
Массив strings or null

Список диапазонов IP небезопасных реестров в формате CIDR (RFC 4632). Такие реестры допускают незашифрованные соединения HTTP и/или недоверенные соединения HTTPS с сертификатами неизвестных центров сертификации. По умолчанию локальные реестры (127.0.0.0/8) считаются небезопасными, а все остальные — безопасными. Если демон считает реестр безопасным, соединение с небезопасным реестром невозможно. Эта конфигурация изменяет поведение и разрешает небезопасные соединения с реестрами, чьи IP-адреса, полученные при разрешении имён, входят в указанную подсеть CIDR. Реестр также можно объявить небезопасным по имени хоста. Такие реестры перечислены в IndexConfigs, а их поле Secure имеет значение false. > Предупреждение: параметр полезен при локальном запуске реестра, но создаёт уязвимости. Используйте его ТОЛЬКО для тестирования. Для большей безопасности добавьте свой центр сертификации в список доверенных центров системы вместо включения этого параметра.

Mirrors
Массив strings or null

Список URL реестров, служащих зеркалами официального реестра (docker.io).

{
  • "AllowNondistributableArtifactsCIDRs": [
    ],
  • "AllowNondistributableArtifactsHostnames": [
    ],
  • "InsecureRegistryCIDRs": [
    ],
  • "IndexConfigs": {
    },
  • "Mirrors": [
    ]
}

Resource

CreatedAt
required
string <date-time>

Дата создания ресурса.

Kind
required
string

Тип ресурса.

required
object (ResourceSpec)

Спецификация ресурса.

CreatedAt
required
string <date-time>

Дата создания ресурса.

required
object

Данные ресурса в виде объекта JSON.

Key
required
string <uuid>

Ключ ресурса.

object

Метаданные ресурса, заданные пользователем.

ResourceKey
required
string

Ключ ресурса, связанного с данными.

Version
required
string

Версия ресурса.

{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

ResourceDnsRule

required
Массив objects (DnsEntry)
Array
required
string or object or object (NetworkKind)
Name
required
string
required
string or object or object (NetworkKind)
One of
string

Селектор сетевой привязки.

{
  • "Network": "string",
  • "Entries": [
    ]
}

ResourceKind

CreatedAt
required
string <date-time>

Время создания типа.

required
object (ResourceKindSpec)

Время создания типа.

object

JSONSchema ресурса данного типа и версии.

Url
string or null

Служба, вызываемая при создании, обновлении или удалении ресурса данного типа и версии.

Metadata
any

Время создания типа.

Name
required
string

Имя типа.

Version
required
string

Время создания типа.

{
  • "Name": "string",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null,
  • "Data": {
    }
}

ResourceKindInspect

CreatedAt
required
string <date-time>

Время создания типа.

Name
required
string

Имя типа.

required
Массив objects (ResourceKindVersion)

Список доступных версий.

Array
CreatedAt
required
string <date-time>

Время создания версии.

required
object (ResourceKindSpec)

Спецификация типа.

Key
required
string <uuid>

Ключ версии.

KindKey
required
string

Тип, связанный с этой версией.

object

Метаданные, заданные пользователем.

Version
required
string

Версия.

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Versions": [
    ]
}

ResourceKindPartial

required
object (ResourceKindSpec)

Спецификация типа ресурса.

object

JSONSchema ресурса данного типа и версии.

Url
string or null

Служба, вызываемая при создании, обновлении или удалении ресурса данного типа и версии.

object

Метаданные типа ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя типа ресурса.

Version
required
string

Версия типа ресурса.

{
  • "Name": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

ResourceKindSpec

object

JSONSchema ресурса данного типа и версии.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Url
string or null

Служба, вызываемая при создании, обновлении или удалении ресурса данного типа и версии.

{
  • "Schema": {
    },
  • "Url": "string"
}

ResourceKindVersion

CreatedAt
required
string <date-time>

Время создания версии.

required
object (ResourceKindSpec)

Спецификация типа.

object

JSONSchema ресурса данного типа и версии.

Url
string or null

Служба, вызываемая при создании, обновлении или удалении ресурса данного типа и версии.

Key
required
string <uuid>

Ключ версии.

KindKey
required
string

Тип, связанный с этой версией.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Version
required
string

Версия.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "KindKey": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

ResourcePartial

required
object

Данные ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Kind
required
string

Тип ресурса.

object

Метаданные ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя ресурса.

{
  • "Name": "string",
  • "Kind": "string",
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourceProxyRule

required
Массив ProxyRuleHttp (object) or ProxyRuleStream (object) (ProxyRule)

Применяемые правила.

Array
One of
Domain
string or null

Домен.

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
Includes
Массив strings or null

Путь к дополнительному файлу конфигурации для включения.

null or LimitReqZone (object)
required
Массив objects (ProxyHttpLocation)

Locations для обработки нескольких путей.

required
string or object or object (NetworkKind)
Port
integer or null <int32> >= 0

Порт для прослушивания; по умолчанию 80 или 443.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
{
  • "Rules": [
    ]
}

ResourceSpec

CreatedAt
required
string <date-time>

Дата создания ресурса.

required
object

Данные ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Key
required
string <uuid>

Ключ ресурса.

object

Метаданные ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

ResourceKey
required
string

Ключ ресурса, связанного с данными.

Version
required
string

Версия ресурса.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ResourceKey": "string",
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourceUpdate

required
object

Спецификация ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

object

Метаданные ресурса в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

{
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourcesBlkioWeightDevice

Path
string or null
Weight
integer or null >= 0
{
  • "Path": "string",
  • "Weight": 0
}

ResourcesUlimits

Hard
integer or null <int64>

Жёсткое ограничение.

Name
string or null

Имя ulimit.

Soft
integer or null <int64>

Мягкое ограничение.

{
  • "Name": "string",
  • "Soft": 0,
  • "Hard": 0
}

RestartPolicy

MaximumRetryCount
integer or null <int64>

Если используется on-failure, число повторных попыток до отказа.

null or RestartPolicyNameEnum (string)
One of
null
{
  • "Name": { },
  • "MaximumRetryCount": 0
}

RestartPolicyNameEnum

string (RestartPolicyNameEnum)
Допустимые значения: "EMPTY" "no" "always" "unless-stopped" "on-failure"
"EMPTY"

Runtime

path
string or null

Имя и необязательный путь исполняемого файла OCI. Если путь отсутствует, демон ищет файл в $PATH хоста и использует первый результат.

runtimeArgs
Массив strings or null

Список аргументов командной строки, передаваемых среде выполнения при вызове.

object or null

Сведения среды выполнения. Эта спецификация API не определяет данные сред выполнения, но они могут предоставлять следующие известные свойства: org.opencontainers.runtime-spec.features — структура возможностей из спецификации OCI Runtime, представленная строкой JSON.


> Примечание: сведения в этом поле, включая формат значений и меток, не следует считать стабильными; они могут измениться без уведомления.

property name*
additional property
string
{
  • "path": "string",
  • "runtimeArgs": [
    ],
  • "status": {
    }
}

Secret

CreatedAt
required
string <date-time>

Дата создания.

required
object

Данные секрета.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Immutable
required
boolean

Секрет нельзя обновить.

Kind
required
string

Тип секрета.

object
additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя секрета.

UpdatedAt
required
string <date-time>

Дата последнего обновления.

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

SecretEnv

Array
string
[
  • "string"
]

SecretPartial

required
object

Данные секрета.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Immutable
boolean

Секрет нельзя обновить.

Kind
required
string

Тип секрета.

object

Метаданные ресурса, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя секрета.

{
  • "Name": "string",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

SecretUpdate

required
object

Данные секрета в виде объекта JSON.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

object

Метаданные секрета, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

{
  • "Metadata": {
    },
  • "Data": {
    }
}

SslConfig

Cert
string or null

Содержимое сертификата.

CertCa
string or null

Содержимое сертификата центра сертификации.

CertKey
string or null

Содержимое ключа сертификата.

Password
string or null

Пароль сертификата, если есть.

Verify
required
boolean

Проверять центр сертификации.

{
  • "Cert": "string",
  • "CertKey": "string",
  • "CertCa": "string",
  • "Verify": true,
  • "Password": "string"
}

StartNodeCargoParams

CargoKey
required
string

Канонический ключ Cargo в формате {namespace}.{name}.

required
Массив objects (CargoReplicaTask)

Точные устойчивые реплики, назначенные этому узлу и упорядоченные по порядковому номеру.

Array
Key
required
string <uuid>

Сохранённая устойчивая идентичность реплики Cargo.

Ordinal
required
integer <int32>

Устойчивый порядковый номер реплики, уникальный в пределах Cargo.

{
  • "CargoKey": "string",
  • "Replicas": [
    ]
}

Statefile

ApiVersion
required
string

Используемая версия API или удалённый URL.

Массив objects or null (StatefileArg)

Аргументы, передаваемые в Statefile.

Array
null or (StatefileArgsValue (StatefileArgsValue (number) or StatefileArgsValue (string) or StatefileArgsValue (boolean) or Массив StatefileArgsValue (numbers) or Массив StatefileArgsValue (strings)))
Description
string or null

Краткое описание аргумента.

Example
string or null

Пример значения аргумента.

Kind
required
string (StatefileArgKind)
Допустимые значения: "String" "Number" "Boolean"

Тип аргумента сборки.

Multiple
boolean

Аргумент допускает несколько значений.

Name
required
string

Имя аргумента сборки.

Required
boolean

Обязательный аргумент.

Массив objects or null (CargoSpec)

Список Cargo для создания и запуска.

Array
required
Массив objects (ContainerSpec)

Контейнеры приложения в каждой реплике Cargo.

Dns
Массив strings or null

DNS-серверы, назначенные владельцу сети Cargo.

Hostname
string or null

Имя хоста Docker, назначенное владельцу сети Cargo.

Массив objects (ContainerSpec)

Контейнеры инициализации, выполняемые в порядке объявления перед контейнерами приложения.

object

Метаданные Cargo, заданные пользователем.

Name
required
string

Имя Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
По умолчанию: 1

Число устойчивых реплик Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Массив strings

Секреты, наследуемые всеми обычными контейнерами и контейнерами инициализации.

Group
string or null

Задать группу определённых объектов; по умолчанию {name_of_directory}.{name_of_file}.

Массив objects or null (JobPartial)

Список заданий для создания и запуска.

Array
required
Массив objects (Config)

Список запускаемых контейнеров.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Секрет для загрузки образа.

object

Метаданные, заданные пользователем.

Name
required
string

Имя задания.

Schedule
string or null

Выражение cron с пятью полями или поддерживаемое сокращение; см. [crate::cron::validate_schedule].

Secrets
Массив strings or null

Секреты, загружаемые как переменные окружения.

Ttl
integer or null >= 0

Удалить задание через (x) секунд после выполнения.

null or StatefileMetadata (object)
One of
null
Namespace
string or null

Пространство имён, в котором развёрнуты Cargo и виртуальные машины.

Массив objects or null (ResourcePartial)

Список создаваемых ресурсов.

Array
required
object

Данные ресурса в виде объекта JSON.

Kind
required
string

Тип ресурса.

object

Метаданные ресурса, заданные пользователем.

Name
required
string

Имя ресурса.

Массив objects or null (SecretPartial)

Список создаваемых секретов.

Array
required
object

Данные секрета.

Immutable
boolean

Секрет нельзя обновить.

Kind
required
string

Тип секрета.

object

Метаданные ресурса, заданные пользователем.

Name
required
string

Имя секрета.

Массив strings or SubStateDef (object) or null (SubState)

Включить вложенные состояния, применяемые перед текущим состоянием.

Array
One of
string
Массив objects or null (VmSpecPartial)

Список виртуальных машин для создания и запуска.

Array
null or VmHostConfig (object)
Hostname
string or null

Имя хоста VM; по умолчанию создаётся из имени.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес VM; по умолчанию создаётся автоматически.

object

Метаданные, заданные пользователем.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию: cloud.

SshKey
string or null

Открытый ключ SSH пользователя по умолчанию; рекомендуется.

User
string or null

Пользователь VM по умолчанию: cloud.

{
  • "ApiVersion": "string",
  • "Metadata": { },
  • "Args": [
    ],
  • "SubStates": [
    ],
  • "Group": "string",
  • "Namespace": "string",
  • "Secrets": [
    ],
  • "Resources": [
    ],
  • "Cargoes": [
    ],
  • "VirtualMachines": [
    ],
  • "Jobs": [
    ]
}

StatefileArg

null or (StatefileArgsValue (StatefileArgsValue (number) or StatefileArgsValue (string) or StatefileArgsValue (boolean) or Массив StatefileArgsValue (numbers) or Массив StatefileArgsValue (strings)))
One of
null
Description
string or null

Краткое описание аргумента.

Example
string or null

Пример значения аргумента.

Kind
required
string (StatefileArgKind)
Допустимые значения: "String" "Number" "Boolean"

Тип аргумента сборки.

Multiple
boolean

Аргумент допускает несколько значений.

Name
required
string

Имя аргумента сборки.

Required
boolean

Обязательный аргумент.

{
  • "Name": "string",
  • "Kind": "String",
  • "Default": { },
  • "Required": true,
  • "Multiple": true,
  • "Description": "string",
  • "Example": "string"
}

StatefileArgKind

string (StatefileArgKind)
Допустимые значения: "String" "Number" "Boolean"

Определение аргумента, передаваемого в Statefile.

"String"

StatefileArgsValue

One of
number <double>

Определение аргумента, передаваемого в Statefile.

[ ]

StatefileMetadata

About
string or null

Сведения о Statefile, используемые в разделе name.

LongAbout
string or null

Подробное описание Statefile, используемое в разделе description.

ManContent
string or null

Переопределить содержимое страницы руководства этого Statefile.

Name
string or null

Необязательный заголовок документации Statefile.

Tags
Массив strings or null

Необязательные теги этого Statefile.

{
  • "Name": "string",
  • "About": "string",
  • "LongAbout": "string",
  • "Tags": [
    ],
  • "ManContent": "string"
}

Stats

required
object (BlkioStats)

Статистика ввода-вывода контейнера.

Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
Массив objects or null (BlkioStatsEntry)
required
object (CPUStats)

Общая статистика CPU контейнера.

required
object (CPUUsage)

Статистика использования CPU контейнером.

online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

Статистика ограничения CPU.

id
string
required
object (MemoryStats)

Общая статистика памяти контейнера.

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
null or (MemoryStatsStats (MemoryStatsStatsV1 (object) or MemoryStatsStatsV2 (object)))
usage
integer or null <int64> >= 0
name
string
null or NetworkStats (object)
One of
null
object or null
additional property
object (NetworkStats)

Статистика сети контейнера.

num_procs
required
integer <int32> >= 0
required
object (PidsStats)

Статистика идентификаторов процессов контейнера.

current
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
required
object (CPUStats)

Общая статистика CPU контейнера.

required
object (CPUUsage)

Статистика использования CPU контейнером.

online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

Статистика ограничения CPU.

preread
required
string
read
required
string
required
object (StorageStats)

Статистика файлового ввода-вывода контейнера.

read_count_normalized
integer or null <int64> >= 0
read_size_bytes
integer or null <int64> >= 0
write_count_normalized
integer or null <int64> >= 0
write_size_bytes
integer or null <int64> >= 0
{
  • "read": "string",
  • "preread": "string",
  • "num_procs": 0,
  • "pids_stats": {
    },
  • "network": { },
  • "networks": {
    },
  • "memory_stats": {
    },
  • "blkio_stats": {
    },
  • "cpu_stats": {
    },
  • "precpu_stats": {
    },
  • "storage_stats": {
    },
  • "name": "string",
  • "id": "string"
}

StorageStats

read_count_normalized
integer or null <int64> >= 0
read_size_bytes
integer or null <int64> >= 0
write_count_normalized
integer or null <int64> >= 0
write_size_bytes
integer or null <int64> >= 0
{
  • "read_count_normalized": 0,
  • "read_size_bytes": 0,
  • "write_count_normalized": 0,
  • "write_size_bytes": 0
}

StreamTarget

One of
DisableLogging
boolean or null

Отключить журналирование для этой цели.

Key
required
string

Ключ целевого Cargo или VM.

Path
string or null

Целевой путь HTTP при использовании HTTP.

Port
required
integer <int32> >= 0

Порт целевого Cargo или VM.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
Example
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true,
  • "Ssl": { }
}

String

string (String)
"string"

SubState

One of
string
Example
"string"

SubStateArg

Name
required
string

Имя аргумента.

required
number or string or boolean or Массив numbers or Массив strings (StatefileArgsValue)
One of
number <double>

Значение аргумента.

{
  • "Name": "string",
  • "Value": 0.1
}

SubStateDef

Массив objects or null (SubStateArg)
Array
Name
required
string

Имя аргумента.

required
number or string or boolean or Массив numbers or Массив strings (StatefileArgsValue)
Path
required
string
{
  • "Path": "string",
  • "Args": [
    ]
}

SwarmInfo

null or ClusterInfo (object)
One of
null
ControlAvailable
boolean or null
Error
string or null
null or LocalNodeState (string)
One of
null
Managers
integer or null <int64>

Общее число управляющих узлов swarm.

NodeAddr
string or null

IP-адрес, по которому другие узлы swarm могут обратиться к этому узлу.

NodeID
string or null

Уникальный идентификатор узла в swarm.

Nodes
integer or null <int64>

Общее число узлов swarm.

Массив objects or null (PeerNode)

Список идентификаторов и адресов других управляющих узлов swarm.

Array
Addr
string or null

IP-адрес и порты, по которым доступен узел.

NodeID
string or null

Уникальный идентификатор узла в swarm.

{
  • "NodeID": "string",
  • "NodeAddr": "string",
  • "LocalNodeState": { },
  • "ControlAvailable": true,
  • "Error": "string",
  • "RemoteManagers": [
    ],
  • "Nodes": 0,
  • "Managers": 0,
  • "Cluster": { }
}

SwarmSpec

null or SwarmSpecCaConfig (object)
One of
null
null or SwarmSpecDispatcher (object)
One of
null
null or SwarmSpecEncryptionConfig (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
Name
string or null

Имя swarm.

null or SwarmSpecOrchestration (object)
One of
null
null or SwarmSpecRaft (object)
One of
null
null or SwarmSpecTaskDefaults (object)
One of
null
{
  • "Name": "string",
  • "Labels": {
    },
  • "Orchestration": { },
  • "Raft": { },
  • "Dispatcher": { },
  • "CAConfig": { },
  • "EncryptionConfig": { },
  • "TaskDefaults": { }
}

SwarmSpecCaConfig

Массив objects or null (SwarmSpecCaConfigExternalCas)

Конфигурация передачи запросов подписи внешнему центру сертификации.

Array
CACert
string or null

Корневой сертификат центра сертификации в формате PEM, используемый этим внешним центром для выдачи сертификатов TLS. Если не задан, предполагается текущий корневой сертификат swarm.

object or null

Объект с парами ключ/значение, которые драйвер внешнего центра сертификации интерпретирует как параметры протокола.

null or SwarmSpecCaConfigExternalCasProtocolEnum (string)
URL
string or null

URL для отправки запросов подписи сертификатов.

ForceRotate
integer or null <int64> >= 0

Целое число, заставляющее swarm создать новый сертификат и ключ подписывающего центра сертификации, если они не заданы в SigningCACert и SigningCAKey.

NodeCertExpiry
integer or null <int64>

Срок действия выдаваемых сертификатов узлов.

SigningCACert
string or null

Желаемый сертификат подписывающего центра сертификации для всех конечных сертификатов TLS узлов swarm, в формате PEM.

SigningCAKey
string or null

Желаемый ключ подписывающего центра сертификации для всех конечных сертификатов TLS узлов swarm, в формате PEM.

{
  • "NodeCertExpiry": 0,
  • "ExternalCAs": [
    ],
  • "SigningCACert": "string",
  • "SigningCAKey": "string",
  • "ForceRotate": 0
}

SwarmSpecCaConfigExternalCas

CACert
string or null

Корневой сертификат центра сертификации в формате PEM, используемый этим внешним центром для выдачи сертификатов TLS. Если не задан, предполагается текущий корневой сертификат swarm.

object or null

Объект с парами ключ/значение, которые драйвер внешнего центра сертификации интерпретирует как параметры протокола.

property name*
additional property
string
null or SwarmSpecCaConfigExternalCasProtocolEnum (string)
One of
null
URL
string or null

URL для отправки запросов подписи сертификатов.

{
  • "Protocol": { },
  • "URL": "string",
  • "Options": {
    },
  • "CACert": "string"
}

SwarmSpecCaConfigExternalCasProtocolEnum

string (SwarmSpecCaConfigExternalCasProtocolEnum)
Допустимые значения: "EMPTY" "cfssl"
"EMPTY"

SwarmSpecDispatcher

HeartbeatPeriod
integer or null <int64>

Интервал отправки агентом сигнала присутствия диспетчеру.

{
  • "HeartbeatPeriod": 0
}

SwarmSpecEncryptionConfig

AutoLockManagers
boolean or null

Если задано, создать ключ и использовать его для блокировки данных на управляющих узлах.

{
  • "AutoLockManagers": true
}

SwarmSpecOrchestration

TaskHistoryRetentionLimit
integer or null <int64>

Число исторических задач, сохраняемых для экземпляра или узла. При отрицательном значении завершённые или неудачные задачи никогда не удаляются.

{
  • "TaskHistoryRetentionLimit": 0
}

SwarmSpecRaft

ElectionTick
integer or null <int64>

Число тактов, в течение которых последователь ждёт сообщения лидера, прежде чем стать кандидатом и начать выборы. ElectionTick должно быть больше HeartbeatTick. Сейчас такт по умолчанию равен одной секунде, поэтому значения соответствуют секундам, но это НЕ гарантировано.

HeartbeatTick
integer or null <int64>

Число тактов между сигналами присутствия. Лидер отправляет сигнал последователям каждые HeartbeatTick тактов. Сейчас такт по умолчанию равен одной секунде, поэтому значения соответствуют секундам, но это НЕ гарантировано.

KeepOldSnapshots
integer or null <int64> >= 0

Число снимков, сохраняемых помимо текущего.

LogEntriesForSlowFollowers
integer or null <int64> >= 0

Число записей журнала, сохраняемых для синхронизации медленных последователей после создания снимка.

SnapshotInterval
integer or null <int64> >= 0

Число записей журнала между снимками.

{
  • "SnapshotInterval": 0,
  • "KeepOldSnapshots": 0,
  • "LogEntriesForSlowFollowers": 0,
  • "ElectionTick": 0,
  • "HeartbeatTick": 0
}

SwarmSpecTaskDefaults

null or SwarmSpecTaskDefaultsLogDriver (object)
One of
null
{
  • "LogDriver": { }
}

SwarmSpecTaskDefaultsLogDriver

Name
string or null

Драйвер журналирования по умолчанию для новых задач.

object or null

Параметры выбранного драйвера журналирования в виде пар ключ/значение.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

SystemInfo

Architecture
string or null

Аппаратная архитектура хоста, возвращаемая средой Go (GOARCH). Полный список значений приведён в документации Go.

BridgeNfIp6tables
boolean or null

Показывает, доступен ли bridge-nf-call-ip6tables на хосте.

BridgeNfIptables
boolean or null

Показывает, доступен ли bridge-nf-call-iptables на хосте.

CDISpecDirs
Массив strings or null

Список каталогов со спецификациями CDI (Container Device Interface). Они определяют изменения спецификации OCI создаваемого контейнера для конкретного поставщика. Пустой список означает, что внедрение устройств CDI отключено. Для него требуется экспериментальный режим демона. Неэкспериментальные демоны всегда возвращают пустой список.

null or SystemInfoCgroupDriverEnum (string)
One of
null
null or SystemInfoCgroupVersionEnum (string)
One of
null
null or Commit (object)
One of
null
Containers
integer or null <int64>

Общее число контейнеров на хосте.

ContainersPaused
integer or null <int64>

Число контейнеров со статусом \"paused\".

ContainersRunning
integer or null <int64>

Число контейнеров со статусом \"running\".

ContainersStopped
integer or null <int64>

Число контейнеров со статусом \"stopped\".

CpuCfsPeriod
boolean or null

Показывает, поддерживает ли хост период CPU CFS (Completely Fair Scheduler).

CpuCfsQuota
boolean or null

Показывает, поддерживает ли хост квоту CPU CFS (Completely Fair Scheduler).

CPUSet
boolean or null

Показывает, поддерживает ли хост CPUsets (cpuset.cpus, cpuset.mems). См. cpuset(7).

CPUShares
boolean or null

Показывает, поддерживает ли хост ограничение долей CPU.

Debug
boolean or null

Показывает, работает ли демон в режиме отладки с уровнем журналирования debug.

Массив objects or null (SystemInfoDefaultAddressPools)

Список пользовательских пулов адресов по умолчанию для локальных сетей, задаваемых в daemon.json или параметром dockerd. Например, Base "10.10.0.0/16" с Size 24 задаёт 256 пулов адресов 10.10.[0-255].0/24.

Array
Base
string or null

Адрес сети в формате CIDR.

Size
integer or null <int64>

Размер пула сети.

DefaultRuntime
string or null

Имя среды выполнения OCI по умолчанию, используемой при запуске контейнеров. Его можно переопределить для конкретного контейнера при создании.

DockerRootDir
string or null

Корневой каталог постоянного состояния Docker. По умолчанию /var/lib/docker в Linux и C:\\ProgramData\\docker в Windows.

Driver
string or null

Имя используемого драйвера хранения.

DriverStatus
Массив strings or null[ items ]

Сведения драйвера хранения в виде пар "label" / "value". Драйвер предоставляет их в формате, согласованном с выводом docker info в командной строке.


> Примечание: сведения в этом поле, включая формат значений и меток, не следует считать стабильными; они могут измениться без уведомления.

ExperimentalBuild
boolean or null

Показывает, включены ли экспериментальные функции демона.

null or GenericResourcesInner (object)
One of
null
HttpProxy
string or null

HTTP-прокси демона. Значение берётся из переменной окружения HTTP_PROXY. Учётные данные в компоненте сведений о пользователе URL прокси маскируются в ответе API. Контейнеры не наследуют эту конфигурацию автоматически.

HttpsProxy
string or null

HTTPS-прокси демона. Значение берётся из переменной окружения HTTPS_PROXY. Учётные данные в компоненте сведений о пользователе URL прокси маскируются в ответе API. Контейнеры не наследуют эту конфигурацию автоматически.

ID
string or null

Уникальный идентификатор демона.


> Примечание: формат идентификатора не является частью API и не должен считаться стабильным.

Images
integer or null <int64>

Общее число образов на хосте. Учитываются образы с тегами и без тегов, включая висячие образы.

IndexServerAddress
string or null

Адрес или URL сервера индекса, используемого для поиска образов и по умолчанию для аутентификации пользователей в Docker Hub и Docker Cloud.

InitBinary
string or null

Имя и необязательный путь двоичного файла docker-init. Если путь отсутствует, демон ищет файл в $PATH хоста и использует первый результат.

null or Commit (object)
One of
null
IPv4Forwarding
boolean or null

Показывает, включена ли пересылка IPv4.

null or SystemInfoIsolationEnum (string)
One of
null
KernelMemoryTCP
boolean or null

Показывает, поддерживает ли хост ограничение TCP-памяти ядра. Поле отсутствует, если ограничение не поддерживается. Ограничения TCP-памяти ядра недоступны с cgroups v2, где нет соответствующего cgroup memory.kmem.tcp.limit_in_bytes.

KernelVersion
string or null

Версия ядра хоста. В Linux сведения получаются из uname. В Windows они читаются из значения реестра HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\, например "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Labels
Массив strings or null

Пользовательские метки демона в виде метаданных ключ/значение.


> Примечание: в Swarm узлы могут иметь метки демона, заданные его конфигурацией, и метки узла, заданные управляющим узлом Swarm. Метки узла в это поле не включены. Их можно получить конечной точкой /nodes/(id) на управляющем узле Swarm.

LiveRestoreEnabled
boolean or null

Показывает, включён ли live restore. Если включён, контейнеры продолжают работать при остановке демона, а также при его запуске, если обнаружены работающие контейнеры.

LoggingDriver
string or null

Драйвер журналирования по умолчанию для новых контейнеров.

MemoryLimit
boolean or null

Показывает, поддерживает ли хост ограничения памяти.

MemTotal
integer or null <int64>

Общий объём физической памяти хоста в байтах.

Name
string or null

Имя хоста.

NCPU
integer or null <int64>

Число логических CPU, доступных демону. Оно определяется запросом к операционной системе при запуске демона. Изменения распределения CPU после запуска не отражаются.

NEventsListener
integer or null <int64>

Число подписанных слушателей событий.

NFd
integer or null <int64>

Общее число файловых дескрипторов, используемых процессом демона. Сведения возвращаются только в режиме отладки.

NGoroutines
integer or null <int64>

Текущее число goroutines. Сведения возвращаются только в режиме отладки.

NoProxy
string or null

Разделённый запятыми список расширений доменов, для которых прокси не используется. Значение берётся из переменной окружения NO_PROXY. Контейнеры не наследуют эту конфигурацию автоматически.

OomKillDisable
boolean or null

Показывает, поддерживается ли отключение OOM killer на хосте.

OperatingSystem
string or null

Имя операционной системы хоста, например "Ubuntu 16.04.2 LTS" или "Windows Server 2016 Datacenter".

OSType
string or null

Тип операционной системы хоста, возвращаемый средой Go (GOOS). Сейчас возвращаются значения "linux" и "windows". Полный список возможных значений приведён в документации Go.

OSVersion
string or null

Версия операционной системы хоста.


> Примечание: сведения в этом поле, включая само его наличие и формат значений, не следует считать стабильными; они могут измениться без уведомления.

PidsLimit
boolean or null

Показывает, поддерживает ли ядро хоста ограничение PID.

null or PluginsInfo (object)
One of
null
ProductLicense
string or null

Краткие сведения о лицензии продукта на демоне. Если применена коммерческая лицензия, включаются такие сведения, как число узлов и срок действия.

null or RegistryServiceConfig (object)
One of
null
null or Commit (object)
One of
null
object or null

Список сред выполнения, совместимых с OCI и настроенных на демоне. Ключи содержат "name", используемое для обращения к среде. Демон Docker использует совместимую с OCI среду, вызываемую через демон containerd, как интерфейс к пространствам имён ядра Linux, cgroups и SELinux. Среда по умолчанию — runc — настраивается автоматически. Дополнительные среды, настроенные пользователем, перечисляются здесь.

additional property
object (Runtime)

Runtime описывает среду выполнения, совместимую с OCI. Демон вызывает её через демон containerd. Среды OCI служат интерфейсом к пространствам имён ядра Linux, cgroups и SELinux.

SecurityOptions
Массив strings or null

Список функций безопасности, включённых на демоне, например apparmor, seccomp, SELinux, пространства имён пользователей (userns), rootless и no-new-privileges. Дополнительные параметры каждой функции могут быть включены в виде разделённого запятыми списка пар ключ/значение.

ServerVersion
string or null

Строка версии демона.

SwapLimit
boolean or null

Показывает, поддерживает ли хост ограничения swap.

null or SwarmInfo (object)
One of
null
SystemTime
string or null

Текущее системное время в формате RFC 3339, с наносекундами.

Warnings
Массив strings or null

Список предупреждений и информационных сообщений об отсутствующих функциях или проблемах конфигурации демона. Клиент может показать их пользователю.

{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": { },
  • "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": { },
  • "CgroupVersion": { },
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": { },
  • "GenericResources": { },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": { },
  • "LiveRestoreEnabled": true,
  • "Isolation": { },
  • "InitBinary": "string",
  • "ContainerdCommit": { },
  • "RuncCommit": { },
  • "InitCommit": { },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ]
}

SystemInfoCgroupDriverEnum

string (SystemInfoCgroupDriverEnum)
Допустимые значения: "EMPTY" "cgroupfs" "systemd" "none"
"EMPTY"

SystemInfoCgroupVersionEnum

string (SystemInfoCgroupVersionEnum)
Допустимые значения: "EMPTY" "1" "2"
"EMPTY"

SystemInfoDefaultAddressPools

Base
string or null

Адрес сети в формате CIDR.

Size
integer or null <int64>

Размер пула сети.

{
  • "Base": "string",
  • "Size": 0
}

SystemInfoIsolationEnum

string (SystemInfoIsolationEnum)
Допустимые значения: "EMPTY" "default" "hyperv" "process"
"EMPTY"

ThrottleDevice

Path
string or null

Путь устройства.

Rate
integer or null <int64>

Скорость.

{
  • "Path": "string",
  • "Rate": 0
}

ThrottlingData

periods
required
integer <int64> >= 0
throttled_periods
required
integer <int64> >= 0
throttled_time
required
integer <int64> >= 0
{
  • "periods": 0,
  • "throttled_periods": 0,
  • "throttled_time": 0
}

TlsInfo

CertIssuerPublicKey
string or null

Необработанные байты открытого ключа издателя в URL-безопасном Base64.

CertIssuerSubject
string or null

Необработанные байты субъекта издателя в URL-безопасном Base64.

TrustRoot
string or null

Корневые сертификаты центров сертификации для проверки конечных сертификатов TLS.

{
  • "TrustRoot": "string",
  • "CertIssuerSubject": "string",
  • "CertIssuerPublicKey": "string"
}

UnixTarget

UnixPath
required
string
{
  • "UnixPath": "string"
}

UpstreamTarget

DisableLogging
boolean or null

Отключить журналирование для этой цели.

Key
required
string

Ключ целевого Cargo или VM.

Path
string or null

Целевой путь HTTP при использовании HTTP.

Port
required
integer <int32> >= 0

Порт целевого Cargo или VM.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true,
  • "Ssl": { }
}

UriTarget

Uri
required
string

Целевой URI.

{
  • "Uri": "string"
}

UrlRedirect

string (UrlRedirect)
Допустимые значения: "MovedPermanently" "Permanent" "Temporary"
"MovedPermanently"

Vm

CreatedAt
required
string <date-time>

Время создания VM.

NamespaceName
required
string

Имя пространства имён.

required
object (VmSpec)

Спецификация VM.

CreatedAt
required
string <date-time>

Дата создания спецификации VM.

required
object (VmHostConfig)

Ресурсы VM: процессор, память и сеть.

Hostname
string or null

Имя хоста VM.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
Key
required
string <uuid>

Уникальный идентификатор спецификации VM.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес VM.

object

Метаданные, заданные пользователем.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию (cloud).

SshKey
string or null

Ключ SSH пользователя по умолчанию.

User
string or null

Пользователь VM по умолчанию (cloud).

Version
required
string

Версия спецификации.

VmKey
required
string

Канонический ключ VM в формате {namespace}.{name}.

required
object (ObjPsStatus)

Состояние VM.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

VmHostConfig

Cpu
required
integer <int64> >= 0

Число CPU VM; по умолчанию 1.

Dns
Массив strings or null

Список DNS-серверов для VM.

HostTun
boolean or null

Использовать устройство tun хоста.

Kvm
boolean or null

Включить ускорение KVM; по умолчанию false.

LinkNetIface
string or null

Сетевой интерфейс для подключения VM; по умолчанию eth0.

Memory
required
integer <int64> >= 0

Память VM в МБ; по умолчанию 512.

NetIface
string or null

Настраиваемый сетевой интерфейс VM; по умолчанию ens3.

NetworkMode
string or null

Сеть контейнера, используемая средой выполнения VM.

Runtime
string or null

Имя образа контейнера для VM; по умолчанию nanocl-qemu.

{
  • "Cpu": 0,
  • "Memory": 0,
  • "NetIface": "string",
  • "LinkNetIface": "string",
  • "Kvm": true,
  • "Dns": [
    ],
  • "Runtime": "string",
  • "NetworkMode": "string",
  • "HostTun": true
}

VmInspect

CreatedAt
required
string <date-time>

Дата создания VM.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

required
Массив objects (Process)

Список экземпляров.

Array
CreatedAt
required
string <date-time>

Дата создания.

required
object (ContainerInspectResponse)

Данные процесса: ContainerInspect.

IpAddress
string or null

Фактический IP-адрес, полученный из последнего наблюдаемого состояния процесса.

Key
required
string

Ключ процесса.

Kind
required
string (ProcessKind)
Допустимые значения: "vm" "job" "cargo"

Тип процесса (Job, Vm, Cargo).

KindKey
required
string

Канонический ключ ресурса для Cargo и VM; задания используют своё имя.

Name
required
string

Имя процесса.

NodeName
required
string

Имя узла, на котором работает контейнер.

UpdatedAt
required
string <date-time>

Время последнего обновления экземпляра.

InstanceTotal
required
integer >= 0

Число экземпляров.

NamespaceName
required
string

Имя пространства имён.

required
object (VmSpec)

Спецификация VM.

CreatedAt
required
string <date-time>

Дата создания спецификации VM.

required
object (VmHostConfig)

Ресурсы VM: процессор, память и сеть.

Hostname
string or null

Имя хоста VM.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
Key
required
string <uuid>

Уникальный идентификатор спецификации VM.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес VM.

object

Метаданные, заданные пользователем.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию (cloud).

SshKey
string or null

Ключ SSH пользователя по умолчанию.

User
string or null

Пользователь VM по умолчанию (cloud).

Version
required
string

Версия спецификации.

VmKey
required
string

Канонический ключ VM в формате {namespace}.{name}.

required
object (ObjPsStatus)

Состояние VM.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

VmSpec

CreatedAt
required
string <date-time>

Дата создания спецификации VM.

required
object (VmHostConfig)

Ресурсы VM: процессор, память и сеть.

Cpu
required
integer <int64> >= 0

Число CPU VM; по умолчанию 1.

Dns
Массив strings or null

Список DNS-серверов для VM.

HostTun
boolean or null

Использовать устройство tun хоста.

Kvm
boolean or null

Включить ускорение KVM; по умолчанию false.

LinkNetIface
string or null

Сетевой интерфейс для подключения VM; по умолчанию eth0.

Memory
required
integer <int64> >= 0

Память VM в МБ; по умолчанию 512.

NetIface
string or null

Настраиваемый сетевой интерфейс VM; по умолчанию ens3.

NetworkMode
string or null

Сеть контейнера, используемая средой выполнения VM.

Runtime
string or null

Имя образа контейнера для VM; по умолчанию nanocl-qemu.

Hostname
string or null

Имя хоста VM.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
One of
null
Key
required
string <uuid>

Уникальный идентификатор спецификации VM.

object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
MacAddress
string or null

MAC-адрес VM.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию (cloud).

SshKey
string or null

Ключ SSH пользователя по умолчанию.

User
string or null

Пользователь VM по умолчанию (cloud).

Version
required
string

Версия спецификации.

VmKey
required
string

Канонический ключ VM в формате {namespace}.{name}.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "Version": "string",
  • "VmKey": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "InitContainer": { },
  • "User": "string",
  • "Image": "string",
  • "MacAddress": "string",
  • "Labels": {
    },
  • "HostConfig": {
    }
}

VmSpecPartial

null or VmHostConfig (object)
One of
null
Hostname
string or null

Имя хоста VM; по умолчанию создаётся из имени.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
MacAddress
string or null

MAC-адрес VM; по умолчанию создаётся автоматически.

object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию: cloud.

SshKey
string or null

Открытый ключ SSH пользователя по умолчанию; рекомендуется.

User
string or null

Пользователь VM по умолчанию: cloud.

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "InitContainer": { },
  • "Image": "string",
  • "MacAddress": "string",
  • "Labels": {
    },
  • "HostConfig": { }
}

VmSpecUpdate

null or VmHostConfig (object)
One of
null
Hostname
string or null

Имя хоста VM.

null or Config (object)
One of
null
object or null

Метаданные ключ/значение, заданные пользователем.

property name*
additional property
string
object

Метаданные, заданные пользователем.

additional property
string or number or boolean or (Массив Primitive (strings or numbers or booleans)) or object (Any)

Вспомогательный тип Any для OpenApi, полезный для динамических объектов JSON, например ResourceSpec.

Name
string or null

Имя VM.

Password
string or null

Пароль VM по умолчанию (cloud).

SshKey
string or null

Ключ SSH пользователя по умолчанию.

User
string or null

Пользователь VM по умолчанию (cloud).

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "InitContainer": { },
  • "Labels": {
    },
  • "HostConfig": { }
}

VmSummary

CreatedAt
required
string <date-time>

Дата создания VM.

InstanceRunning
required
integer >= 0

Число работающих экземпляров.

InstanceTotal
required
integer >= 0

Число экземпляров.

NamespaceName
required
string

Имя пространства имён.

required
object (VmSpec)

Спецификация VM.

CreatedAt
required
string <date-time>

Дата создания спецификации VM.

required
object (VmHostConfig)

Ресурсы VM: процессор, память и сеть.

Hostname
string or null

Имя хоста VM.

Image
required
string

Образ VM; необходимо указать полный путь, например /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
Key
required
string <uuid>

Уникальный идентификатор спецификации VM.

object or null

Метаданные ключ/значение, заданные пользователем.

MacAddress
string or null

MAC-адрес VM.

object

Метаданные, заданные пользователем.

Name
required
string

Имя VM.

Password
string or null

Пароль VM по умолчанию (cloud).

SshKey
string or null

Ключ SSH пользователя по умолчанию.

User
string or null

Пользователь VM по умолчанию (cloud).

Version
required
string

Версия спецификации.

VmKey
required
string

Канонический ключ VM в формате {namespace}.{name}.

required
object (ObjPsStatus)

Состояние VM.

Actual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Допустимые значения: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Допустимые значения: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "Status": {
    },
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Spec": {
    }
}

nanocl.Network

CreatedAt
required
string <date-time>

Время первого сохранения сети.

required
object (Network)

Полный ответ просмотра сети Docker.

Attachable
boolean or null
object or null
null or String (string)
Driver
string or null
EnableIPv6
boolean or null
Id
string or null
Ingress
boolean or null
Internal
boolean or null
null or Ipam (object)
object or null
Name
string or null
object or null
Scope
string or null
Key
required
string

Устойчивый ключ в формате {node_name}.{network_name}.

Metadata
any

Пользовательские метаданные, сохраняемые при обновлении снимков.

Name
required
string

Имя сети Docker.

NodeName
required
string

Узел, чей демон Docker владеет этой сетью.

UpdatedAt
required
string <date-time>

Время последнего обновления снимка просмотра Docker.

{
  • "Key": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "NodeName": "string",
  • "Data": {
    },
  • "Metadata": null
}