Skip to Content

79 opérations · 215 schémas · spécification v0.18.1

Télécharger le YAML OpenAPI ↗
API docs by Redocly

Nanocl Daemon (v0.18.1)

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

Le Nanocl Daemon est une HTTP REST API.
Il s’agit de l’API utilisée par le Nanocl Client : tout ce que permet le Nanocl Client est donc aussi possible avec l’API.

La plupart des commandes du client correspondent directement à des points d’accès de l’API ; par exemple, nanocl ps correspond à GET /processes.
L’exception notable est l’exécution d’un Cargo, qui nécessite plusieurs appels à l’API.

Spécification OpenAPI

Cette API est documentée au format OpenAPI avec Utoipa.
La spécification est générée automatiquement uniquement en mode développement.
À la publication d’une version, le fichier généré est transféré vers notre documentation.

Partage de ressources entre origines

Cette API prend en charge le partage de ressources entre origines (CORS), conformément à la spécification W3C.
Cela permet les communications entre domaines depuis le navigateur.
Toutes les réponses autorisent toutes les origines, ce qui les rend publiques et accessibles à tous, y compris au code de n’importe quel site.

Cargoes

Lister les Cargoes avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Filtre générique.

namespace
string

Filtre facultatif d’espace de noms ; omis ou vide, il renvoie tous les espaces de noms.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer un Cargo à partir de sa spécification.

query Parameters
namespace
string

Espace de noms où créer le Cargo ; 'global' par défaut.

Request Body schema: application/json
required
required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration avant les conteneurs applicatifs.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

object

Métadonnées du Cargo, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du 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
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les Cargoes avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "my-cargo" } } } }

Filtre générique.

namespace
string

Filtre facultatif d’espace de noms ; omis ou vide, il renvoie tous les espaces de noms.

Réponses

Exemples de réponse

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

Restaurer un Cargo à une entrée précise de l’historique.

path Parameters
cargo_key
required
string

Clé canonique du Cargo au format {namespace}.{name}.

history_key
required
string

Clé de l’historique du Cargo.

Réponses

Exemples de réponse

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

Mettre à jour un Cargo avec sa nouvelle spécification et créer une entrée d’historique.

path Parameters
key
required
string

Clé canonique du Cargo au format {namespace}.{name}.

Request Body schema: application/json
required
required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration avant les conteneurs applicatifs.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

object

Métadonnées du Cargo, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du 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
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Réponses

Exemples de requête

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

Exemples de réponse

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

Supprimer un Cargo par sa clé canonique.

path Parameters
key
required
string

Clé canonique du Cargo au format {namespace}.{name}.

query Parameters
force
required
boolean

Si true, forcer la suppression même si le Cargo est démarré.

Réponses

Exemples de réponse

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

Modifier un Cargo par sa clé canonique et ajouter une entrée d’historique.

path Parameters
key
required
string

Clé canonique du Cargo au format {namespace}.{name}.

Request Body schema: application/json
required
Tableau de objects or null (ContainerSpec)

Déclaration de remplacement des conteneurs applicatifs.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

Dns
Tableau de strings or null

Serveurs DNS de remplacement pour le propriétaire du réseau Cargo.

Hostname
string or null

Nouveau nom d’hôte Docker du propriétaire du réseau Cargo.

Tableau de objects or null (ContainerSpec)

Déclaration de remplacement des conteneurs d’initialisation ordonnés.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

object

Nouvelles métadonnées du Cargo, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
string or null

Nouveau nom du 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

Nouveau nombre de répliques.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Tableau de strings or null

Secrets partagés de remplacement à l’échelle du Cargo.

Réponses

Exemples de requête

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

Exemples de réponse

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

Lister les historiques des Cargoes.

path Parameters
key
required
string

Clé canonique du Cargo au format {namespace}.{name}.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Obtenir les informations détaillées d’un Cargo par sa clé canonique.

path Parameters
key
required
string

Clé canonique du Cargo au format {namespace}.{name}.

Réponses

Exemples de réponse

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

Events

Points d’accès de gestion des événements.

Lister les événements avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "kind": { "eq": "normal" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Compter les événements avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "namespace_name": { "eq": "global" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Surveiller les nouveaux événements de tous les nœuds pairs, avec une condition facultative d’arrêt du flux.

Request Body schema: application/json
Array
required
Tableau de 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
Tableau de strings (EventKind)
Éléments autorisés Valeurs possibles: "error" "normal" "warning"
RelatedKey
string or null
null or EventActorKind (string)

Réponses

Exemples de requête

Content type
application/json
[
  • {
    }
]

Obtenir les informations détaillées d’un événement.

path Parameters
key
required
string

Clé de l’événement.

Réponses

Exemples de réponse

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

Points d’accès de gestion des tâches.

Lister les tâches avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "job-example" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer une tâche.

Request Body schema: application/json
required
required
Tableau de objects (Config)

Liste des conteneurs à exécuter.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or NetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

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

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la tâche.

Schedule
string or null

Expression cron à cinq champs ou raccourci pris en charge ; voir [crate::cron::validate_schedule].

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les tâches.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "key": { "eq": "job-example" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Supprimer une tâche par son nom.

path Parameters
name
required
string

Nom de la tâche.

Réponses

Exemples de réponse

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

Obtenir les informations détaillées d’une tâche.

path Parameters
name
required
string

Nom de la tâche.

Réponses

Exemples de réponse

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

Points d’accès de gestion des métriques.

Lister les métriques avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "kind": { "eq": "CPU" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer une métrique.

Request Body schema: application/json
required
Data
required
any

Données de la métrique.

Kind
required
string

Type de la métrique.

Note
string or null

Note facultative sur la métrique.

Réponses

Exemples de requête

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

Exemples de réponse

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"
}

Compter les métriques avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "kind": { "eq": "ncproxy.io/http" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Obtenir les informations détaillées d’une métrique.

path Parameters
key
required
string

Clé de la métrique.

Réponses

Exemples de réponse

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

Points d’accès de gestion des espaces de noms.

Lister les espaces de noms avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer un espace de noms.

Request Body schema: application/json
required
Metadata
any

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de l’espace de noms.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les espaces de noms.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Supprimer un espace de noms.

path Parameters
name
required
string

Nom de l’espace de noms à supprimer.

Réponses

Exemples de réponse

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

Obtenir les informations détaillées d’un espace de noms.

path Parameters
name
required
string

Nom de l’espace de noms à inspecter.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Networks

Points d’accès d’inspection des réseaux Docker propres à chaque nœud.

Lister les instantanés persistants des réseaux Docker propres à chaque nœud.

query Parameters
filter
string
Exemple: filter={ "where": { "node_name": { "eq": "node-a" } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Inspecter un réseau Docker enregistré à partir de sa clé déterministe.

path Parameters
key
required
string

Clé réseau sous la forme node_name.network_name.

Réponses

Exemples de réponse

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

Points d’accès de gestion des nœuds.

Lister les nœuds.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Démarrer les instances du Cargo sur le nœud utilisé pour la communication entre nœuds.

Request Body schema: application/json
required
CargoKey
required
string

Clé canonique du Cargo au format {namespace}.{name}.

required
Tableau de objects (CargoReplicaTask)

Répliques persistantes exactes affectées à ce nœud, triées par numéro ordinal.

Array
Key
required
string <uuid>

Identité persistante et stable de la réplique du Cargo.

Ordinal
required
integer <int32>

Numéro ordinal stable de la réplique, unique à l’échelle du Cargo.

Réponses

Exemples de requête

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

Compter les nœuds.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Processes

Points d’accès de gestion des processus.

Démarrer une instance exec Docker et s’y connecter par un WebSocket RFC6455.

Les trames binaires du client contiennent l’entrée stdin brute. Les commandes texte sont stdin_eof, resize et detach. Les trames binaires du serveur commencent par 0x01 pour stdout, 0x02 pour stderr ou 0x03 pour console ; les commandes texte signalent exit, detached ou error.

path Parameters
id
required
string

Identifiant de l’instance exec Docker.

Réponses

Exemples de réponse

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

Démarrer une instance exec Docker sans connecter les flux.

path Parameters
id
required
string

Identifiant de l’instance exec Docker.

Réponses

Exemples de réponse

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

Obtenir les statistiques d’un processus par le nom de sa clé.

path Parameters
name
required
string
Exemple: deploy-example

Nom du processus.

query Parameters
one_shot
boolean

Renvoyer les statistiques une seule fois.

stream
boolean

Renvoyer un flux de statistiques.

Réponses

Exemples de réponse

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

Lister les processus avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "where": { "name": { "eq": "test" } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Compter les processus.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Obtenir les journaux des processus pour un type et une clé de ressource canonique.

path Parameters
key
required
string
Exemple: global.deploy-example

Clé canonique de la ressource au format {namespace}.{name} ; les tâches utilisent une clé sans espace de noms.

kind
required
string
Exemple: cargo

Type du processus.

query Parameters
follow
boolean

Booléen déterminant si un flux doit être renvoyé.

since
integer <int64>

Renvoyer uniquement les journaux postérieurs à l’horodatage.

tail
string

Renvoyer uniquement les n dernières lignes de journal (entier), ou toutes ('all').

timestamps
boolean

Ajouter un horodatage à chaque ligne de journal.

until
integer <int64>

Renvoyer uniquement les journaux antérieurs à l’horodatage.

Réponses

Redémarrer tous les processus pour un type et une clé de ressource canonique.

path Parameters
key
required
string
Exemple: global.deploy-example

Clé canonique de la ressource au format {namespace}.{name} ; les tâches utilisent une clé sans espace de noms.

kind
required
string
Exemple: cargo

Type du processus.

Réponses

Démarrer tous les processus pour un type et une clé de ressource canonique.

path Parameters
key
required
string
Exemple: global.deploy-example

Clé canonique de la ressource au format {namespace}.{name} ; les tâches utilisent une clé sans espace de noms.

kind
required
string
Exemple: cargo

Type du processus.

Réponses

Obtenir les statistiques de tous les processus pour un type et une clé de ressource canonique.

path Parameters
key
required
string
Exemple: global.deploy-example

Clé canonique de la ressource au format {namespace}.{name} ; les tâches utilisent une clé sans espace de noms.

kind
required
string
Exemple: cargo

Type de processus.

query Parameters
one_shot
boolean

Renvoyer les statistiques une seule fois.

stream
boolean

Renvoyer un flux de statistiques.

Réponses

Exemples de réponse

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

Arrêter tous les processus pour un type et une clé de ressource canonique.

path Parameters
key
required
string
Exemple: global.deploy-example

Clé canonique de la ressource au format {namespace}.{name} ; les tâches utilisent une clé sans espace de noms.

kind
required
string
Exemple: cargo

Type du processus.

Réponses

Attendre que tous les processus atteignent un état donné.

path Parameters
key
required
string

Clé canonique de la ressource au format {namespace}.{name} ; les tâches utilisent une clé sans espace de noms.

kind
required
string
Exemple: cargo

Type de l’instance de processus, par exemple cargo, job ou vm.

Réponses

Exemples de réponse

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

Se connecter à un processus par WebSocket.

path Parameters
name
required
string

Nom ou identifiant du conteneur.

Réponses

Créer une instance exec pour un nom ou un identifiant de processus précis.

path Parameters
name
required
string

Nom ou identifiant du conteneur.

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

Se connecter à la sortie d’erreur standard.

AttachStdin
boolean or null

Se connecter à l’entrée standard.

AttachStdout
boolean or null

Se connecter à la sortie standard.

Cmd
Tableau de strings or null

Commande et arguments à exécuter.

DetachKeys
string or null

Séquence de touches de déconnexion compatible Docker.

Env
Tableau de strings or null

Variables d’environnement sous la forme NAME=value.

Privileged
boolean or null

Exécuter la commande avec des privilèges étendus.

Tty
boolean or null

Allouer un pseudo-TTY.

User
string or null

Utilisateur et groupe facultatif pour la commande.

WorkingDir
string or null

Répertoire de travail dans le processus.

Réponses

Exemples de requête

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

Exemples de réponse

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

Obtenir les informations détaillées d’un processus par son nom.

path Parameters
name
required
string

Nom du processus.

Réponses

Exemples de réponse

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": {
    }
}

Envoyer un signal à un processus par son nom ou son identifiant.

path Parameters
name
required
string
Exemple: system.nstore.c

Nom ou identifiant du conteneur.

Request Body schema: application/json
required
signal
required
string

Signal à envoyer au processus ; SIGKILL par défaut.

Réponses

Exemples de requête

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

Obtenir les journaux d’une instance de processus par son nom ou son identifiant.

path Parameters
name
required
string
Exemple: deploy-example

Nom du processus.

query Parameters
follow
boolean

Booléen déterminant si un flux doit être renvoyé.

since
integer <int64>

Renvoyer uniquement les journaux postérieurs à l’horodatage.

tail
string

Renvoyer uniquement les n dernières lignes de journal (entier), ou toutes ('all').

timestamps
boolean

Ajouter un horodatage à chaque ligne de journal.

until
integer <int64>

Renvoyer uniquement les journaux antérieurs à l’horodatage.

Réponses

Démarrer un processus par son nom ou son identifiant.

path Parameters
pk
required
string
Exemple: 1234567890

Clé primaire du processus.

Réponses

ResourceKinds

Lister les types de ressources.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "test" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer un type de ressource.

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

Spécification du type de ressource.

object

JSONSchema des ressources de ce type et de cette version.

Url
string or null

Service à appeler lors de la création, de la mise à jour ou de la suppression d’une ressource de ce type et de cette version.

object

Métadonnées du type de ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du type de ressource.

Version
required
string

Version du type de ressource.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les types de ressources.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Supprimer un type de ressource.

path Parameters
domain
required
string

Domaine du type de ressource.

name
required
string

Nom du type de ressource.

Réponses

Exemples de réponse

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

Obtenir les informations détaillées d’un type de ressource.

path Parameters
domain
required
string

Domaine du type de ressource.

name
required
string

Nom du type de ressource.

Réponses

Exemples de réponse

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

Obtenir les informations détaillées d’une version de type de ressource.

path Parameters
domain
required
string

Domaine du type de ressource.

name
required
string

Nom du type de ressource.

version
required
string

Version du type de ressource.

Réponses

Exemples de réponse

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

Resources

Points d’accès de gestion des ressources.

Lister les ressources avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "kind": { "eq": "ncproxy.io/rule" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer une ressource.

Request Body schema: application/json
required
required
object

Données de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Kind
required
string

Type de la ressource.

object

Métadonnées de la ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la ressource.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les ressources.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Créer une spécification de ressource et ajouter une entrée d’historique.

path Parameters
name
required
string

Nom de la ressource.

Request Body schema: application/json
required
required
object

Spécification de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

object

Métadonnées de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Réponses

Exemples de requête

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

Exemples de réponse

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

Supprimer une ressource par son nom.

path Parameters
name
required
string

Nom de la ressource à supprimer.

Réponses

Exemples de réponse

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

Lister l’historique des ressources.

path Parameters
name
required
string

Nom de la ressource dont l’historique doit être listé.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Restaurer une ressource à une entrée précise de l’historique.

path Parameters
id
required
string

Identifiant de l’entrée d’historique à laquelle restaurer la ressource.

name
required
string

Nom de la ressource à restaurer.

Réponses

Exemples de réponse

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

Obtenir les informations détaillées d’une ressource.

path Parameters
name
required
string

Nom de la ressource à inspecter.

Réponses

Exemples de réponse

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

Schémas

Address

Addr
string or null

Adresse IP.

PrefixLen
integer or null <int64>

Longueur du masque de l’adresse IP.

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

Any

One of
string

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

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

ApiError

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

BinaryInfo

Arch
required
string

Arch indique l’architecture du binaire actuel.

Channel
required
string

Channel indique le canal du binaire actuel.

CommitId
required
string

CommitID est l’identifiant du commit du binaire actuel.

Version
required
string

Version indique la version du binaire actuel.

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

BlkioStats

Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
Tableau de 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)

Statistiques d’utilisation CPU du conteneur.

percpu_usage
Tableau de 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)

Statistiques de limitation du 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
Tableau de 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>

Date de création du Cargo.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (CargoSpecRevision)

Spécification du Cargo.

CargoKey
required
string

Clé canonique du Cargo au format {namespace}.{name}.

required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

CreatedAt
required
string <date-time>

Date de création de la spécification du Cargo.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration.

Key
required
string <uuid>

Identifiant unique de la spécification du Cargo.

object

Métadonnées du Cargo, définies par l’utilisateur.

Name
required
string

Nom du Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Version
required
string

Version de la spécification.

required
object (ObjPsStatus)

État du Cargo.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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>

Date de création du Cargo.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

required
Tableau de objects (Process)

Liste des instances.

Array
CreatedAt
required
string <date-time>

Date de création.

required
object (ContainerInspectResponse)

Données du processus : un ContainerInspect.

IpAddress
string or null

Adresse IP effective résolue à partir du dernier état observé du processus.

Key
required
string

Clé du processus.

Kind
required
string (ProcessKind)
Valeurs possibles: "vm" "job" "cargo"

Type du processus (Job, Vm, Cargo).

KindKey
required
string

Clé canonique de la ressource pour les Cargoes et les VM ; les tâches utilisent leur nom.

Name
required
string

Nom du processus.

NodeName
required
string

Nom du nœud sur lequel le conteneur s’exécute.

UpdatedAt
required
string <date-time>

Date de dernière mise à jour de l’instance.

InstanceTotal
required
integer >= 0

Nombre d’instances.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (CargoSpecRevision)

Spécification du Cargo.

CargoKey
required
string

Clé canonique du Cargo au format {namespace}.{name}.

required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

CreatedAt
required
string <date-time>

Date de création de la spécification du Cargo.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration.

Key
required
string <uuid>

Identifiant unique de la spécification du Cargo.

object

Métadonnées du Cargo, définies par l’utilisateur.

Name
required
string

Nom du Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Version
required
string

Version de la spécification.

required
object (ObjPsStatus)

État du Cargo.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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)

Mode réseau Docker utilisé par un Cargo.

Docker accepte tout nom de réseau non vide, en plus de ses modes intégrés. Nanocl réserve container:<id>, car les utilisateurs ne doivent pas rejoindre directement un espace de noms réseau appartenant à un conteneur.

"string"

CargoPlacementSelectorSpec

Cargoes
Tableau de strings or null

Sélectionner selon les Cargoes en cours d’exécution sur les nœuds.

Tableau de objects or null (NodeConstraint)

Contraintes avancées facultatives, sous la forme clé/opérateur/valeur.

Array
Key
required
string

Clé de contrainte, par exemple "region", "label" ou "group".

Operator
required
string (ConstraintOp)
Valeurs possibles: "Eq" "Ne"

Opérateur de contrainte (Eq/Ne).

Value
required
string

Valeur de contrainte.

Groups
Tableau de strings or null

Sélectionner par groupe.

Labels
Tableau de strings or null

Sélectionner par étiquette.

Regions
Tableau de strings or null

Sélectionner par région.

Vms
Tableau de strings or null

Sélectionner selon les VM en cours d’exécution sur les nœuds.

{
  • "Labels": [
    ],
  • "Regions": [
    ],
  • "Groups": [
    ],
  • "Cargoes": [
    ],
  • "Vms": [
    ],
  • "Constraints": [
    ]
}

CargoPlacementSpec

null or CargoPlacementSelectorSpec (object)
One of
null
Regions
Tableau de strings or null

Régions où déployer le 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
Valeur: "Distinct"

Énumération définissant la stratégie de placement du Cargo sur les nœuds.

{
  • "UserDefined": "string"
}

CargoReplicaTask

Key
required
string <uuid>

Identité persistante et stable de la réplique du Cargo.

Ordinal
required
integer <int32>

Numéro ordinal stable de la réplique, unique à l’échelle du Cargo.

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "Ordinal": 0
}

CargoResourceRequirementSpec

CpuCores
integer or null >= 0

Besoins CPU exprimés en nombre de cœurs.

CpuUtilizationCap
number or null <float>

Utilisation CPU moyenne maximale autorisée sur un nœud cible (0.0 - 1.0).

CpuWeight
number or null <float>

Poids CPU facultatif pour le placement équilibré (0.0 - 1.0).

MemoryBytes
integer or null >= 0

Mémoire requise en octets.

MemoryUtilizationCap
number or null <float>

Utilisation mémoire moyenne maximale autorisée sur un nœud cible (0.0 - 1.0).

MemoryWeight
number or null <float>

Poids mémoire facultatif pour le placement équilibré (0.0 - 1.0).

StorageBytes
integer or null >= 0

Stockage requis en octets.

{
  • "CpuCores": 0,
  • "CpuUtilizationCap": 0,
  • "MemoryBytes": 0,
  • "MemoryUtilizationCap": 0,
  • "CpuWeight": 0,
  • "MemoryWeight": 0,
  • "StorageBytes": 0
}

CargoSpec

required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration avant les conteneurs applicatifs.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

object

Métadonnées du Cargo, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du 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
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

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

CargoSpecPatch

Tableau de objects or null (ContainerSpec)

Déclaration de remplacement des conteneurs applicatifs.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

Dns
Tableau de strings or null

Serveurs DNS de remplacement pour le propriétaire du réseau Cargo.

Hostname
string or null

Nouveau nom d’hôte Docker du propriétaire du réseau Cargo.

Tableau de objects or null (ContainerSpec)

Déclaration de remplacement des conteneurs d’initialisation ordonnés.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

object

Nouvelles métadonnées du Cargo, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
string or null

Nouveau nom du 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

Nouveau nombre de répliques.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Tableau de strings or null

Secrets partagés de remplacement à l’échelle du Cargo.

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

CargoSpecRevision

CargoKey
required
string

Clé canonique du Cargo au format {namespace}.{name}.

required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

CreatedAt
required
string <date-time>

Date de création de la spécification du Cargo.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

Key
required
string <uuid>

Identifiant unique de la spécification du Cargo.

object

Métadonnées du Cargo, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du 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
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
One of
null
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Version
required
string

Version de la spécification.

{
  • "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>

Date de création du Cargo.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

InstanceTotal
required
integer >= 0

Nombre d’instances.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (CargoSpecRevision)

Spécification du Cargo.

CargoKey
required
string

Clé canonique du Cargo au format {namespace}.{name}.

required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

CreatedAt
required
string <date-time>

Date de création de la spécification du Cargo.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration.

Key
required
string <uuid>

Identifiant unique de la spécification du Cargo.

object

Métadonnées du Cargo, définies par l’utilisateur.

Name
required
string

Nom du Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Version
required
string

Version de la spécification.

required
object (ObjPsStatus)

État du Cargo.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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 indique le numéro du port de données. La plage autorisée va de 1024 à 49151. Si aucun port n’est défini ou si la valeur est 0, le port par défaut (4789) est utilisé.

DefaultAddrPool
Tableau de strings or null

Default Address Pool définit les plages de sous-réseaux par défaut pour les réseaux de portée globale.

ID
string or null

Identifiant du swarm.

RootRotationInProgress
boolean or null

Indique si une rotation de l’autorité de certification racine du swarm est en cours.

null or SwarmSpec (object)
One of
null
SubnetSize
integer or null <int32> >= 0

SubnetSize indique la taille des sous-réseaux créés à partir de la plage de sous-réseaux par défaut.

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

Identifiant du commit de l’outil externe attendu par dockerd, défini à la compilation.

ID
string or null

Identifiant du commit réel de l’outil externe.

{
  • "ID": "string",
  • "Expected": "string"
}

Config

ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
MacAddress
string or null

Adresse MAC du conteneur.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or NetworkingConfig_String (object)
One of
null
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

additional property
object
WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

{
  • "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)
Valeurs possibles: "Eq" "Ne"

Opérateur de contrainte générique pour sélectionner les nœuds. Permet des correspondances avancées, au-delà des sélecteurs simples.

"Eq"

ContainerConfig

ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

additional property
object
null or HealthConfig (object)
One of
null
Hostname
string or null

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom ou référence de l’image à utiliser pour créer le conteneur, ou utilisée lors de sa création.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
MacAddress
string or null

Adresse MAC du conteneur. Obsolète depuis l’API v1.44 : utilisez plutôt EndpointSettings.MacAddress.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

additional property
object
WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

{
  • "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
Tableau de strings or null

Arguments de la commande en cours d’exécution.

null or ContainerConfig (object)
One of
null
Created
string or null

Date de création du conteneur.

Driver
string or null
ExecIDs
Tableau de strings or null

Identifiants des instances exec en cours d’exécution dans le conteneur.

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

Identifiant du conteneur.

Image
string or null

Identifiant de l’image du conteneur.

LogPath
string or null
MountLabel
string or null
Tableau de objects or null (MountPoint)
Array
Destination
string or null

Destination est le chemin relatif à la racine du conteneur (/) où Source est monté dans le conteneur.

Driver
string or null

Driver est le pilote de volumes utilisé pour créer le volume, s’il s’agit d’un volume.

Mode
string or null

Mode est une liste d’options séparées par des virgules, fournies par l’utilisateur à la création du montage lié ou du volume. La valeur par défaut dépend de la plateforme : \"z\" sous Linux, vide sous Windows.

Name
string or null

Name est le nom faisant référence aux données sous-jacentes définies par Source, par exemple le nom du volume.

Propagation
string or null

Propagation décrit la propagation des montages de l’hôte vers le point de montage, et inversement. Voir la documentation du noyau Linux pour les détails. Ce champ n’est pas utilisé sous Windows.

RW
boolean or null

Indique si le montage est accessible en écriture, c’est-à-dire en lecture-écriture.

Source
string or null

Emplacement source du montage. Pour les volumes, il contient l’emplacement de stockage du volume dans /var/lib/docker/volumes/. Pour les montages liés et npipe, il contient la partie source sur l’hôte. Pour les points de montage tmpfs, ce champ est vide.

null or MountPointTypeEnum (string)
Name
string or null
null or NetworkSettings (object)
One of
null
Path
string or null

Chemin de la commande en cours d’exécution.

Platform
string or null
ProcessLabel
string or null
ResolvConfPath
string or null
RestartCount
integer or null <int64>
SizeRootFs
integer or null <int64>

Taille totale de tous les fichiers de ce conteneur.

SizeRw
integer or null <int64>

Taille des fichiers créés ou modifiés par ce conteneur.

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

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

Essential
boolean
Valeur par défaut: true

Indique si l’échec de ce conteneur rend la réplique du Cargo non saine.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

ImagePullPolicy
string
Valeur par défaut: "IfNotPresent"
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique utilisée pour télécharger l’image de ce conteneur.

null or string

Secret utilisé pour télécharger l’image de ce conteneur.

One of
null

Secret utilisé pour télécharger l’image de ce conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
MacAddress
string or null

Adresse MAC du conteneur.

Name
required
string

Nom unique au sein de la déclaration du Cargo.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or ContainerSpecNetworkingConfig_String (object)
One of
null
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Secrets
Tableau de strings
Valeur par défaut: []

Secrets injectés uniquement dans ce conteneur.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

additional property
object
WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

{
  • "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
Tableau de strings or null[ items ]

Liste de capacités : une disjonction (OR) de listes de conjonctions (AND) de capacités.

Count
integer or null <int64>
DeviceIDs
Tableau de strings or null
Driver
string or null
object or null

Options propres au pilote, sous forme de paires clé/valeur. Elles sont transmises directement au pilote.

property name*
additional property
string
{
  • "Driver": "string",
  • "Count": 0,
  • "DeviceIDs": [
    ],
  • "Capabilities": [
    ],
  • "Options": {
    }
}

ContainerSpecEndpointIpamConfig

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
Tableau de strings or null
{
  • "IPv4Address": "string",
  • "IPv6Address": "string",
  • "LinkLocalIPs": [
    ]
}

ContainerSpecEndpointSettings

Aliases
Tableau de strings or null
DNSNames
Tableau de strings or null

Liste de tous les noms DNS d’un point de connexion sur un réseau donné. Elle est construite à partir du nom du conteneur, des alias réseau, de l’identifiant court du conteneur et du nom d’hôte. Ces noms DNS ne sont pas pleinement qualifiés, mais peuvent contenir plusieurs points. Ajoutez .<network-name> pour obtenir des noms pleinement qualifiés. Par exemple, si le conteneur s’appelle my.ctr et le réseau testnet, DNSNames contiendra my.ctr et le FQDN sera my.ctr.testnet.

object or null

DriverOpts associe les options du pilote à leurs valeurs. Ces options, propres au pilote, lui sont transmises directement.

property name*
additional property
string
EndpointID
string or null

Identifiant unique du point d’accès de service dans un Sandbox.

Gateway
string or null

Adresse de passerelle de ce réseau.

GlobalIPv6Address
string or null

Adresse IPv6 globale.

GlobalIPv6PrefixLen
integer or null <int64>

Longueur du masque de l’adresse IPv6 globale.

IPAddress
string or null

Adresse IPv4.

null or ContainerSpecEndpointIpamConfig (object)
One of
null
IPPrefixLen
integer or null <int64>

Longueur du masque de l’adresse IPv4.

IPv6Gateway
string or null

Adresse de passerelle IPv6.

Links
Tableau de strings or null
MacAddress
string or null

Adresse MAC du point de connexion sur ce réseau. Le pilote réseau peut ignorer ce paramètre.

NetworkID
string or null

Identifiant unique du réseau.

{
  • "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 Tableau de objects
One of
null
{
  • "property1": { },
  • "property2": { }
}

ContainerSpecHealthConfig

Interval
integer or null <int64>

Délai entre les contrôles, en nanosecondes. Doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

Retries
integer or null <int64>

Nombre d’échecs consécutifs nécessaires pour considérer un conteneur comme non sain. 0 signifie hériter de la valeur.

StartInterval
integer or null <int64>

Délai entre les contrôles pendant la période de démarrage, en nanosecondes. Doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

StartPeriod
integer or null <int64>

Période de démarrage laissant le conteneur s’initialiser avant le décompte des tentatives de santé, en nanosecondes. Elle doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

Test
Tableau de strings or null

Test à effectuer. Valeurs possibles : - [] : hériter du contrôle de santé de l’image ou de l’image parente - [\"NONE\"] : désactiver le contrôle de santé - [\"CMD\", args...] : exécuter directement les arguments - [\"CMD-SHELL\", command] : exécuter la commande avec le shell par défaut du système.

Timeout
integer or null <int64>

Délai d’attente avant de considérer le contrôle comme bloqué. Doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

{
  • "Test": [
    ],
  • "Interval": 0,
  • "Timeout": 0,
  • "Retries": 0,
  • "StartPeriod": 0,
  • "StartInterval": 0
}

ContainerSpecHostConfig

object or null

Métadonnées arbitraires et non identifiantes associées au conteneur et transmises au moteur d’exécution à son démarrage.

property name*
additional property
string
AutoRemove
boolean or null

Supprimer automatiquement le conteneur à la fin de son processus. Sans effet si RestartPolicy est défini.

Binds
Tableau de strings or null

Liste des montages de volumes pour ce conteneur. Chaque montage est une chaîne sous l’une des formes suivantes : - host-src:container-dest[:options] pour monter un chemin de l’hôte dans le conteneur. host-src et container-dest doivent tous deux être des chemins absolus. - volume-name:container-dest[:options] pour monter dans le conteneur un volume géré par un pilote de volumes. container-dest doit être un chemin absolu. options est une liste facultative, séparée par des virgules, des options suivantes : - nocopy désactive la copie automatique des données du chemin du conteneur vers le volume. L’option nocopy s’applique uniquement aux volumes nommés. - [ro|rw] monte le volume en lecture seule ou en lecture-écriture, respectivement. Si l’option est omise ou vaut rw, le montage est en lecture-écriture. - [z|Z] applique des étiquettes SELinux pour autoriser ou interdire la lecture et l’écriture du même volume par plusieurs conteneurs. - z : une étiquette de contenu partagé est appliquée. Elle indique que plusieurs conteneurs peuvent partager le contenu du volume en lecture et en écriture. - Z : une étiquette privée non partagée est appliquée. Elle indique que seul le conteneur actuel peut utiliser le volume privé. Les systèmes comme SELinux exigent des étiquettes appropriées sur le contenu des volumes montés dans un conteneur. Sans étiquette, le système de sécurité peut empêcher les processus du conteneur d’utiliser ce contenu. Par défaut, les étiquettes définies par le système d’exploitation hôte ne sont pas modifiées. - [[r]shared|[r]slave|[r]private] définit le comportement de propagation du montage. Cette option s’applique uniquement aux volumes montés depuis l’hôte, pas aux volumes internes ou nommés. La propagation exige que le point de montage source, où le répertoire source est monté sur l’hôte, possède les propriétés de propagation adéquates. Pour les volumes partagés, le point de montage source doit être shared. Pour les volumes esclaves, il doit être shared ou slave.

Tableau de objects or null (ContainerSpecThrottleDevice)

Limiter le débit de lecture d’un périphérique en octets par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

Tableau de objects or null (ContainerSpecThrottleDevice)

Limiter le débit de lecture d’un périphérique en opérations d’entrée/sortie par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

Tableau de objects or null (ContainerSpecThrottleDevice)

Limiter le débit d’écriture vers un périphérique en octets par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

Tableau de objects or null (ContainerSpecThrottleDevice)

Limiter le débit d’écriture vers un périphérique en opérations d’entrée/sortie par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

BlkioWeight
integer or null <int32> >= 0

Poids relatif des entrées/sorties par blocs.

Tableau de objects or null (ContainerSpecResourcesBlkioWeightDevice)

Poids des entrées/sorties par blocs, relatif au périphérique, sous la forme : [{\"Path\": \"device_path\", \"Weight\": weight}]

Array
Path
string or null
Weight
integer or null >= 0
CapAdd
Tableau de strings or null

Liste des capacités du noyau à ajouter au conteneur. Incompatible avec l’option 'Capabilities'.

CapDrop
Tableau de strings or null

Liste des capacités du noyau à retirer du conteneur. Incompatible avec l’option 'Capabilities'.

Cgroup
string or null

Cgroup à utiliser pour le conteneur.

null or ContainerSpecHostConfigCgroupnsModeEnum (string)
One of
null
CgroupParent
string or null

Chemin de cgroups sous lequel le cgroup du conteneur est créé. Si ce chemin n’est pas absolu, il est considéré comme relatif au chemin cgroups du processus init. Les cgroups sont créés s’ils n’existent pas déjà.

ConsoleSize
Tableau de integers or null <int32> [ items <int32 > ]

Taille initiale de la console, sous forme de tableau [height, width].

ContainerIDFile
string or null

Chemin d’un fichier où écrire l’identifiant du conteneur.

CpuCount
integer or null <int64>

Nombre de CPU utilisables ; Windows uniquement. Pour les conteneurs Windows Server, les contrôles de ressources CPU sont mutuellement exclusifs. L’ordre de priorité est CPUCount, puis CPUShares, puis CPUPercent.

CpuPercent
integer or null <int64>

Pourcentage utilisable des CPU disponibles ; Windows uniquement. Pour les conteneurs Windows Server, les contrôles de ressources CPU sont mutuellement exclusifs. L’ordre de priorité est CPUCount, puis CPUShares, puis CPUPercent.

CpuPeriod
integer or null <int64>

Durée d’une période CPU en microsecondes.

CpuQuota
integer or null <int64>

Microsecondes de temps CPU que le conteneur peut utiliser pendant une période CPU.

CpuRealtimePeriod
integer or null <int64>

Durée d’une période CPU temps réel en microsecondes. Définir 0 pour n’allouer aucun temps aux tâches temps réel.

CpuRealtimeRuntime
integer or null <int64>

Durée d’exécution CPU temps réel en microsecondes. Définir 0 pour n’allouer aucun temps aux tâches temps réel.

CpusetCpus
string or null

CPU autorisés pour l’exécution, par exemple 0-3 ou 0,1.

CpusetMems
string or null

Nœuds mémoire (MEMs) autorisés pour l’exécution (0-3, 0,1). Effectif uniquement sur les systèmes NUMA.

CpuShares
integer or null <int64>

Valeur entière représentant le poids CPU relatif de ce conteneur par rapport aux autres.

DeviceCgroupRules
Tableau de strings or null

Liste des règles cgroup à appliquer au conteneur.

Tableau de objects or null (ContainerSpecDeviceRequest)

Liste des demandes de périphériques à envoyer aux pilotes.

Array
Capabilities
Tableau de strings or null[ items ]

Liste de capacités : une disjonction (OR) de listes de conjonctions (AND) de capacités.

Count
integer or null <int64>
DeviceIDs
Tableau de strings or null
Driver
string or null
object or null

Options propres au pilote, sous forme de paires clé/valeur. Elles sont transmises directement au pilote.

Tableau de objects or null (ContainerSpecDeviceMapping)

Liste des périphériques à ajouter au conteneur.

Array
CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
Dns
Tableau de strings or null

Liste des serveurs DNS à utiliser par le conteneur.

DnsOptions
Tableau de strings or null

Liste des options DNS.

DnsSearch
Tableau de strings or null

Liste des domaines de recherche DNS.

ExtraHosts
Tableau de strings or null

Liste des correspondances entre noms d’hôtes et adresses IP à ajouter au fichier /etc/hosts du conteneur. Format : [\"hostname:IP\"].

GroupAdd
Tableau de strings or null

Liste des groupes supplémentaires auxquels appartiendra le processus du conteneur.

Init
boolean or null

Exécuter un processus init dans le conteneur pour transmettre les signaux et récolter les processus terminés. Si ce champ est vide, il est omis et la valeur par défaut du démon est utilisée.

IOMaximumBandwidth
integer or null <int64>

Débit maximal des entrées/sorties du disque système du conteneur, en octets par seconde ; Windows uniquement.

IOMaximumIOps
integer or null <int64>

Nombre maximal d’opérations d’entrée/sortie par seconde pour le disque système du conteneur ; Windows uniquement.

IpcMode
string or null

Mode de partage IPC du conteneur. Valeurs possibles : - \"none\" : espace de noms IPC privé, sans montage de /dev/shm - \"private\" : espace de noms IPC privé - \"shareable\" : espace de noms IPC privé pouvant être partagé avec d’autres conteneurs - \"container:<name|id>\" : rejoindre l’espace de noms IPC d’un autre conteneur partageable - \"host\" : utiliser l’espace de noms IPC du système hôte. Si aucune valeur n’est fournie, la valeur par défaut du démon est utilisée : \"private\" ou \"shareable\", selon sa version et sa configuration.

null or ContainerSpecHostConfigIsolationEnum (string)
One of
null
KernelMemoryTCP
integer or null <int64>

Limite stricte de la mémoire des tampons TCP du noyau, en octets. Cette option peut être ignorée selon le moteur OCI utilisé. Elle n’est plus prise en charge par le moteur par défaut (runc). Ce champ est omis lorsqu’il est vide.

Links
Tableau de strings or null

Liste des liens du conteneur sous la forme container_name:alias.

null or ContainerSpecHostConfigLogConfig (object)
One of
null
MaskedPaths
Tableau de strings or null

Liste des chemins à masquer dans le conteneur ; remplace la liste de chemins par défaut.

Memory
integer or null <int64>

Limite de mémoire en octets.

MemoryReservation
integer or null <int64>

Limite souple de mémoire en octets.

MemorySwap
integer or null <int64>

Limite totale de mémoire, mémoire et swap comprises. Définir -1 pour autoriser un swap illimité.

MemorySwappiness
integer or null <int64>

Ajuster le comportement de swappiness de la mémoire du conteneur. Accepte un entier de 0 à 100.

Tableau de objects or null (ContainerSpecMount)

Spécification des montages à ajouter au conteneur.

Array
null or ContainerSpecMountBindOptions (object)
Consistency
string or null

Exigence de cohérence du montage : default, consistent, cached ou delegated.

ReadOnly
boolean or null

Indique si le montage doit être accessible en lecture seule.

Source
string or null

Source du montage, par exemple un nom de volume ou un chemin de l’hôte.

Target
string or null

Chemin du conteneur.

null or ContainerSpecMountTmpfsOptions (object)
null or ContainerSpecMountTypeEnum (string)
null or ContainerSpecMountVolumeOptions (object)
NanoCpus
integer or null <int64>

Quota CPU en unités de 10-9 processeur.

NetworkMode
string or null

Mode réseau à utiliser pour ce conteneur. Les valeurs standard prises en charge sont bridge, host, none et container:<name|id>. Toute autre valeur est interprétée comme le nom d’un réseau personnalisé auquel connecter le conteneur.

OomKillDisable
boolean or null

Désactiver l’OOM killer pour le conteneur.

OomScoreAdj
integer or null <int64>

Valeur entière indiquant le score du conteneur afin d’ajuster les préférences de l’OOM killer.

PidMode
string or null

Définir le mode d’espace de noms PID (processus) du conteneur. Valeurs possibles : - \"container:<name|id>\" : rejoindre l’espace de noms PID d’un autre conteneur - \"host\" : utiliser l’espace de noms PID de l’hôte dans le conteneur.

PidsLimit
integer or null <int64>

Ajuster la limite de PID du conteneur. Définir 0 ou -1 pour ne pas limiter, ou null pour ne rien modifier.

null or ContainerSpecHashMap (object)
One of
null
Privileged
boolean or null

Donne au conteneur un accès complet à l’hôte.

PublishAllPorts
boolean or null

Alloue un port éphémère de l’hôte pour chacun des ports exposés du conteneur. Les ports sont libérés à l’arrêt du conteneur et alloués à son démarrage. Le port alloué peut changer au redémarrage. Il est choisi dans la plage des ports éphémères, qui dépend du noyau. Sous Linux, par exemple, cette plage est définie par /proc/sys/net/ipv4/ip_local_port_range.

ReadonlyPaths
Tableau de strings or null

Liste des chemins à rendre accessibles en lecture seule dans le conteneur ; remplace la liste de chemins par défaut.

ReadonlyRootfs
boolean or null

Monter le système de fichiers racine du conteneur en lecture seule.

null or ContainerSpecRestartPolicy (object)
One of
null
Runtime
string or null

Moteur d’exécution à utiliser avec ce conteneur.

SecurityOpt
Tableau de strings or null

Liste de chaînes personnalisant les étiquettes des systèmes MLS, comme SELinux.

ShmSize
integer or null <int64>

Taille de /dev/shm en octets. Si omise, le système utilise 64 Mo.

object or null

Options du pilote de stockage de ce conteneur, sous la forme {\"size\": \"120G\"}.

property name*
additional property
string
object or null

Liste des paramètres du noyau (sysctls) à définir dans le conteneur. Par exemple : {\"net.ipv4.ip_forward\": \"1\"}

property name*
additional property
string
object or null

Correspondance entre les répertoires du conteneur à remplacer par des montages tmpfs et leurs options de montage. Par exemple : { \"/run\": \"rw,noexec,nosuid,size=65536k\" }

property name*
additional property
string
Tableau de objects or null (ContainerSpecResourcesUlimits)

Liste des limites de ressources à définir dans le conteneur. Par exemple : {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}

Array
Hard
integer or null <int64>

Limite stricte.

Name
string or null

Nom de l’ulimit.

Soft
integer or null <int64>

Limite souple.

UsernsMode
string or null

Définit le mode d’espace de noms utilisateur du conteneur lorsque le remappage de ces espaces de noms est activé.

UTSMode
string or null

Espace de noms UTS à utiliser pour le conteneur.

VolumeDriver
string or null

Pilote utilisé par ce conteneur pour monter les volumes.

VolumesFrom
Tableau de strings or null

Liste des volumes à hériter d’un autre conteneur, sous la forme <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)
Valeurs possibles: "EMPTY" "private" "host"
"EMPTY"

ContainerSpecHostConfigIsolationEnum

string (ContainerSpecHostConfigIsolationEnum)
Valeurs possibles: "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

Exigence de cohérence du montage : default, consistent, cached ou delegated.

ReadOnly
boolean or null

Indique si le montage doit être accessible en lecture seule.

Source
string or null

Source du montage, par exemple un nom de volume ou un chemin de l’hôte.

Target
string or null

Chemin du conteneur.

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

Créer le point de montage sur l’hôte s’il est absent.

NonRecursive
boolean or null

Désactiver le montage lié récursif.

null or ContainerSpecMountBindOptionsPropagationEnum (string)
One of
null
ReadOnlyForceRecursive
boolean or null

Signaler une erreur si le montage ne peut pas être rendu récursivement accessible en lecture seule.

ReadOnlyNonRecursive
boolean or null

Rendre le montage lui-même accessible en lecture seule sans appliquer cette propriété récursivement, tout en conservant le montage récursif, sauf si NonRecursive vaut aussi true. Ajouté en v1.44 ; auparavant, tous les montages en lecture seule étaient non récursifs par défaut. Pour reproduire cet ancien comportement, la valeur par défaut est true pour les clients antérieurs à v1.44.

{
  • "Propagation": { },
  • "NonRecursive": true,
  • "CreateMountpoint": true,
  • "ReadOnlyNonRecursive": true,
  • "ReadOnlyForceRecursive": true
}

ContainerSpecMountBindOptionsPropagationEnum

string (ContainerSpecMountBindOptionsPropagationEnum)
Valeurs possibles: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
"EMPTY"

ContainerSpecMountTmpfsOptions

Mode
integer or null <int64>

Mode des permissions du montage tmpfs, sous forme d’entier.

SizeBytes
integer or null <int64>

Taille du montage tmpfs en octets.

{
  • "SizeBytes": 0,
  • "Mode": 0
}

ContainerSpecMountTypeEnum

string (ContainerSpecMountTypeEnum)
Valeurs possibles: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

ContainerSpecMountVolumeOptions

null or ContainerSpecMountVolumeOptionsDriverConfig (object)
One of
null
object or null

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
NoCopy
boolean or null

Remplir le volume avec les données de la cible.

Subpath
string or null

Chemin source dans le volume. Doit être relatif et ne pas remonter vers les répertoires parents.

{
  • "NoCopy": true,
  • "Labels": {
    },
  • "DriverConfig": { },
  • "Subpath": "string"
}

ContainerSpecMountVolumeOptionsDriverConfig

Name
string or null

Nom du pilote à utiliser pour créer le volume.

object or null

Table clé/valeur des options propres au pilote.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

ContainerSpecNetworkingConfig_String

required
object
additional property
object (ContainerSpecEndpointSettings)

Configuration d’un point de connexion réseau.

{
  • "EndpointsConfig": {
    }
}

ContainerSpecResourcesBlkioWeightDevice

Path
string or null
Weight
integer or null >= 0
{
  • "Path": "string",
  • "Weight": 0
}

ContainerSpecResourcesUlimits

Hard
integer or null <int64>

Limite stricte.

Name
string or null

Nom de l’ulimit.

Soft
integer or null <int64>

Limite souple.

{
  • "Name": "string",
  • "Soft": 0,
  • "Hard": 0
}

ContainerSpecRestartPolicy

MaximumRetryCount
integer or null <int64>

Si on-failure est utilisé, nombre de tentatives avant abandon.

null or ContainerSpecRestartPolicyNameEnum (string)
One of
null
{
  • "Name": { },
  • "MaximumRetryCount": 0
}

ContainerSpecRestartPolicyNameEnum

string (ContainerSpecRestartPolicyNameEnum)
Valeurs possibles: "EMPTY" "no" "always" "unless-stopped" "on-failure"
"EMPTY"

ContainerSpecThrottleDevice

Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

{
  • "Path": "string",
  • "Rate": 0
}

ContainerState

Dead
boolean or null
Error
string or null
ExitCode
integer or null <int64>

Dernier code de sortie de ce conteneur.

FinishedAt
string or null

Date de dernière fin d’exécution de ce conteneur.

null or Health (object)
One of
null
OOMKilled
boolean or null

Indique si un processus de ce conteneur a été terminé par manque de mémoire depuis le dernier démarrage du conteneur.

Paused
boolean or null

Indique si ce conteneur est en pause.

Pid
integer or null <int64>

Identifiant du processus de ce conteneur.

Restarting
boolean or null

Indique si ce conteneur est en cours de redémarrage.

Running
boolean or null

Indique si ce conteneur fonctionne. Un conteneur en cours d’exécution peut être en pause. Les booléens Running et Paused ne sont pas mutuellement exclusifs : sous Linux, la mise en pause utilise le cgroup freezer pour suspendre tous les processus. Un processus doit être en cours d’exécution pour être gelé. Les conteneurs en pause sont donc à la fois Running et Paused. Utilisez plutôt le champ Status pour déterminer si l’état du conteneur est "running".

StartedAt
string or null

Date de dernier démarrage de ce conteneur.

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)
Valeurs possibles: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead"
"EMPTY"

DaemonConfig

advertise_addr
required
string

Adresse à annoncer aux autres nœuds.

conf_dir
required
string

Répertoire de configuration.

docker_host
string

Hôte Docker à utiliser.

gateway
required
string

Passerelle de l’hôte, détectée automatiquement à partir de sa passerelle par défaut si aucune valeur n’est définie.

gid
required
integer <int32> >= 0

Identifiant du groupe.

hostname
required
string

Nom d’hôte à utiliser pour le nœud, détecté automatiquement s’il n’est pas défini.

hosts
required
Tableau de strings

Liste des hôtes sur lesquels écouter.

nodes
required
Tableau de strings

Liste des nœuds à rejoindre.

null or SslConfig (object)
One of
null
state_dir
required
string

Chemin du répertoire d’état.

store_addr
string or null

Adresse du stockage auquel se connecter.

{
  • "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
Tableau de strings or null[ items ]

Liste de capacités : une disjonction (OR) de listes de conjonctions (AND) de capacités.

Count
integer or null <int64>
DeviceIDs
Tableau de strings or null
Driver
string or null
object or null

Options propres au pilote, sous forme de paires clé/valeur. Elles sont transmises directement au pilote.

property name*
additional property
string
{
  • "Driver": "string",
  • "Count": 0,
  • "DeviceIDs": [
    ],
  • "Capabilities": [
    ],
  • "Options": {
    }
}

DnsEntry

required
string or object or object (NetworkKind)
One of
string

Sélecteur de liaison réseau.

Name
required
string
{
  • "Name": "string",
  • "IpAddress": "string"
}

EndpointIpamConfig

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
Tableau de strings or null
{
  • "IPv4Address": "string",
  • "IPv6Address": "string",
  • "LinkLocalIPs": [
    ]
}

EndpointSettings

Aliases
Tableau de strings or null
DNSNames
Tableau de strings or null

Liste de tous les noms DNS d’un point de connexion sur un réseau donné. Elle est construite à partir du nom du conteneur, des alias réseau, de l’identifiant court du conteneur et du nom d’hôte. Ces noms DNS ne sont pas pleinement qualifiés, mais peuvent contenir plusieurs points. Ajoutez .<network-name> pour obtenir des noms pleinement qualifiés. Par exemple, si le conteneur s’appelle my.ctr et le réseau testnet, DNSNames contiendra my.ctr et le FQDN sera my.ctr.testnet.

object or null

DriverOpts associe les options du pilote à leurs valeurs. Ces options, propres au pilote, lui sont transmises directement.

property name*
additional property
string
EndpointID
string or null

Identifiant unique du point d’accès de service dans un Sandbox.

Gateway
string or null

Adresse de passerelle de ce réseau.

GlobalIPv6Address
string or null

Adresse IPv6 globale.

GlobalIPv6PrefixLen
integer or null <int64>

Longueur du masque de l’adresse IPv6 globale.

IPAddress
string or null

Adresse IPv4.

null or EndpointIpamConfig (object)
One of
null
IPPrefixLen
integer or null <int64>

Longueur du masque de l’adresse IPv4.

IPv6Gateway
string or null

Adresse de passerelle IPv6.

Links
Tableau de strings or null
MacAddress
string or null

Adresse MAC du point de connexion sur ce réseau. Le pilote réseau peut ignorer ce paramètre.

NetworkID
string or null

Identifiant unique du réseau.

{
  • "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 indique l’action effectuée ou ayant échoué concernant l’acteur associé. La valeur est exploitable par une machine. Ce champ ne peut pas être vide pour les nouveaux événements et ne peut pas dépasser 128 caractères.

null or EventActor (object)
One of
null
CreatedAt
required
string <date-time>

Date de création de l’événement.

ExpiresAt
required
string <date-time>

Date d’expiration de l’événement.

Key
required
string <uuid>

Identifiant unique de cet événement.

Kind
required
string (EventKind)
Valeurs possibles: "error" "normal" "warning"

Type de cet événement (Error, Normal, Warning) ; de nouveaux types pourront être ajoutés ultérieurement. La valeur est exploitable par une machine. Ce champ ne peut pas être vide pour les nouveaux événements.

object

Métadonnées standard.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Note
string or null

Description de l’état de cette opération, lisible par un humain.

Reason
required
string

Reason indique pourquoi l’action a été effectuée, sous une forme lisible par un humain. Ce champ ne peut pas être vide pour les nouveaux événements et ne peut pas dépasser 128 caractères.

null or EventActor (object)
One of
null
ReportingController
required
string

Reporting Controller est le nom du contrôleur ayant émis cet événement, par exemple nanocl.io/core. Ce champ ne peut pas être vide pour les nouveaux événements.

ReportingNode
required
string

Reporting Node est le nom du nœud où l’événement a été généré.

{
  • "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 (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Key
string or null
Kind
required
string (EventActorKind)
Valeurs possibles: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind indique le type d’événement lié au type de l’acteur.

{
  • "Key": "string",
  • "Kind": "Namespace",
  • "Attributes": {
    }
}

EventActorKind

string (EventActorKind)
Valeurs possibles: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind indique le type d’événement lié au type de l’acteur.

"Namespace"

EventCondition

required
Tableau de 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
Valeur: "create"

Action indique l’action ayant déclenché l’événement.

ActorKey
string or null
null or EventActorKind (string)
One of
null
Kind
required
Tableau de strings (EventKind)
Éléments autorisés Valeurs possibles: "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)
Valeurs possibles: "error" "normal" "warning"

Type d’événement (Error, Normal, Warning) ; de nouveaux types pourront être ajoutés ultérieurement.

"error"

GenericCount

Count
required
integer <int64>

Nombre d’éléments.

{
  • "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

Métadonnées de stockage de bas niveau, sous forme de paires clé/valeur. Ces informations dépendent du pilote de stockage utilisé et doivent servir uniquement à titre informatif.

property name*
additional property
string
Name
required
string

Nom du pilote de stockage.

{
  • "Name": "string",
  • "Data": {
    }
}

HashMap

additional property
null or Tableau de objects
One of
null
{
  • "property1": { },
  • "property2": { }
}

Health

FailingStreak
integer or null <int64>

FailingStreak est le nombre d’échecs consécutifs.

Tableau de objects or null (HealthcheckResult)

Log contient les derniers résultats, du plus ancien au plus récent.

Array
null or String (string)
ExitCode
integer or null <int64>

Signification d’ExitCode : - 0 sain - 1 non sain - 2 réservé, considéré comme non sain - autres valeurs : erreur lors de l’exécution de la sonde.

Output
string or null

Sortie du dernier contrôle.

null or String (string)
null or HealthStatusEnum (string)
One of
null
{
  • "Status": { },
  • "FailingStreak": 0,
  • "Log": [
    ]
}

HealthConfig

Interval
integer or null <int64>

Délai entre les contrôles, en nanosecondes. Doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

Retries
integer or null <int64>

Nombre d’échecs consécutifs nécessaires pour considérer un conteneur comme non sain. 0 signifie hériter de la valeur.

StartInterval
integer or null <int64>

Délai entre les contrôles pendant la période de démarrage, en nanosecondes. Doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

StartPeriod
integer or null <int64>

Période de démarrage laissant le conteneur s’initialiser avant le décompte des tentatives de santé, en nanosecondes. Elle doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

Test
Tableau de strings or null

Test à effectuer. Valeurs possibles : - [] : hériter du contrôle de santé de l’image ou de l’image parente - [\"NONE\"] : désactiver le contrôle de santé - [\"CMD\", args...] : exécuter directement les arguments - [\"CMD-SHELL\", command] : exécuter la commande avec le shell par défaut du système.

Timeout
integer or null <int64>

Délai d’attente avant de considérer le contrôle comme bloqué. Doit valoir 0 ou au moins 1000000 (1 ms). 0 signifie hériter de la valeur.

{
  • "Test": [
    ],
  • "Interval": 0,
  • "Timeout": 0,
  • "Retries": 0,
  • "StartPeriod": 0,
  • "StartInterval": 0
}

HealthStatusEnum

string (HealthStatusEnum)
Valeurs possibles: "EMPTY" "none" "starting" "healthy" "unhealthy"
"EMPTY"

HealthcheckResult

null or String (string)
One of
null
ExitCode
integer or null <int64>

Signification d’ExitCode : - 0 sain - 1 non sain - 2 réservé, considéré comme non sain - autres valeurs : erreur lors de l’exécution de la sonde.

Output
string or null

Sortie du dernier contrôle.

null or String (string)
One of
null
{
  • "Start": { },
  • "End": { },
  • "ExitCode": 0,
  • "Output": "string"
}

HostConfig

object or null

Métadonnées arbitraires et non identifiantes associées au conteneur et transmises au moteur d’exécution à son démarrage.

property name*
additional property
string
AutoRemove
boolean or null

Supprimer automatiquement le conteneur à la fin de son processus. Sans effet si RestartPolicy est défini.

Binds
Tableau de strings or null

Liste des montages de volumes pour ce conteneur. Chaque montage est une chaîne sous l’une des formes suivantes : - host-src:container-dest[:options] pour monter un chemin de l’hôte dans le conteneur. host-src et container-dest doivent tous deux être des chemins absolus. - volume-name:container-dest[:options] pour monter dans le conteneur un volume géré par un pilote de volumes. container-dest doit être un chemin absolu. options est une liste facultative, séparée par des virgules, des options suivantes : - nocopy désactive la copie automatique des données du chemin du conteneur vers le volume. L’option nocopy s’applique uniquement aux volumes nommés. - [ro|rw] monte le volume en lecture seule ou en lecture-écriture, respectivement. Si l’option est omise ou vaut rw, le montage est en lecture-écriture. - [z|Z] applique des étiquettes SELinux pour autoriser ou interdire la lecture et l’écriture du même volume par plusieurs conteneurs. - z : une étiquette de contenu partagé est appliquée. Elle indique que plusieurs conteneurs peuvent partager le contenu du volume en lecture et en écriture. - Z : une étiquette privée non partagée est appliquée. Elle indique que seul le conteneur actuel peut utiliser le volume privé. Les systèmes comme SELinux exigent des étiquettes appropriées sur le contenu des volumes montés dans un conteneur. Sans étiquette, le système de sécurité peut empêcher les processus du conteneur d’utiliser ce contenu. Par défaut, les étiquettes définies par le système d’exploitation hôte ne sont pas modifiées. - [[r]shared|[r]slave|[r]private] définit le comportement de propagation du montage. Cette option s’applique uniquement aux volumes montés depuis l’hôte, pas aux volumes internes ou nommés. La propagation exige que le point de montage source, où le répertoire source est monté sur l’hôte, possède les propriétés de propagation adéquates. Pour les volumes partagés, le point de montage source doit être shared. Pour les volumes esclaves, il doit être shared ou slave.

Tableau de objects or null (ThrottleDevice)

Limiter le débit de lecture d’un périphérique en octets par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

Tableau de objects or null (ThrottleDevice)

Limiter le débit de lecture d’un périphérique en opérations d’entrée/sortie par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

Tableau de objects or null (ThrottleDevice)

Limiter le débit d’écriture vers un périphérique en octets par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

Tableau de objects or null (ThrottleDevice)

Limiter le débit d’écriture vers un périphérique en opérations d’entrée/sortie par seconde, sous la forme : [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

BlkioWeight
integer or null <int32> >= 0

Poids relatif des entrées/sorties par blocs.

Tableau de objects or null (ResourcesBlkioWeightDevice)

Poids des entrées/sorties par blocs, relatif au périphérique, sous la forme : [{\"Path\": \"device_path\", \"Weight\": weight}]

Array
Path
string or null
Weight
integer or null >= 0
CapAdd
Tableau de strings or null

Liste des capacités du noyau à ajouter au conteneur. Incompatible avec l’option 'Capabilities'.

CapDrop
Tableau de strings or null

Liste des capacités du noyau à retirer du conteneur. Incompatible avec l’option 'Capabilities'.

Cgroup
string or null

Cgroup à utiliser pour le conteneur.

null or HostConfigCgroupnsModeEnum (string)
One of
null
CgroupParent
string or null

Chemin de cgroups sous lequel le cgroup du conteneur est créé. Si ce chemin n’est pas absolu, il est considéré comme relatif au chemin cgroups du processus init. Les cgroups sont créés s’ils n’existent pas déjà.

ConsoleSize
Tableau de integers or null <int32> [ items <int32 > ]

Taille initiale de la console, sous forme de tableau [height, width].

ContainerIDFile
string or null

Chemin d’un fichier où écrire l’identifiant du conteneur.

CpuCount
integer or null <int64>

Nombre de CPU utilisables ; Windows uniquement. Pour les conteneurs Windows Server, les contrôles de ressources CPU sont mutuellement exclusifs. L’ordre de priorité est CPUCount, puis CPUShares, puis CPUPercent.

CpuPercent
integer or null <int64>

Pourcentage utilisable des CPU disponibles ; Windows uniquement. Pour les conteneurs Windows Server, les contrôles de ressources CPU sont mutuellement exclusifs. L’ordre de priorité est CPUCount, puis CPUShares, puis CPUPercent.

CpuPeriod
integer or null <int64>

Durée d’une période CPU en microsecondes.

CpuQuota
integer or null <int64>

Microsecondes de temps CPU que le conteneur peut utiliser pendant une période CPU.

CpuRealtimePeriod
integer or null <int64>

Durée d’une période CPU temps réel en microsecondes. Définir 0 pour n’allouer aucun temps aux tâches temps réel.

CpuRealtimeRuntime
integer or null <int64>

Durée d’exécution CPU temps réel en microsecondes. Définir 0 pour n’allouer aucun temps aux tâches temps réel.

CpusetCpus
string or null

CPU autorisés pour l’exécution, par exemple 0-3 ou 0,1.

CpusetMems
string or null

Nœuds mémoire (MEMs) autorisés pour l’exécution (0-3, 0,1). Effectif uniquement sur les systèmes NUMA.

CpuShares
integer or null <int64>

Valeur entière représentant le poids CPU relatif de ce conteneur par rapport aux autres.

DeviceCgroupRules
Tableau de strings or null

Liste des règles cgroup à appliquer au conteneur.

Tableau de objects or null (DeviceRequest)

Liste des demandes de périphériques à envoyer aux pilotes.

Array
Capabilities
Tableau de strings or null[ items ]

Liste de capacités : une disjonction (OR) de listes de conjonctions (AND) de capacités.

Count
integer or null <int64>
DeviceIDs
Tableau de strings or null
Driver
string or null
object or null

Options propres au pilote, sous forme de paires clé/valeur. Elles sont transmises directement au pilote.

Tableau de objects or null (DeviceMapping)

Liste des périphériques à ajouter au conteneur.

Array
CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
Dns
Tableau de strings or null

Liste des serveurs DNS à utiliser par le conteneur.

DnsOptions
Tableau de strings or null

Liste des options DNS.

DnsSearch
Tableau de strings or null

Liste des domaines de recherche DNS.

ExtraHosts
Tableau de strings or null

Liste des correspondances entre noms d’hôtes et adresses IP à ajouter au fichier /etc/hosts du conteneur. Format : [\"hostname:IP\"].

GroupAdd
Tableau de strings or null

Liste des groupes supplémentaires auxquels appartiendra le processus du conteneur.

Init
boolean or null

Exécuter un processus init dans le conteneur pour transmettre les signaux et récolter les processus terminés. Si ce champ est vide, il est omis et la valeur par défaut du démon est utilisée.

IOMaximumBandwidth
integer or null <int64>

Débit maximal des entrées/sorties du disque système du conteneur, en octets par seconde ; Windows uniquement.

IOMaximumIOps
integer or null <int64>

Nombre maximal d’opérations d’entrée/sortie par seconde pour le disque système du conteneur ; Windows uniquement.

IpcMode
string or null

Mode de partage IPC du conteneur. Valeurs possibles : - \"none\" : espace de noms IPC privé, sans montage de /dev/shm - \"private\" : espace de noms IPC privé - \"shareable\" : espace de noms IPC privé pouvant être partagé avec d’autres conteneurs - \"container:<name|id>\" : rejoindre l’espace de noms IPC d’un autre conteneur partageable - \"host\" : utiliser l’espace de noms IPC du système hôte. Si aucune valeur n’est fournie, la valeur par défaut du démon est utilisée : \"private\" ou \"shareable\", selon sa version et sa configuration.

null or HostConfigIsolationEnum (string)
One of
null
KernelMemoryTCP
integer or null <int64>

Limite stricte de la mémoire des tampons TCP du noyau, en octets. Cette option peut être ignorée selon le moteur OCI utilisé. Elle n’est plus prise en charge par le moteur par défaut (runc). Ce champ est omis lorsqu’il est vide.

Links
Tableau de strings or null

Liste des liens du conteneur sous la forme container_name:alias.

null or HostConfigLogConfig (object)
One of
null
MaskedPaths
Tableau de strings or null

Liste des chemins à masquer dans le conteneur ; remplace la liste de chemins par défaut.

Memory
integer or null <int64>

Limite de mémoire en octets.

MemoryReservation
integer or null <int64>

Limite souple de mémoire en octets.

MemorySwap
integer or null <int64>

Limite totale de mémoire, mémoire et swap comprises. Définir -1 pour autoriser un swap illimité.

MemorySwappiness
integer or null <int64>

Ajuster le comportement de swappiness de la mémoire du conteneur. Accepte un entier de 0 à 100.

Tableau de objects or null (Mount)

Spécification des montages à ajouter au conteneur.

Array
null or MountBindOptions (object)
Consistency
string or null

Exigence de cohérence du montage : default, consistent, cached ou delegated.

ReadOnly
boolean or null

Indique si le montage doit être accessible en lecture seule.

Source
string or null

Source du montage, par exemple un nom de volume ou un chemin de l’hôte.

Target
string or null

Chemin du conteneur.

null or MountTmpfsOptions (object)
null or MountTypeEnum (string)
null or MountVolumeOptions (object)
NanoCpus
integer or null <int64>

Quota CPU en unités de 10-9 processeur.

NetworkMode
string or null

Mode réseau à utiliser pour ce conteneur. Les valeurs standard prises en charge sont bridge, host, none et container:<name|id>. Toute autre valeur est interprétée comme le nom d’un réseau personnalisé auquel connecter le conteneur.

OomKillDisable
boolean or null

Désactiver l’OOM killer pour le conteneur.

OomScoreAdj
integer or null <int64>

Valeur entière indiquant le score du conteneur afin d’ajuster les préférences de l’OOM killer.

PidMode
string or null

Définir le mode d’espace de noms PID (processus) du conteneur. Valeurs possibles : - \"container:<name|id>\" : rejoindre l’espace de noms PID d’un autre conteneur - \"host\" : utiliser l’espace de noms PID de l’hôte dans le conteneur.

PidsLimit
integer or null <int64>

Ajuster la limite de PID du conteneur. Définir 0 ou -1 pour ne pas limiter, ou null pour ne rien modifier.

null or HashMap (object)
One of
null
Privileged
boolean or null

Donne au conteneur un accès complet à l’hôte.

PublishAllPorts
boolean or null

Alloue un port éphémère de l’hôte pour chacun des ports exposés du conteneur. Les ports sont libérés à l’arrêt du conteneur et alloués à son démarrage. Le port alloué peut changer au redémarrage. Il est choisi dans la plage des ports éphémères, qui dépend du noyau. Sous Linux, par exemple, cette plage est définie par /proc/sys/net/ipv4/ip_local_port_range.

ReadonlyPaths
Tableau de strings or null

Liste des chemins à rendre accessibles en lecture seule dans le conteneur ; remplace la liste de chemins par défaut.

ReadonlyRootfs
boolean or null

Monter le système de fichiers racine du conteneur en lecture seule.

null or RestartPolicy (object)
One of
null
Runtime
string or null

Moteur d’exécution à utiliser avec ce conteneur.

SecurityOpt
Tableau de strings or null

Liste de chaînes personnalisant les étiquettes des systèmes MLS, comme SELinux.

ShmSize
integer or null <int64>

Taille de /dev/shm en octets. Si omise, le système utilise 64 Mo.

object or null

Options du pilote de stockage de ce conteneur, sous la forme {\"size\": \"120G\"}.

property name*
additional property
string
object or null

Liste des paramètres du noyau (sysctls) à définir dans le conteneur. Par exemple : {\"net.ipv4.ip_forward\": \"1\"}

property name*
additional property
string
object or null

Correspondance entre les répertoires du conteneur à remplacer par des montages tmpfs et leurs options de montage. Par exemple : { \"/run\": \"rw,noexec,nosuid,size=65536k\" }

property name*
additional property
string
Tableau de objects or null (ResourcesUlimits)

Liste des limites de ressources à définir dans le conteneur. Par exemple : {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}

Array
Hard
integer or null <int64>

Limite stricte.

Name
string or null

Nom de l’ulimit.

Soft
integer or null <int64>

Limite souple.

UsernsMode
string or null

Définit le mode d’espace de noms utilisateur du conteneur lorsque le remappage de ces espaces de noms est activé.

UTSMode
string or null

Espace de noms UTS à utiliser pour le conteneur.

VolumeDriver
string or null

Pilote utilisé par ce conteneur pour monter les volumes.

VolumesFrom
Tableau de strings or null

Liste des volumes à hériter d’un autre conteneur, sous la forme <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)
Valeurs possibles: "EMPTY" "private" "host"
"EMPTY"

HostConfigIsolationEnum

string (HostConfigIsolationEnum)
Valeurs possibles: "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

Architecture matérielle de l’hôte, renvoyée par le moteur Go (GOARCH). La liste complète des valeurs possibles figure dans la documentation Go.

BridgeNfIp6tables
boolean or null

Indique si bridge-nf-call-ip6tables est disponible sur l’hôte.

BridgeNfIptables
boolean or null

Indique si bridge-nf-call-iptables est disponible sur l’hôte.

CDISpecDirs
Tableau de strings or null

Liste des répertoires contenant les spécifications CDI (Container Device Interface). Ces spécifications définissent des modifications propres aux fournisseurs dans la spécification OCI du conteneur à créer. Une liste vide indique que l’injection de périphériques CDI est désactivée. Cette injection exige l’activation du mode expérimental du démon. Les démons non expérimentaux renvoient donc toujours une liste vide.

null or SystemInfoCgroupDriverEnum (string)
One of
null
null or SystemInfoCgroupVersionEnum (string)
One of
null
required
object (DaemonConfig)

Configuration du démon.

advertise_addr
required
string

Adresse à annoncer aux autres nœuds.

conf_dir
required
string

Répertoire de configuration.

docker_host
string

Hôte Docker à utiliser.

gateway
required
string

Passerelle de l’hôte, détectée automatiquement à partir de sa passerelle par défaut si aucune valeur n’est définie.

gid
required
integer <int32> >= 0

Identifiant du groupe.

hostname
required
string

Nom d’hôte à utiliser pour le nœud, détecté automatiquement s’il n’est pas défini.

hosts
required
Tableau de strings

Liste des hôtes sur lesquels écouter.

nodes
required
Tableau de strings

Liste des nœuds à rejoindre.

null or SslConfig (object)
state_dir
required
string

Chemin du répertoire d’état.

store_addr
string or null

Adresse du stockage auquel se connecter.

null or Commit (object)
One of
null
Containers
integer or null <int64>

Nombre total de conteneurs sur l’hôte.

ContainersPaused
integer or null <int64>

Nombre de conteneurs dont l’état est \"paused\".

ContainersRunning
integer or null <int64>

Nombre de conteneurs dont l’état est \"running\".

ContainersStopped
integer or null <int64>

Nombre de conteneurs dont l’état est \"stopped\".

CpuCfsPeriod
boolean or null

Indique si l’hôte prend en charge la période CPU CFS (Completely Fair Scheduler).

CpuCfsQuota
boolean or null

Indique si l’hôte prend en charge le quota CPU CFS (Completely Fair Scheduler).

CPUSet
boolean or null

Indique si l’hôte prend en charge les CPUsets (cpuset.cpus, cpuset.mems). Voir cpuset(7).

CPUShares
boolean or null

Indique si l’hôte prend en charge la limitation par parts CPU.

Debug
boolean or null

Indique si le démon fonctionne en mode débogage avec une journalisation de niveau debug.

Tableau de objects or null (SystemInfoDefaultAddressPools)

Liste des plages d’adresses par défaut personnalisées pour les réseaux locaux, définies dans daemon.json ou par une option dockerd. Par exemple, une Base "10.10.0.0/16" avec une Size de 24 définit 256 plages d’adresses 10.10.[0-255].0/24.

Array
Base
string or null

Adresse réseau au format CIDR.

Size
integer or null <int64>

Taille de la plage réseau.

DefaultRuntime
string or null

Nom du moteur OCI par défaut utilisé au démarrage des conteneurs. Cette valeur peut être remplacée pour chaque conteneur à sa création.

DockerRootDir
string or null

Répertoire racine de l’état persistant Docker. Par défaut : /var/lib/docker sous Linux et C:\\ProgramData\\docker sous Windows.

Driver
string or null

Nom du pilote de stockage utilisé.

DriverStatus
Tableau de strings or null[ items ]

Informations propres au pilote de stockage, sous forme de paires "label" / "value". Elles sont fournies par le pilote et présentées de façon cohérente avec la sortie de docker info en ligne de commande.


> Remarque : les informations de ce champ, y compris le format des valeurs et des étiquettes, ne doivent pas être considérées comme stables et peuvent changer sans préavis.

ExperimentalBuild
boolean or null

Indique si les fonctionnalités expérimentales sont activées sur le démon.

null or GenericResourcesInner (object)
One of
null
HostGateway
required
string

HostGateway est l’adresse de passerelle de l’hôte.

HttpProxy
string or null

Proxy HTTP configuré pour le démon. Cette valeur provient de la variable d’environnement HTTP_PROXY. Les identifiants, dans la composante d’informations utilisateur de l’URL du proxy, sont masqués dans la réponse de l’API. Les conteneurs n’héritent pas automatiquement de cette configuration.

HttpsProxy
string or null

Proxy HTTPS configuré pour le démon. Cette valeur provient de la variable d’environnement HTTPS_PROXY. Les identifiants, dans la composante d’informations utilisateur de l’URL du proxy, sont masqués dans la réponse de l’API. Les conteneurs n’héritent pas automatiquement de cette configuration.

ID
string or null

Identifiant unique du démon.


> Remarque : le format de l’identifiant lui-même ne fait pas partie de l’API et ne doit pas être considéré comme stable.

Images
integer or null <int64>

Nombre total d’images sur l’hôte, avec ou sans étiquette, y compris les images orphelines.

IndexServerAddress
string or null

Adresse ou URL du serveur d’index utilisé pour rechercher des images et, par défaut, pour authentifier les utilisateurs auprès de Docker Hub et Docker Cloud.

InitBinary
string or null

Nom et chemin facultatif du binaire docker-init. Si le chemin est omis, le démon recherche le binaire dans le $PATH de l’hôte et utilise le premier résultat.

null or Commit (object)
One of
null
IPv4Forwarding
boolean or null

Indique si le transfert IPv4 est activé.

null or SystemInfoIsolationEnum (string)
One of
null
KernelMemoryTCP
boolean or null

Indique si l’hôte prend en charge la limite TCP de mémoire noyau. Ce champ est omis si elle n’est pas prise en charge. Les limites TCP de mémoire noyau ne sont pas disponibles avec cgroups v2, qui ne prend pas en charge le cgroup memory.kmem.tcp.limit_in_bytes correspondant.

KernelVersion
string or null

Version du noyau de l’hôte. Sous Linux, ces informations proviennent de uname. Sous Windows, elles sont lues dans la valeur de registre HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\, par exemple "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Labels
Tableau de strings or null

Étiquettes définies par l’utilisateur, sous forme de métadonnées clé/valeur, sur le démon.


> Remarque : dans un Swarm, les nœuds peuvent avoir des étiquettes de démon, définies dans sa configuration, et des étiquettes de nœud, définies depuis un nœud gestionnaire du Swarm. Les étiquettes de nœud ne figurent pas dans ce champ. Elles peuvent être récupérées par le point d’accès /nodes/(id) sur un nœud gestionnaire du Swarm.

LiveRestoreEnabled
boolean or null

Indique si live restore est activé. Dans ce cas, les conteneurs continuent à fonctionner à l’arrêt du démon, ou à son démarrage si des conteneurs en cours d’exécution sont détectés.

LoggingDriver
string or null

Pilote de journalisation à utiliser par défaut pour les nouveaux conteneurs.

MemoryLimit
boolean or null

Indique si l’hôte prend en charge les limites de mémoire.

MemTotal
integer or null <int64>

Quantité totale de mémoire physique disponible sur l’hôte, en octets.

Name
string or null

Nom d’hôte de l’hôte.

NCPU
integer or null <int64>

Nombre de CPU logiques utilisables par le démon. Le nombre de CPU disponibles est obtenu auprès du système d’exploitation au démarrage du démon. Les changements d’allocation CPU effectués ensuite ne sont pas reflétés.

required
object (Network)

Configuration réseau.

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>

Nombre d’écouteurs d’événements abonnés.

NFd
integer or null <int64>

Nombre total de descripteurs de fichiers utilisés par le processus du démon. Ces informations sont renvoyées uniquement si le mode débogage est activé.

NGoroutines
integer or null <int64>

Nombre actuel de goroutines. Ces informations sont renvoyées uniquement si le mode débogage est activé.

NoProxy
string or null

Liste, séparée par des virgules, des extensions de domaine pour lesquelles aucun proxy ne doit être utilisé. Cette valeur provient de la variable d’environnement NO_PROXY. Les conteneurs n’héritent pas automatiquement de cette configuration.

OomKillDisable
boolean or null

Indique si l’hôte permet de désactiver l’OOM killer.

OperatingSystem
string or null

Nom du système d’exploitation de l’hôte, par exemple "Ubuntu 16.04.2 LTS" ou "Windows Server 2016 Datacenter".

OSType
string or null

Type générique du système d’exploitation de l’hôte, renvoyé par le moteur Go (GOOS). Les valeurs actuellement renvoyées sont "linux" et "windows". La liste complète des valeurs possibles figure dans la documentation Go.

OSVersion
string or null

Version du système d’exploitation de l’hôte.


> Remarque : les informations de ce champ, y compris son existence et le format de ses valeurs, ne doivent pas être considérées comme stables et peuvent changer sans préavis.

PidsLimit
boolean or null

Indique si le noyau de l’hôte prend en charge les limites de PID.

null or PluginsInfo (object)
One of
null
ProductLicense
string or null

Récapitulatif de la licence du produit sur le démon. Si une licence commerciale est appliquée, les informations comme le nombre de nœuds et la date d’expiration sont incluses.

null or RegistryServiceConfig (object)
One of
null
null or Commit (object)
One of
null
object or null

Liste des moteurs conformes à OCI configurés sur le démon. Les clés contiennent le "name" utilisé pour référencer le moteur. Le démon Docker s’appuie sur un moteur conforme à OCI, invoqué par le démon containerd, pour accéder aux espaces de noms du noyau Linux, aux cgroups et à SELinux. Le moteur par défaut est runc, configuré automatiquement. Les moteurs supplémentaires configurés par l’utilisateur figurent ici.

additional property
object (Runtime)

Runtime décrit un moteur conforme à OCI. Le démon invoque ce moteur par l’intermédiaire du démon containerd. Les moteurs OCI servent d’interface aux espaces de noms du noyau Linux, aux cgroups et à SELinux.

SecurityOptions
Tableau de strings or null

Liste des fonctions de sécurité activées sur le démon, comme apparmor, seccomp, SELinux, les espaces de noms utilisateur (userns), rootless et no-new-privileges. Les options supplémentaires de chaque fonction peuvent figurer sous forme de listes de paires clé/valeur séparées par des virgules.

ServerVersion
string or null

Chaîne de version du démon.

SwapLimit
boolean or null

Indique si l’hôte prend en charge les limites de mémoire swap.

null or SwarmInfo (object)
One of
null
SystemTime
string or null

Heure système actuelle au format RFC 3339, avec les nanosecondes.

Warnings
Tableau de strings or null

Liste des avertissements et messages d’information sur les fonctions manquantes ou les problèmes de configuration du démon. Le client peut les afficher pour informer l’utilisateur.

{
  • "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
Valeur: "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 à cibler.

{
  • "Url": "string",
  • "Redirect": { }
}

ImagePullPolicy

string (ImagePullPolicy)
Valeurs possibles: "Never" "Always" "IfNotPresent"

Politique de téléchargement des images des objets de processus (job, cargo, vm).

"Never"

IndexInfo

Mirrors
Tableau de strings or null

Liste des miroirs, exprimés sous forme d’URI.

Name
string or null

Nom du registre, par exemple "docker.io".

Official
boolean or null

Indique s’il s’agit d’un registre officiel, c’est-à-dire Docker Hub / docker.io.

Secure
boolean or null

Indique si le registre figure dans la liste des registres non sécurisés. Si false, le registre n’est pas sécurisé. Ces registres acceptent des communications non chiffrées (HTTP) et/ou non fiables (HTTPS avec des certificats d’autorités inconnues). > Avertissement : les registres non sécurisés peuvent être utiles pour exécuter un registre local. Cependant, leur utilisation crée des vulnérabilités et doit être activée UNIQUEMENT pour les tests. Pour plus de sécurité, ajoutez plutôt votre autorité de certification à la liste des autorités de confiance du système.

{
  • "Name": "string",
  • "Mirrors": [
    ],
  • "Secure": true,
  • "Official": true
}

Ipam

Tableau de objects or null (IpamConfig)

Liste des options de configuration IPAM, sous forme de table : {\"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

Nom du pilote IPAM à utiliser.

object or null

Options propres au pilote, sous forme de table de correspondance.

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>

Date de création de la tâche.

required
object (JobSpec)

Spécification de la tâche.

required
Tableau de objects (Config)

Conteneurs à exécuter.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la tâche.

Schedule
string or null

Planification de la tâche (cron).

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

required
object (ObjPsStatus)

État de la tâche.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>

Date de mise à jour de la tâche.

{
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

JobInspect

CreatedAt
required
string <date-time>

Date de création de la tâche.

InstanceFailed
required
integer >= 0

Nombre d’instances ayant échoué.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

required
Tableau de objects (Process)

Liste des instances.

Array
CreatedAt
required
string <date-time>

Date de création.

required
object (ContainerInspectResponse)

Données du processus : un ContainerInspect.

IpAddress
string or null

Adresse IP effective résolue à partir du dernier état observé du processus.

Key
required
string

Clé du processus.

Kind
required
string (ProcessKind)
Valeurs possibles: "vm" "job" "cargo"

Type du processus (Job, Vm, Cargo).

KindKey
required
string

Clé canonique de la ressource pour les Cargoes et les VM ; les tâches utilisent leur nom.

Name
required
string

Nom du processus.

NodeName
required
string

Nom du nœud sur lequel le conteneur s’exécute.

UpdatedAt
required
string <date-time>

Date de dernière mise à jour de l’instance.

InstanceSuccess
required
integer >= 0

Nombre d’instances ayant réussi.

InstanceTotal
required
integer >= 0

Nombre d’instances.

required
object (JobSpec)

Spécification de la tâche.

required
Tableau de objects (Config)

Conteneurs à exécuter.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la tâche.

Schedule
string or null

Planification de la tâche (cron).

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

required
object (ObjPsStatus)

État de la tâche.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>

Date de mise à jour de la tâche.

{
  • "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
Tableau de objects (Config)

Liste des conteneurs à exécuter.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or NetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

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

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la tâche.

Schedule
string or null

Expression cron à cinq champs ou raccourci pris en charge ; voir [crate::cron::validate_schedule].

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

JobSpec

required
Tableau de objects (Config)

Conteneurs à exécuter.

Array
ArgsEscaped
boolean or null

La commande est déjà échappée ; Windows uniquement.

AttachStderr
boolean or null

Indique s’il faut se connecter à stderr.

AttachStdin
boolean or null

Indique s’il faut se connecter à stdin.

AttachStdout
boolean or null

Indique s’il faut se connecter à stdout.

Cmd
Tableau de strings or null

Commande à exécuter, sous forme de chaîne ou de tableau de chaînes.

Domainname
string or null

Nom de domaine à utiliser pour le conteneur.

Entrypoint
Tableau de strings or null

Point d’entrée du conteneur, sous forme de chaîne ou de tableau de chaînes. Si le tableau contient exactement une chaîne vide ([\"\"]), le point d’entrée est réinitialisé à la valeur par défaut du système, utilisée par Docker lorsqu’aucune instruction ENTRYPOINT ne figure dans le Dockerfile.

Env
Tableau de strings or null

Liste des variables d’environnement à définir dans le conteneur, sous la forme [\"VAR=value\", ...]. Une variable sans = est supprimée de l’environnement, au lieu de recevoir une valeur vide.

object or null

Objet associant les ports à un objet vide sous la forme : {\"<port>/<tcp|udp|sctp>\": {}}

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

Nom d’hôte à utiliser pour le conteneur, conforme à la RFC 1123.

Image
string or null

Nom de l’image à utiliser pour créer le conteneur.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC du conteneur.

NetworkDisabled
boolean or null

Désactiver le réseau pour le conteneur.

null or NetworkingConfig_String (object)
OnBuild
Tableau de strings or null

Métadonnées ONBUILD définies dans le Dockerfile de l’image.

OpenStdin
boolean or null

Ouvrir stdin.

Shell
Tableau de strings or null

Shell utilisé lorsque RUN, CMD et ENTRYPOINT utilisent un shell.

StdinOnce
boolean or null

Fermer stdin après la déconnexion d’un client connecté.

StopSignal
string or null

Signal d’arrêt du conteneur, sous forme de chaîne ou d’entier non signé.

StopTimeout
integer or null <int64>

Délai d’arrêt d’un conteneur en secondes.

Tty
boolean or null

Connecter les flux standard à un TTY, y compris stdin s’il n’est pas fermé.

User
string or null

Utilisateur sous lequel les commandes s’exécutent dans le conteneur.

object or null

Objet associant les chemins des points de montage dans le conteneur à des objets vides.

WorkingDir
string or null

Répertoire de travail où exécuter les commandes.

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

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la tâche.

Schedule
string or null

Planification de la tâche (cron).

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

JobSummary

CreatedAt
required
string <date-time>

Date de création de la tâche.

InstanceFailed
required
integer >= 0

Nombre d’instances ayant échoué.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

InstanceSuccess
required
integer >= 0

Nombre d’instances ayant réussi.

InstanceTotal
required
integer >= 0

Nombre d’instances.

required
object (JobSpec)

Spécification de la tâche.

required
Tableau de objects (Config)

Conteneurs à exécuter.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la tâche.

Schedule
string or null

Planification de la tâche (cron).

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

required
object (ObjPsStatus)

État de la tâche.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>

Date de mise à jour de la tâche.

{
  • "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

Taille de la rafale.

Delay
integer or null >= 0

Délai d’attente avant une nouvelle tentative.

{
  • "Burst": 0,
  • "Delay": 0
}

LimitReqZone

Rate
required
integer >= 0

Nombre maximal de requêtes par seconde.

Size
required
integer >= 0

Taille maximale du cache en mégaoctets.

{
  • "Size": 0,
  • "Rate": 0
}

LocalNodeState

string (LocalNodeState)
Valeurs possibles: "EMPTY" "inactive" "pending" "active" "error" "locked"

État local actuel de ce nœud. Énumération des valeurs. Les variantes de cette énumération ne contenant aucune donnée, elles peuvent être définies avec #[repr(C)], ce qui facilite les interfaces FFI.

"EMPTY"

LocationTarget

One of
DisableLogging
boolean or null

Désactiver la journalisation pour cette cible.

Key
required
string

Clé du Cargo ou de la VM à cibler.

Path
string or null

Chemin HTTP à cibler lors de l’utilisation de HTTP.

Port
required
integer <int32> >= 0

Port du Cargo ou de la VM à cibler.

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>

Date de création de la métrique.

Data
required
any

Données de la métrique.

ExpiresAt
required
string <date-time>

Date d’expiration de la métrique.

Key
required
string <uuid>

Clé de la métrique dans la base de données UUID.

Kind
required
string

Type de la métrique.

NodeName
required
string

Nœud d’origine de la métrique.

Note
string or null

Note facultative sur la métrique.

{
  • "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

Données de la métrique.

Kind
required
string

Type de la métrique.

Note
string or null

Note facultative sur la métrique.

{
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Mount

null or MountBindOptions (object)
One of
null
Consistency
string or null

Exigence de cohérence du montage : default, consistent, cached ou delegated.

ReadOnly
boolean or null

Indique si le montage doit être accessible en lecture seule.

Source
string or null

Source du montage, par exemple un nom de volume ou un chemin de l’hôte.

Target
string or null

Chemin du conteneur.

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

Créer le point de montage sur l’hôte s’il est absent.

NonRecursive
boolean or null

Désactiver le montage lié récursif.

null or MountBindOptionsPropagationEnum (string)
One of
null
ReadOnlyForceRecursive
boolean or null

Signaler une erreur si le montage ne peut pas être rendu récursivement accessible en lecture seule.

ReadOnlyNonRecursive
boolean or null

Rendre le montage lui-même accessible en lecture seule sans appliquer cette propriété récursivement, tout en conservant le montage récursif, sauf si NonRecursive vaut aussi true. Ajouté en v1.44 ; auparavant, tous les montages en lecture seule étaient non récursifs par défaut. Pour reproduire cet ancien comportement, la valeur par défaut est true pour les clients antérieurs à v1.44.

{
  • "Propagation": { },
  • "NonRecursive": true,
  • "CreateMountpoint": true,
  • "ReadOnlyNonRecursive": true,
  • "ReadOnlyForceRecursive": true
}

MountBindOptionsPropagationEnum

string (MountBindOptionsPropagationEnum)
Valeurs possibles: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
"EMPTY"

MountPoint

Destination
string or null

Destination est le chemin relatif à la racine du conteneur (/) où Source est monté dans le conteneur.

Driver
string or null

Driver est le pilote de volumes utilisé pour créer le volume, s’il s’agit d’un volume.

Mode
string or null

Mode est une liste d’options séparées par des virgules, fournies par l’utilisateur à la création du montage lié ou du volume. La valeur par défaut dépend de la plateforme : \"z\" sous Linux, vide sous Windows.

Name
string or null

Name est le nom faisant référence aux données sous-jacentes définies par Source, par exemple le nom du volume.

Propagation
string or null

Propagation décrit la propagation des montages de l’hôte vers le point de montage, et inversement. Voir la documentation du noyau Linux pour les détails. Ce champ n’est pas utilisé sous Windows.

RW
boolean or null

Indique si le montage est accessible en écriture, c’est-à-dire en lecture-écriture.

Source
string or null

Emplacement source du montage. Pour les volumes, il contient l’emplacement de stockage du volume dans /var/lib/docker/volumes/. Pour les montages liés et npipe, il contient la partie source sur l’hôte. Pour les points de montage tmpfs, ce champ est vide.

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)
Valeurs possibles: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountTmpfsOptions

Mode
integer or null <int64>

Mode des permissions du montage tmpfs, sous forme d’entier.

SizeBytes
integer or null <int64>

Taille du montage tmpfs en octets.

{
  • "SizeBytes": 0,
  • "Mode": 0
}

MountTypeEnum

string (MountTypeEnum)
Valeurs possibles: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountVolumeOptions

null or MountVolumeOptionsDriverConfig (object)
One of
null
object or null

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
NoCopy
boolean or null

Remplir le volume avec les données de la cible.

Subpath
string or null

Chemin source dans le volume. Doit être relatif et ne pas remonter vers les répertoires parents.

{
  • "NoCopy": true,
  • "Labels": {
    },
  • "DriverConfig": { },
  • "Subpath": "string"
}

MountVolumeOptionsDriverConfig

Name
string or null

Nom du pilote à utiliser pour créer le volume.

object or null

Table clé/valeur des options propres au pilote.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

Namespace

CreatedAt
required
string <date-time>

Date de création de l’espace de noms.

Metadata
any

Métadonnées définies par l’utilisateur.

Name
required
string

Nom servant de clé primaire à l’espace de noms.

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null
}

NamespaceInspect

required
Tableau de objects (CargoInspect)

Nombre de Cargoes.

Array
CreatedAt
required
string <date-time>

Date de création du Cargo.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

required
Tableau de objects (Process)

Liste des instances.

InstanceTotal
required
integer >= 0

Nombre d’instances.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (CargoSpecRevision)

Spécification du Cargo.

required
object (ObjPsStatus)

État du Cargo.

Name
required
string

Nom de l’espace de noms.

{
  • "Name": "string",
  • "Cargoes": [
    ]
}

NamespacePartial

Metadata
any

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de l’espace de noms.

{
  • "Name": "string",
  • "Metadata": null
}

NamespaceSummary

Cargoes
required
integer >= 0

Nombre de Cargoes.

CreatedAt
required
string <date-time>

Date de création de l’espace de noms.

Instances
required
integer >= 0

Nombre d’instances.

Name
required
string

Nom de l’espace de noms.

{
  • "Name": "string",
  • "Cargoes": 0,
  • "Instances": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z"
}

NativeEventAction

One of
string
Valeur: "create"

Action indique l’action ayant déclenché l’événement.

{
  • "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

Sélecteur réservé, adresse IP ou nom de réseau défini par l’utilisateur.

{
  • "Other": "string"
}

NetworkSettings

Bridge
string or null

Nom de l’interface bridge par défaut lorsque l’option --bridge de dockerd est définie.

EndpointID
string or null

EndpointID identifie de manière unique un point d’accès de service dans un Sandbox.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

Gateway
string or null

Adresse de passerelle du réseau "bridge" par défaut.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

GlobalIPv6Address
string or null

Adresse IPv6 globale du réseau "bridge" par défaut.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

GlobalIPv6PrefixLen
integer or null <int64>

Longueur du masque de l’adresse IPv6 globale.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

HairpinMode
boolean or null

Indique si le NAT hairpin doit être activé sur l’interface virtuelle. Obsolète : ce champ n’est jamais renseigné et sera supprimé dans une prochaine version.

IPAddress
string or null

Adresse IPv4 du réseau "bridge" par défaut.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

IPPrefixLen
integer or null <int64>

Longueur du masque de l’adresse IPv4.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

IPv6Gateway
string or null

Adresse de passerelle IPv6 de ce réseau.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

LinkLocalIPv6Address
string or null

Adresse IPv6 unicast utilisant le préfixe de liaison locale. Obsolète : ce champ n’est jamais renseigné et sera supprimé dans une prochaine version.

LinkLocalIPv6PrefixLen
integer or null <int64>

Longueur du préfixe de l’adresse IPv6 unicast. Obsolète : ce champ n’est jamais renseigné et sera supprimé dans une prochaine version.

MacAddress
string or null

Adresse MAC du conteneur sur le réseau "bridge" par défaut.


> Obsolète : ce champ est transmis uniquement lors de la connexion au réseau "bridge" par défaut. Utilisez plutôt les informations du réseau "bridge" dans la table Networks, qui contient les mêmes données. Ce champ est obsolète depuis Docker 1.9 et sa suppression est prévue dans Docker 17.12.0.

object or null

Informations sur tous les réseaux auxquels le conteneur est connecté.

additional property
object (EndpointSettings)

Configuration d’un point de connexion réseau.

null or HashMap (object)
One of
null
SandboxID
string or null

SandboxID identifie de manière unique la pile réseau d’un conteneur.

SandboxKey
string or null

SandboxKey est le chemin complet du descripteur netns.

Tableau de objects or null (Address)

Obsolète : ce champ n’est jamais renseigné et sera supprimé dans une prochaine version.

Array
Addr
string or null

Adresse IP.

PrefixLen
integer or null <int64>

Longueur du masque de l’adresse IP.

Tableau de objects or null (Address)

Obsolète : ce champ n’est jamais renseigné et sera supprimé dans une prochaine version.

Array
Addr
string or null

Adresse IP.

PrefixLen
integer or null <int64>

Longueur du masque de l’adresse 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)

Configuration d’un point de connexion réseau.

{
  • "EndpointsConfig": {
    }
}

NginxDuration

string (NginxDuration)

Valeur de délai nginx validée, par exemple 900s ou 5m.

"string"

NginxSize

string (NginxSize)

Valeur de taille nginx validée, par exemple 0, 10m ou 2g.

"string"

Node

CreatedAt
required
string <date-time>

Date de création.

Endpoint
required
string

Point d’accès pour se connecter au nœud.

Metadata
any

Métadonnées définies par l’utilisateur.

Name
required
string

Nom du nœud.

Version
required
string

Version du nœud.

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Endpoint": "string",
  • "Version": "string",
  • "Metadata": null
}

NodeConstraint

Key
required
string

Clé de contrainte, par exemple "region", "label" ou "group".

Operator
required
string (ConstraintOp)
Valeurs possibles: "Eq" "Ne"

Opérateur de contrainte (Eq/Ne).

Value
required
string

Valeur de contrainte.

{
  • "Key": "string",
  • "Operator": "Eq",
  • "Value": "string"
}

ObjPsHealthStatusKind

string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
"healthy"

ObjPsStatus

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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)
Valeurs possibles: "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

Adresse IP et ports permettant de joindre ce nœud.

NodeID
string or null

Identifiant unique de ce nœud dans le swarm.

{
  • "NodeID": "string",
  • "Addr": "string"
}

PidsStats

current
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
{
  • "current": 0,
  • "limit": 0
}

PluginsInfo

Authorization
Tableau de strings or null

Noms des extensions d’autorisation disponibles.

Log
Tableau de strings or null

Noms des pilotes et extensions de journalisation disponibles.

Network
Tableau de strings or null

Noms des pilotes et extensions réseau disponibles.

Volume
Tableau de strings or null

Noms des pilotes de volumes et des extensions réseau disponibles.

{
  • "Volume": [
    ],
  • "Network": [
    ],
  • "Authorization": [
    ],
  • "Log": [
    ]
}

Primitive

One of
string
true

Process

CreatedAt
required
string <date-time>

Date de création.

required
object (ContainerInspectResponse)

Données du processus : un ContainerInspect.

AppArmorProfile
string or null
Args
Tableau de strings or null

Arguments de la commande en cours d’exécution.

null or ContainerConfig (object)
Created
string or null

Date de création du conteneur.

Driver
string or null
ExecIDs
Tableau de strings or null

Identifiants des instances exec en cours d’exécution dans le conteneur.

null or GraphDriverData (object)
null or HostConfig (object)
HostnamePath
string or null
HostsPath
string or null
Id
string or null

Identifiant du conteneur.

Image
string or null

Identifiant de l’image du conteneur.

LogPath
string or null
MountLabel
string or null
Tableau de objects or null (MountPoint)
Name
string or null
null or NetworkSettings (object)
Path
string or null

Chemin de la commande en cours d’exécution.

Platform
string or null
ProcessLabel
string or null
ResolvConfPath
string or null
RestartCount
integer or null <int64>
SizeRootFs
integer or null <int64>

Taille totale de tous les fichiers de ce conteneur.

SizeRw
integer or null <int64>

Taille des fichiers créés ou modifiés par ce conteneur.

null or ContainerState (object)
IpAddress
string or null

Adresse IP effective résolue à partir du dernier état observé du processus.

Key
required
string

Clé du processus.

Kind
required
string (ProcessKind)
Valeurs possibles: "vm" "job" "cargo"

Type du processus (Job, Vm, Cargo).

KindKey
required
string

Clé canonique de la ressource pour les Cargoes et les VM ; les tâches utilisent leur nom.

Name
required
string

Nom du processus.

NodeName
required
string

Nom du nœud sur lequel le conteneur s’exécute.

UpdatedAt
required
string <date-time>

Date de dernière mise à jour de l’instance.

{
  • "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

Se connecter à la sortie d’erreur standard.

AttachStdin
boolean or null

Se connecter à l’entrée standard.

AttachStdout
boolean or null

Se connecter à la sortie standard.

Cmd
Tableau de strings or null

Commande et arguments à exécuter.

DetachKeys
string or null

Séquence de touches de déconnexion compatible Docker.

Env
Tableau de strings or null

Variables d’environnement sous la forme NAME=value.

Privileged
boolean or null

Exécuter la commande avec des privilèges étendus.

Tty
boolean or null

Allouer un pseudo-TTY.

User
string or null

Utilisateur et groupe facultatif pour la commande.

WorkingDir
string or null

Répertoire de travail dans le processus.

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

ProcessExecCreated

Id
required
string

Identifiant d’instance exec appartenant à Docker.

{
  • "Id": "string"
}

ProcessKillOptions

signal
required
string

Signal à envoyer au processus ; SIGKILL par défaut.

{
  • "signal": "string"
}

ProcessKind

string (ProcessKind)
Valeurs possibles: "vm" "job" "cargo"

Type de processus (Vm, Job, Cargo).

"vm"

ProcessStats

Name
required
string
required
object (Stats)

Statistiques du conteneur.

required
object (BlkioStats)

Statistiques des entrées/sorties du conteneur.

required
object (CPUStats)

Statistiques CPU générales du conteneur.

id
string
required
object (MemoryStats)

Statistiques mémoire générales du conteneur.

name
string
null or NetworkStats (object)
object or null
num_procs
required
integer <int32> >= 0
required
object (PidsStats)

Statistiques des identifiants de processus du conteneur.

required
object (CPUStats)

Statistiques CPU générales du conteneur.

preread
required
string
read
required
string
required
object (StorageStats)

Statistiques des entrées/sorties de fichiers du conteneur.

{
  • "Name": "string",
  • "Stats": {
    }
}

ProxyCache

string (ProxyCache)

Valeur validée du cache proxy nginx : off ou une zone de cache configurée.

"string"

ProxyHttp3

One of
boolean

Active HTTP/3 avec les paramètres par défaut.

Example
true

ProxyHttp3Config

ActiveConnectionIdLimit
integer or null >= 0

Paramètre de transport QUIC active_connection_id_limit.

Bpf
boolean or null

Activer le routage des paquets QUIC avec eBPF ; Linux 5.7 ou ultérieur.

Gso
boolean or null

Activer Generic Segmentation Offload pour QUIC ; Linux avec UDP_SEGMENT.

HostKey
string or null

Chemin du fichier de clé hôte QUIC.

Hq
boolean or null

Active la négociation du protocole HTTP/0.9 utilisée dans les tests d’interopérabilité QUIC.

MaxConcurrentStreams
integer or null >= 0

Nombre maximal de flux HTTP/3 simultanés par connexion.

Retry
boolean or null

Activer la validation d’adresse QUIC (retry).

StreamBufferSize
string or null

Taille du tampon des flux QUIC, par exemple "64k" ou "8k".

{
  • "Hq": true,
  • "MaxConcurrentStreams": 0,
  • "StreamBufferSize": "string",
  • "ActiveConnectionIdLimit": 0,
  • "Bpf": true,
  • "Gso": true,
  • "HostKey": "string",
  • "Retry": true
}

ProxyHttpLocation

AllowedIps
Tableau de strings or null

Adresse IP autorisée.

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
Tableau de strings or null

En-têtes supplémentaires à ajouter.

InterceptErrors
boolean or null

Intercepter les erreurs du serveur amont.

null or LimitReq (object)
One of
null
null or ProxyNextUpstream (string)
One of
null
Path
required
string

Chemin.

null or NginxDuration (string)
One of
null
RequestBuffering
boolean or null

Mettre en tampon le corps des requêtes des clients.

ResponseBuffering
boolean or null

Mettre en tampon les réponses du serveur amont.

null or NginxDuration (string)
One of
null
required
object or object or object (LocationTarget)
One of
DisableLogging
boolean or null

Désactiver la journalisation pour cette cible.

Key
required
string

Clé du Cargo ou de la VM à cibler.

Path
string or null

Chemin HTTP à cibler lors de l’utilisation de HTTP.

Port
required
integer <int32> >= 0

Port du Cargo ou de la VM à cibler.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
Version
number or null <double>

Version HTTP à utiliser.

{
  • "Path": "string",
  • "Target": {
    },
  • "LimitReq": { },
  • "AllowedIps": [
    ],
  • "Headers": [
    ],
  • "Version": 0,
  • "ClientMaxBodySize": { },
  • "ClientBodyTimeout": { },
  • "RequestBuffering": true,
  • "ResponseBuffering": true,
  • "Cache": { },
  • "ReadTimeout": { },
  • "SendTimeout": { },
  • "ConnectTimeout": { },
  • "NextUpstream": { },
  • "InterceptErrors": true
}

ProxyNextUpstream

string (ProxyNextUpstream)
Valeur: "off"

Valeurs proxy_next_upstream prises en charge au niveau de l’emplacement.

"off"

ProxyRule

One of
Domain
string or null

Domaine.

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
Tableau de strings or null

Chemin du fichier de configuration supplémentaire à inclure.

null or LimitReqZone (object)
One of
null
required
Tableau de objects (ProxyHttpLocation)

Emplacements pour gérer plusieurs chemins.

Array
AllowedIps
Tableau de strings or null

Adresse IP autorisée.

null or ProxyCache (string)
null or NginxDuration (string)
null or NginxSize (string)
null or NginxDuration (string)
Headers
Tableau de strings or null

En-têtes supplémentaires à ajouter.

InterceptErrors
boolean or null

Intercepter les erreurs du serveur amont.

null or LimitReq (object)
null or ProxyNextUpstream (string)
Path
required
string

Chemin.

null or NginxDuration (string)
RequestBuffering
boolean or null

Mettre en tampon le corps des requêtes des clients.

ResponseBuffering
boolean or null

Mettre en tampon les réponses du serveur amont.

null or NginxDuration (string)
required
object or object or object (LocationTarget)
Version
number or null <double>

Version HTTP à utiliser.

required
string or object or object (NetworkKind)
One of
string

Type de liaison réseau.

Port
integer or null <int32> >= 0

Port d’écoute ; 80 ou 443 par défaut.

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

Domaine.

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
Tableau de strings or null

Chemin du fichier de configuration supplémentaire à inclure.

null or LimitReqZone (object)
One of
null
required
Tableau de objects (ProxyHttpLocation)

Emplacements pour gérer plusieurs chemins.

Array
AllowedIps
Tableau de strings or null

Adresse IP autorisée.

null or ProxyCache (string)
null or NginxDuration (string)
null or NginxSize (string)
null or NginxDuration (string)
Headers
Tableau de strings or null

En-têtes supplémentaires à ajouter.

InterceptErrors
boolean or null

Intercepter les erreurs du serveur amont.

null or LimitReq (object)
null or ProxyNextUpstream (string)
Path
required
string

Chemin.

null or NginxDuration (string)
RequestBuffering
boolean or null

Mettre en tampon le corps des requêtes des clients.

ResponseBuffering
boolean or null

Mettre en tampon les réponses du serveur amont.

null or NginxDuration (string)
required
object or object or object (LocationTarget)
Version
number or null <double>

Version HTTP à utiliser.

required
string or object or object (NetworkKind)
One of
string

Type de liaison réseau.

Port
integer or null <int32> >= 0

Port d’écoute ; 80 ou 443 par défaut.

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

Type de la liaison réseau.

Port
required
integer <int32> >= 0

Port à ouvrir sur les nœuds.

Protocol
required
string (ProxyStreamProtocol)
Valeurs possibles: "Tcp" "Udp"

Protocole à utiliser : Tcp ou 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

Désactiver la journalisation pour cette cible.

Key
required
string

Clé du Cargo ou de la VM à cibler.

Path
string or null

Chemin HTTP à cibler lors de l’utilisation de HTTP.

Port
required
integer <int32> >= 0

Port du Cargo ou de la VM à cibler.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
{
  • "Network": "string",
  • "Protocol": "Tcp",
  • "Port": 0,
  • "Ssl": { },
  • "Target": {
    }
}

ProxySsl

One of
Certificate
required
string

Contenu du certificat lorsqu’il est stocké dans un secret TLS.

CertificateClient
string or null

Contenu du certificat d’autorité lorsqu’il est stocké dans un secret TLS.

CertificateKey
required
string

Contenu de la clé privée lorsqu’elle est stockée dans un secret TLS.

Dhparam
string or null

Contenu des paramètres DH lorsqu’ils sont stockés dans un secret TLS.

VerifyClient
boolean or null

Activer ou désactiver la vérification des clients.

Example
{
  • "Certificate": "string",
  • "CertificateKey": "string",
  • "CertificateClient": "string",
  • "VerifyClient": true,
  • "Dhparam": "string"
}

ProxySslConfig

Certificate
required
string

Contenu du certificat lorsqu’il est stocké dans un secret TLS.

CertificateClient
string or null

Contenu du certificat d’autorité lorsqu’il est stocké dans un secret TLS.

CertificateKey
required
string

Contenu de la clé privée lorsqu’elle est stockée dans un secret TLS.

Dhparam
string or null

Contenu des paramètres DH lorsqu’ils sont stockés dans un secret TLS.

VerifyClient
boolean or null

Activer ou désactiver la vérification des clients.

{
  • "Certificate": "string",
  • "CertificateKey": "string",
  • "CertificateClient": "string",
  • "VerifyClient": true,
  • "Dhparam": "string"
}

ProxyStreamProtocol

string (ProxyStreamProtocol)
Valeurs possibles: "Tcp" "Udp"

Modes des règles de proxy.

"Tcp"

RegistryServiceConfig

AllowNondistributableArtifactsCIDRs
Tableau de strings or null

Liste des plages IP vers lesquelles les artefacts non redistribuables peuvent être envoyés, en syntaxe CIDR RFC 4632. Certaines images, comme les images de base Windows, contiennent des artefacts dont la distribution est limitée par leur licence. Ils sont normalement exclus de l’envoi de ces images à un registre. Cette configuration remplace ce comportement et permet au démon de les envoyer aux registres dont l’adresse IP résolue appartient au sous-réseau CIDR. Cette option est utile pour envoyer de telles images vers un registre d’un réseau isolé, afin que ses hôtes puissent les télécharger sans se connecter à un autre serveur. > Avertissement : les artefacts non redistribuables imposent généralement des restrictions sur leurs modes et lieux de distribution et de partage. Utilisez cette fonctionnalité uniquement pour des registres privés et veillez à respecter toutes les conditions régissant leur redistribution.

AllowNondistributableArtifactsHostnames
Tableau de strings or null

Liste des noms d’hôtes des registres vers lesquels les artefacts non redistribuables peuvent être envoyés, au format <hostname>[:<port>] ou <IP address>[:<port>]. Certaines images, comme les images de base Windows, contiennent des artefacts dont la distribution est limitée par leur licence. Ils sont normalement exclus de l’envoi de ces images à un registre. Cette configuration remplace ce comportement pour les registres indiqués. Elle est utile pour envoyer de telles images vers un registre d’un réseau isolé, afin que ses hôtes puissent les télécharger sans se connecter à un autre serveur. > Avertissement : les artefacts non redistribuables imposent généralement des restrictions sur leurs modes et lieux de distribution et de partage. Utilisez cette fonctionnalité uniquement pour des registres privés et veillez à respecter toutes les conditions régissant leur redistribution.

object or null
additional property
object (IndexInfo)

IndexInfo contient les informations sur un registre.

InsecureRegistryCIDRs
Tableau de strings or null

Liste des plages IP des registres non sécurisés, en syntaxe CIDR (RFC 4632). Ces registres acceptent les communications non chiffrées (HTTP) et/ou non fiables (HTTPS avec des certificats d’autorités inconnues). Par défaut, les registres locaux (127.0.0.0/8) sont configurés comme non sécurisés ; tous les autres sont sécurisés. La communication avec un registre non sécurisé est impossible si le démon le considère comme sécurisé. Cette configuration remplace ce comportement et autorise les communications non sécurisées avec les registres dont l’adresse IP résolue appartient au sous-réseau CIDR. Les registres peuvent également être déclarés non sécurisés par nom d’hôte. Ils figurent alors dans IndexConfigs et leur champ Secure vaut false. > Avertissement : cette option peut être utile pour un registre local, mais introduit des vulnérabilités. Elle doit donc être utilisée UNIQUEMENT pour les tests. Pour plus de sécurité, ajoutez plutôt votre autorité de certification à la liste des autorités de confiance du système.

Mirrors
Tableau de strings or null

Liste des URL de registres servant de miroirs au registre officiel (docker.io).

{
  • "AllowNondistributableArtifactsCIDRs": [
    ],
  • "AllowNondistributableArtifactsHostnames": [
    ],
  • "InsecureRegistryCIDRs": [
    ],
  • "IndexConfigs": {
    },
  • "Mirrors": [
    ]
}

Resource

CreatedAt
required
string <date-time>

Date de création de la ressource.

Kind
required
string

Type de la ressource.

required
object (ResourceSpec)

Spécification de la ressource.

CreatedAt
required
string <date-time>

Date de création de la ressource.

required
object

Données de la ressource sous forme d’objet JSON.

Key
required
string <uuid>

Clé de la ressource.

object

Métadonnées de la ressource, définies par l’utilisateur.

ResourceKey
required
string

Clé de la ressource associée aux données.

Version
required
string

Version de la ressource.

{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

ResourceDnsRule

required
Tableau de objects (DnsEntry)
Array
required
string or object or object (NetworkKind)
Name
required
string
required
string or object or object (NetworkKind)
One of
string

Sélecteur de liaison réseau.

{
  • "Network": "string",
  • "Entries": [
    ]
}

ResourceKind

CreatedAt
required
string <date-time>

Date de création du type.

required
object (ResourceKindSpec)

Date de création du type.

object

JSONSchema des ressources de ce type et de cette version.

Url
string or null

Service à appeler lors de la création, de la mise à jour ou de la suppression d’une ressource de ce type et de cette version.

Metadata
any

Date de création du type.

Name
required
string

Nom du type.

Version
required
string

Date de création du type.

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

ResourceKindInspect

CreatedAt
required
string <date-time>

Date de création du type.

Name
required
string

Nom du type.

required
Tableau de objects (ResourceKindVersion)

Liste des versions disponibles.

Array
CreatedAt
required
string <date-time>

Date de création de la version.

required
object (ResourceKindSpec)

Spécification du type.

Key
required
string <uuid>

Clé de la version.

KindKey
required
string

Type associé à cette version.

object

Métadonnées définies par l’utilisateur.

Version
required
string

Version

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

ResourceKindPartial

required
object (ResourceKindSpec)

Spécification du type de ressource.

object

JSONSchema des ressources de ce type et de cette version.

Url
string or null

Service à appeler lors de la création, de la mise à jour ou de la suppression d’une ressource de ce type et de cette version.

object

Métadonnées du type de ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du type de ressource.

Version
required
string

Version du type de ressource.

{
  • "Name": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

ResourceKindSpec

object

JSONSchema des ressources de ce type et de cette version.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Url
string or null

Service à appeler lors de la création, de la mise à jour ou de la suppression d’une ressource de ce type et de cette version.

{
  • "Schema": {
    },
  • "Url": "string"
}

ResourceKindVersion

CreatedAt
required
string <date-time>

Date de création de la version.

required
object (ResourceKindSpec)

Spécification du type.

object

JSONSchema des ressources de ce type et de cette version.

Url
string or null

Service à appeler lors de la création, de la mise à jour ou de la suppression d’une ressource de ce type et de cette version.

Key
required
string <uuid>

Clé de la version.

KindKey
required
string

Type associé à cette version.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Version
required
string

Version

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

ResourcePartial

required
object

Données de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Kind
required
string

Type de la ressource.

object

Métadonnées de la ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la ressource.

{
  • "Name": "string",
  • "Kind": "string",
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourceProxyRule

required
Tableau de ProxyRuleHttp (object) or ProxyRuleStream (object) (ProxyRule)

Règles à appliquer.

Array
One of
Domain
string or null

Domaine.

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
Includes
Tableau de strings or null

Chemin du fichier de configuration supplémentaire à inclure.

null or LimitReqZone (object)
required
Tableau de objects (ProxyHttpLocation)

Emplacements pour gérer plusieurs chemins.

required
string or object or object (NetworkKind)
Port
integer or null <int32> >= 0

Port d’écoute ; 80 ou 443 par défaut.

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
{
  • "Rules": [
    ]
}

ResourceSpec

CreatedAt
required
string <date-time>

Date de création de la ressource.

required
object

Données de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Key
required
string <uuid>

Clé de la ressource.

object

Métadonnées de la ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

ResourceKey
required
string

Clé de la ressource associée aux données.

Version
required
string

Version de la ressource.

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

ResourceUpdate

required
object

Spécification de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

object

Métadonnées de la ressource sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

{
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourcesBlkioWeightDevice

Path
string or null
Weight
integer or null >= 0
{
  • "Path": "string",
  • "Weight": 0
}

ResourcesUlimits

Hard
integer or null <int64>

Limite stricte.

Name
string or null

Nom de l’ulimit.

Soft
integer or null <int64>

Limite souple.

{
  • "Name": "string",
  • "Soft": 0,
  • "Hard": 0
}

RestartPolicy

MaximumRetryCount
integer or null <int64>

Si on-failure est utilisé, nombre de tentatives avant abandon.

null or RestartPolicyNameEnum (string)
One of
null
{
  • "Name": { },
  • "MaximumRetryCount": 0
}

RestartPolicyNameEnum

string (RestartPolicyNameEnum)
Valeurs possibles: "EMPTY" "no" "always" "unless-stopped" "on-failure"
"EMPTY"

Runtime

path
string or null

Nom et chemin facultatif du binaire exécutable OCI. Si le chemin est omis, le démon recherche le binaire dans le $PATH de l’hôte et utilise le premier résultat.

runtimeArgs
Tableau de strings or null

Liste des arguments de ligne de commande à transmettre au moteur lors de son invocation.

object or null

Informations propres au moteur d’exécution. Cette spécification d’API ne définit pas ces données, mais les moteurs peuvent fournir les propriétés connues suivantes : org.opencontainers.runtime-spec.features, structure des fonctionnalités définie dans la spécification OCI Runtime, représentée par une chaîne JSON.


> Remarque : les informations de ce champ, y compris le format des valeurs et des étiquettes, ne doivent pas être considérées comme stables et peuvent changer sans préavis.

property name*
additional property
string
{
  • "path": "string",
  • "runtimeArgs": [
    ],
  • "status": {
    }
}

Secret

CreatedAt
required
string <date-time>

Date de création.

required
object

Données du secret.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Immutable
required
boolean

Le secret ne peut pas être mis à jour.

Kind
required
string

Type de secret.

object
additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du secret.

UpdatedAt
required
string <date-time>

Date de dernière mise à jour.

{
  • "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

Données du secret.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Immutable
boolean

Le secret ne peut pas être mis à jour.

Kind
required
string

Type de secret.

object

Métadonnées de la ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du secret.

{
  • "Name": "string",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

SecretUpdate

required
object

Données du secret sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

object

Métadonnées du secret, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

{
  • "Metadata": {
    },
  • "Data": {
    }
}

SslConfig

Cert
string or null

Contenu du certificat.

CertCa
string or null

Contenu du certificat d’autorité.

CertKey
string or null

Contenu de la clé du certificat.

Password
string or null

Mot de passe du certificat, s’il existe.

Verify
required
boolean

Vérifier l’autorité de certification.

{
  • "Cert": "string",
  • "CertKey": "string",
  • "CertCa": "string",
  • "Verify": true,
  • "Password": "string"
}

StartNodeCargoParams

CargoKey
required
string

Clé canonique du Cargo au format {namespace}.{name}.

required
Tableau de objects (CargoReplicaTask)

Répliques persistantes exactes affectées à ce nœud, triées par numéro ordinal.

Array
Key
required
string <uuid>

Identité persistante et stable de la réplique du Cargo.

Ordinal
required
integer <int32>

Numéro ordinal stable de la réplique, unique à l’échelle du Cargo.

{
  • "CargoKey": "string",
  • "Replicas": [
    ]
}

Statefile

ApiVersion
required
string

Version de l’API à utiliser ou URL distante.

Tableau de objects or null (StatefileArg)

Arguments à transmettre au Statefile.

Array
null or (StatefileArgsValue (StatefileArgsValue (number) or StatefileArgsValue (string) or StatefileArgsValue (boolean) or Tableau de StatefileArgsValue (numbers) or Tableau de StatefileArgsValue (strings)))
Description
string or null

Description courte de l’argument.

Example
string or null

Exemple de valeur pour l’argument.

Kind
required
string (StatefileArgKind)
Valeurs possibles: "String" "Number" "Boolean"

Type de l’argument de compilation.

Multiple
boolean

L’argument accepte plusieurs valeurs.

Name
required
string

Nom de l’argument de compilation.

Required
boolean

Argument obligatoire.

Tableau de objects or null (CargoSpec)

Liste des Cargoes à créer et à exécuter.

Array
required
Tableau de objects (ContainerSpec)

Conteneurs applicatifs dans chaque réplique du Cargo.

Dns
Tableau de strings or null

Serveurs DNS affectés au propriétaire du réseau Cargo.

Hostname
string or null

Nom d’hôte Docker affecté au propriétaire du réseau Cargo.

Tableau de objects (ContainerSpec)

Conteneurs d’initialisation exécutés dans l’ordre de déclaration avant les conteneurs applicatifs.

object

Métadonnées du Cargo, définies par l’utilisateur.

Name
required
string

Nom du Cargo.

null or CargoNetworkMode (string)
null or CargoPlacementSpec (object)
null or HashMap (object)
Replicas
integer >= 1
Valeur par défaut: 1

Nombre de répliques persistantes du Cargo.

null or CargoResourceRequirementSpec (object)
Secrets
Tableau de strings

Secrets hérités par tous les conteneurs ordinaires et d’initialisation.

Group
string or null

Définir le groupe des objets déclarés ; {name_of_directory}.{name_of_file} par défaut.

Tableau de objects or null (JobPartial)

Liste des tâches à créer et à exécuter.

Array
required
Tableau de objects (Config)

Liste des conteneurs à exécuter.

null or ImagePullPolicy (string)
ImagePullSecret
string or null

Secret à utiliser lors du téléchargement de l’image.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la tâche.

Schedule
string or null

Expression cron à cinq champs ou raccourci pris en charge ; voir [crate::cron::validate_schedule].

Secrets
Tableau de strings or null

Secrets à charger comme variables d’environnement.

Ttl
integer or null >= 0

Supprimer la tâche (x) secondes après son exécution.

null or StatefileMetadata (object)
One of
null
Namespace
string or null

Espace de noms où sont déployés les Cargoes et les machines virtuelles.

Tableau de objects or null (ResourcePartial)

Liste des ressources à créer.

Array
required
object

Données de la ressource sous forme d’objet JSON.

Kind
required
string

Type de la ressource.

object

Métadonnées de la ressource, définies par l’utilisateur.

Name
required
string

Nom de la ressource.

Tableau de objects or null (SecretPartial)

Liste des secrets à créer.

Array
required
object

Données du secret.

Immutable
boolean

Le secret ne peut pas être mis à jour.

Kind
required
string

Type de secret.

object

Métadonnées de la ressource, définies par l’utilisateur.

Name
required
string

Nom du secret.

Tableau de strings or SubStateDef (object) or null (SubState)

Inclure les sous-états à appliquer avant l’état actuel.

Array
One of
string
Tableau de objects or null (VmSpecPartial)

Liste des machines virtuelles à créer et à exécuter.

Array
null or VmHostConfig (object)
Hostname
string or null

Nom d’hôte de la VM ; généré à partir du nom par défaut.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC de la VM ; générée par défaut.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM : cloud.

SshKey
string or null

Clé publique SSH par défaut de l’utilisateur ; recommandé.

User
string or null

Utilisateur par défaut de la 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 Tableau de StatefileArgsValue (numbers) or Tableau de StatefileArgsValue (strings)))
One of
null
Description
string or null

Description courte de l’argument.

Example
string or null

Exemple de valeur pour l’argument.

Kind
required
string (StatefileArgKind)
Valeurs possibles: "String" "Number" "Boolean"

Type de l’argument de compilation.

Multiple
boolean

L’argument accepte plusieurs valeurs.

Name
required
string

Nom de l’argument de compilation.

Required
boolean

Argument obligatoire.

{
  • "Name": "string",
  • "Kind": "String",
  • "Default": { },
  • "Required": true,
  • "Multiple": true,
  • "Description": "string",
  • "Example": "string"
}

StatefileArgKind

string (StatefileArgKind)
Valeurs possibles: "String" "Number" "Boolean"

Définition d’un argument à transmettre au Statefile.

"String"

StatefileArgsValue

One of
number <double>

Définition d’un argument à transmettre au Statefile.

[ ]

StatefileMetadata

About
string or null

Informations du Statefile utilisées dans la section name.

LongAbout
string or null

Description détaillée du Statefile utilisée dans la section description.

ManContent
string or null

Remplacer le contenu de la page de manuel de ce Statefile.

Name
string or null

Titre facultatif de la documentation du Statefile.

Tags
Tableau de strings or null

Étiquettes facultatives associées à ce Statefile.

{
  • "Name": "string",
  • "About": "string",
  • "LongAbout": "string",
  • "Tags": [
    ],
  • "ManContent": "string"
}

Stats

required
object (BlkioStats)

Statistiques des entrées/sorties du conteneur.

Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
Tableau de objects or null (BlkioStatsEntry)
required
object (CPUStats)

Statistiques CPU générales du conteneur.

required
object (CPUUsage)

Statistiques d’utilisation CPU du conteneur.

online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

Statistiques de limitation du CPU.

id
string
required
object (MemoryStats)

Statistiques mémoire générales du conteneur.

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)

Statistiques réseau du conteneur.

num_procs
required
integer <int32> >= 0
required
object (PidsStats)

Statistiques des identifiants de processus du conteneur.

current
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
required
object (CPUStats)

Statistiques CPU générales du conteneur.

required
object (CPUUsage)

Statistiques d’utilisation CPU du conteneur.

online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

Statistiques de limitation du CPU.

preread
required
string
read
required
string
required
object (StorageStats)

Statistiques des entrées/sorties de fichiers du conteneur.

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

Désactiver la journalisation pour cette cible.

Key
required
string

Clé du Cargo ou de la VM à cibler.

Path
string or null

Chemin HTTP à cibler lors de l’utilisation de HTTP.

Port
required
integer <int32> >= 0

Port du Cargo ou de la VM à cibler.

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

Nom de l’argument.

required
number or string or boolean or Tableau de numbers or Tableau de strings (StatefileArgsValue)
One of
number <double>

Valeur de l’argument.

{
  • "Name": "string",
  • "Value": 0.1
}

SubStateDef

Tableau de objects or null (SubStateArg)
Array
Name
required
string

Nom de l’argument.

required
number or string or boolean or Tableau de numbers or Tableau de 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>

Nombre total de gestionnaires dans le swarm.

NodeAddr
string or null

Adresse IP permettant aux autres nœuds du swarm de joindre ce nœud.

NodeID
string or null

Identifiant unique de ce nœud dans le swarm.

Nodes
integer or null <int64>

Nombre total de nœuds dans le swarm.

Tableau de objects or null (PeerNode)

Liste des identifiants et adresses des autres gestionnaires du swarm.

Array
Addr
string or null

Adresse IP et ports permettant de joindre ce nœud.

NodeID
string or null

Identifiant unique de ce nœud dans le 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

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
Name
string or null

Nom du 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

Tableau de objects or null (SwarmSpecCaConfigExternalCas)

Configuration du transfert des demandes de signature à une autorité de certification externe.

Array
CACert
string or null

Certificat racine d’autorité, au format PEM, utilisé par cette autorité externe pour émettre des certificats TLS. S’il n’est pas fourni, le certificat racine actuel du swarm est supposé être utilisé.

object or null

Objet contenant des paires clé/valeur interprétées comme des options propres au protocole par le pilote d’autorité de certification externe.

null or SwarmSpecCaConfigExternalCasProtocolEnum (string)
URL
string or null

URL à laquelle envoyer les demandes de signature de certificat.

ForceRotate
integer or null <int64> >= 0

Entier servant à forcer swarm à générer un nouveau certificat et une nouvelle clé d’autorité de certification pour la signature, si aucun n’a été fourni dans SigningCACert et SigningCAKey.

NodeCertExpiry
integer or null <int64>

Durée de validité des certificats émis pour les nœuds.

SigningCACert
string or null

Certificat d’autorité de signature souhaité pour tous les certificats TLS finaux des nœuds du swarm, au format PEM.

SigningCAKey
string or null

Clé d’autorité de signature souhaitée pour tous les certificats TLS finaux des nœuds du swarm, au format PEM.

{
  • "NodeCertExpiry": 0,
  • "ExternalCAs": [
    ],
  • "SigningCACert": "string",
  • "SigningCAKey": "string",
  • "ForceRotate": 0
}

SwarmSpecCaConfigExternalCas

CACert
string or null

Certificat racine d’autorité, au format PEM, utilisé par cette autorité externe pour émettre des certificats TLS. S’il n’est pas fourni, le certificat racine actuel du swarm est supposé être utilisé.

object or null

Objet contenant des paires clé/valeur interprétées comme des options propres au protocole par le pilote d’autorité de certification externe.

property name*
additional property
string
null or SwarmSpecCaConfigExternalCasProtocolEnum (string)
One of
null
URL
string or null

URL à laquelle envoyer les demandes de signature de certificat.

{
  • "Protocol": { },
  • "URL": "string",
  • "Options": {
    },
  • "CACert": "string"
}

SwarmSpecCaConfigExternalCasProtocolEnum

string (SwarmSpecCaConfigExternalCasProtocolEnum)
Valeurs possibles: "EMPTY" "cfssl"
"EMPTY"

SwarmSpecDispatcher

HeartbeatPeriod
integer or null <int64>

Intervalle d’envoi d’un signal de présence de l’agent au répartiteur.

{
  • "HeartbeatPeriod": 0
}

SwarmSpecEncryptionConfig

AutoLockManagers
boolean or null

Si défini, générer une clé et l’utiliser pour verrouiller les données enregistrées sur les gestionnaires.

{
  • "AutoLockManagers": true
}

SwarmSpecOrchestration

TaskHistoryRetentionLimit
integer or null <int64>

Nombre de tâches historiques à conserver par instance ou nœud. Si négatif, ne jamais supprimer les tâches terminées ou ayant échoué.

{
  • "TaskHistoryRetentionLimit": 0
}

SwarmSpecRaft

ElectionTick
integer or null <int64>

Nombre de ticks pendant lesquels un suiveur attend un message du leader avant de devenir candidat et de déclencher une élection. ElectionTick doit être supérieur à HeartbeatTick. Un tick vaut actuellement une seconde par défaut : ces valeurs correspondent donc actuellement à des secondes, mais ce n’est PAS garanti.

HeartbeatTick
integer or null <int64>

Nombre de ticks entre les signaux de présence. Le leader envoie un signal aux suiveurs tous les HeartbeatTick ticks. Un tick vaut actuellement une seconde par défaut : ces valeurs correspondent donc actuellement à des secondes, mais ce n’est PAS garanti.

KeepOldSnapshots
integer or null <int64> >= 0

Nombre d’instantanés à conserver en plus de l’instantané actuel.

LogEntriesForSlowFollowers
integer or null <int64> >= 0

Nombre d’entrées de journal à conserver pour synchroniser les suiveurs lents après la création d’un instantané.

SnapshotInterval
integer or null <int64> >= 0

Nombre d’entrées de journal entre deux instantanés.

{
  • "SnapshotInterval": 0,
  • "KeepOldSnapshots": 0,
  • "LogEntriesForSlowFollowers": 0,
  • "ElectionTick": 0,
  • "HeartbeatTick": 0
}

SwarmSpecTaskDefaults

null or SwarmSpecTaskDefaultsLogDriver (object)
One of
null
{
  • "LogDriver": { }
}

SwarmSpecTaskDefaultsLogDriver

Name
string or null

Pilote de journalisation à utiliser par défaut pour les nouvelles tâches.

object or null

Options propres au pilote de journalisation choisi, sous forme de paires clé/valeur.

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

SystemInfo

Architecture
string or null

Architecture matérielle de l’hôte, renvoyée par le moteur Go (GOARCH). La liste complète des valeurs possibles figure dans la documentation Go.

BridgeNfIp6tables
boolean or null

Indique si bridge-nf-call-ip6tables est disponible sur l’hôte.

BridgeNfIptables
boolean or null

Indique si bridge-nf-call-iptables est disponible sur l’hôte.

CDISpecDirs
Tableau de strings or null

Liste des répertoires contenant les spécifications CDI (Container Device Interface). Ces spécifications définissent des modifications propres aux fournisseurs dans la spécification OCI du conteneur à créer. Une liste vide indique que l’injection de périphériques CDI est désactivée. Cette injection exige l’activation du mode expérimental du démon. Les démons non expérimentaux renvoient donc toujours une liste vide.

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>

Nombre total de conteneurs sur l’hôte.

ContainersPaused
integer or null <int64>

Nombre de conteneurs dont l’état est \"paused\".

ContainersRunning
integer or null <int64>

Nombre de conteneurs dont l’état est \"running\".

ContainersStopped
integer or null <int64>

Nombre de conteneurs dont l’état est \"stopped\".

CpuCfsPeriod
boolean or null

Indique si l’hôte prend en charge la période CPU CFS (Completely Fair Scheduler).

CpuCfsQuota
boolean or null

Indique si l’hôte prend en charge le quota CPU CFS (Completely Fair Scheduler).

CPUSet
boolean or null

Indique si l’hôte prend en charge les CPUsets (cpuset.cpus, cpuset.mems). Voir cpuset(7).

CPUShares
boolean or null

Indique si l’hôte prend en charge la limitation par parts CPU.

Debug
boolean or null

Indique si le démon fonctionne en mode débogage avec une journalisation de niveau debug.

Tableau de objects or null (SystemInfoDefaultAddressPools)

Liste des plages d’adresses par défaut personnalisées pour les réseaux locaux, définies dans daemon.json ou par une option dockerd. Par exemple, une Base "10.10.0.0/16" avec une Size de 24 définit 256 plages d’adresses 10.10.[0-255].0/24.

Array
Base
string or null

Adresse réseau au format CIDR.

Size
integer or null <int64>

Taille de la plage réseau.

DefaultRuntime
string or null

Nom du moteur OCI par défaut utilisé au démarrage des conteneurs. Cette valeur peut être remplacée pour chaque conteneur à sa création.

DockerRootDir
string or null

Répertoire racine de l’état persistant Docker. Par défaut : /var/lib/docker sous Linux et C:\\ProgramData\\docker sous Windows.

Driver
string or null

Nom du pilote de stockage utilisé.

DriverStatus
Tableau de strings or null[ items ]

Informations propres au pilote de stockage, sous forme de paires "label" / "value". Elles sont fournies par le pilote et présentées de façon cohérente avec la sortie de docker info en ligne de commande.


> Remarque : les informations de ce champ, y compris le format des valeurs et des étiquettes, ne doivent pas être considérées comme stables et peuvent changer sans préavis.

ExperimentalBuild
boolean or null

Indique si les fonctionnalités expérimentales sont activées sur le démon.

null or GenericResourcesInner (object)
One of
null
HttpProxy
string or null

Proxy HTTP configuré pour le démon. Cette valeur provient de la variable d’environnement HTTP_PROXY. Les identifiants, dans la composante d’informations utilisateur de l’URL du proxy, sont masqués dans la réponse de l’API. Les conteneurs n’héritent pas automatiquement de cette configuration.

HttpsProxy
string or null

Proxy HTTPS configuré pour le démon. Cette valeur provient de la variable d’environnement HTTPS_PROXY. Les identifiants, dans la composante d’informations utilisateur de l’URL du proxy, sont masqués dans la réponse de l’API. Les conteneurs n’héritent pas automatiquement de cette configuration.

ID
string or null

Identifiant unique du démon.


> Remarque : le format de l’identifiant lui-même ne fait pas partie de l’API et ne doit pas être considéré comme stable.

Images
integer or null <int64>

Nombre total d’images sur l’hôte, avec ou sans étiquette, y compris les images orphelines.

IndexServerAddress
string or null

Adresse ou URL du serveur d’index utilisé pour rechercher des images et, par défaut, pour authentifier les utilisateurs auprès de Docker Hub et Docker Cloud.

InitBinary
string or null

Nom et chemin facultatif du binaire docker-init. Si le chemin est omis, le démon recherche le binaire dans le $PATH de l’hôte et utilise le premier résultat.

null or Commit (object)
One of
null
IPv4Forwarding
boolean or null

Indique si le transfert IPv4 est activé.

null or SystemInfoIsolationEnum (string)
One of
null
KernelMemoryTCP
boolean or null

Indique si l’hôte prend en charge la limite TCP de mémoire noyau. Ce champ est omis si elle n’est pas prise en charge. Les limites TCP de mémoire noyau ne sont pas disponibles avec cgroups v2, qui ne prend pas en charge le cgroup memory.kmem.tcp.limit_in_bytes correspondant.

KernelVersion
string or null

Version du noyau de l’hôte. Sous Linux, ces informations proviennent de uname. Sous Windows, elles sont lues dans la valeur de registre HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\, par exemple "10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)".

Labels
Tableau de strings or null

Étiquettes définies par l’utilisateur, sous forme de métadonnées clé/valeur, sur le démon.


> Remarque : dans un Swarm, les nœuds peuvent avoir des étiquettes de démon, définies dans sa configuration, et des étiquettes de nœud, définies depuis un nœud gestionnaire du Swarm. Les étiquettes de nœud ne figurent pas dans ce champ. Elles peuvent être récupérées par le point d’accès /nodes/(id) sur un nœud gestionnaire du Swarm.

LiveRestoreEnabled
boolean or null

Indique si live restore est activé. Dans ce cas, les conteneurs continuent à fonctionner à l’arrêt du démon, ou à son démarrage si des conteneurs en cours d’exécution sont détectés.

LoggingDriver
string or null

Pilote de journalisation à utiliser par défaut pour les nouveaux conteneurs.

MemoryLimit
boolean or null

Indique si l’hôte prend en charge les limites de mémoire.

MemTotal
integer or null <int64>

Quantité totale de mémoire physique disponible sur l’hôte, en octets.

Name
string or null

Nom d’hôte de l’hôte.

NCPU
integer or null <int64>

Nombre de CPU logiques utilisables par le démon. Le nombre de CPU disponibles est obtenu auprès du système d’exploitation au démarrage du démon. Les changements d’allocation CPU effectués ensuite ne sont pas reflétés.

NEventsListener
integer or null <int64>

Nombre d’écouteurs d’événements abonnés.

NFd
integer or null <int64>

Nombre total de descripteurs de fichiers utilisés par le processus du démon. Ces informations sont renvoyées uniquement si le mode débogage est activé.

NGoroutines
integer or null <int64>

Nombre actuel de goroutines. Ces informations sont renvoyées uniquement si le mode débogage est activé.

NoProxy
string or null

Liste, séparée par des virgules, des extensions de domaine pour lesquelles aucun proxy ne doit être utilisé. Cette valeur provient de la variable d’environnement NO_PROXY. Les conteneurs n’héritent pas automatiquement de cette configuration.

OomKillDisable
boolean or null

Indique si l’hôte permet de désactiver l’OOM killer.

OperatingSystem
string or null

Nom du système d’exploitation de l’hôte, par exemple "Ubuntu 16.04.2 LTS" ou "Windows Server 2016 Datacenter".

OSType
string or null

Type générique du système d’exploitation de l’hôte, renvoyé par le moteur Go (GOOS). Les valeurs actuellement renvoyées sont "linux" et "windows". La liste complète des valeurs possibles figure dans la documentation Go.

OSVersion
string or null

Version du système d’exploitation de l’hôte.


> Remarque : les informations de ce champ, y compris son existence et le format de ses valeurs, ne doivent pas être considérées comme stables et peuvent changer sans préavis.

PidsLimit
boolean or null

Indique si le noyau de l’hôte prend en charge les limites de PID.

null or PluginsInfo (object)
One of
null
ProductLicense
string or null

Récapitulatif de la licence du produit sur le démon. Si une licence commerciale est appliquée, les informations comme le nombre de nœuds et la date d’expiration sont incluses.

null or RegistryServiceConfig (object)
One of
null
null or Commit (object)
One of
null
object or null

Liste des moteurs conformes à OCI configurés sur le démon. Les clés contiennent le "name" utilisé pour référencer le moteur. Le démon Docker s’appuie sur un moteur conforme à OCI, invoqué par le démon containerd, pour accéder aux espaces de noms du noyau Linux, aux cgroups et à SELinux. Le moteur par défaut est runc, configuré automatiquement. Les moteurs supplémentaires configurés par l’utilisateur figurent ici.

additional property
object (Runtime)

Runtime décrit un moteur conforme à OCI. Le démon invoque ce moteur par l’intermédiaire du démon containerd. Les moteurs OCI servent d’interface aux espaces de noms du noyau Linux, aux cgroups et à SELinux.

SecurityOptions
Tableau de strings or null

Liste des fonctions de sécurité activées sur le démon, comme apparmor, seccomp, SELinux, les espaces de noms utilisateur (userns), rootless et no-new-privileges. Les options supplémentaires de chaque fonction peuvent figurer sous forme de listes de paires clé/valeur séparées par des virgules.

ServerVersion
string or null

Chaîne de version du démon.

SwapLimit
boolean or null

Indique si l’hôte prend en charge les limites de mémoire swap.

null or SwarmInfo (object)
One of
null
SystemTime
string or null

Heure système actuelle au format RFC 3339, avec les nanosecondes.

Warnings
Tableau de strings or null

Liste des avertissements et messages d’information sur les fonctions manquantes ou les problèmes de configuration du démon. Le client peut les afficher pour informer l’utilisateur.

{
  • "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)
Valeurs possibles: "EMPTY" "cgroupfs" "systemd" "none"
"EMPTY"

SystemInfoCgroupVersionEnum

string (SystemInfoCgroupVersionEnum)
Valeurs possibles: "EMPTY" "1" "2"
"EMPTY"

SystemInfoDefaultAddressPools

Base
string or null

Adresse réseau au format CIDR.

Size
integer or null <int64>

Taille de la plage réseau.

{
  • "Base": "string",
  • "Size": 0
}

SystemInfoIsolationEnum

string (SystemInfoIsolationEnum)
Valeurs possibles: "EMPTY" "default" "hyperv" "process"
"EMPTY"

ThrottleDevice

Path
string or null

Chemin du périphérique.

Rate
integer or null <int64>

Débit.

{
  • "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

Octets bruts de la clé publique de l’émetteur, encodés en Base64 compatible URL.

CertIssuerSubject
string or null

Octets bruts du sujet de l’émetteur, encodés en Base64 compatible URL.

TrustRoot
string or null

Certificats racines d’autorité utilisés pour valider les certificats TLS finaux.

{
  • "TrustRoot": "string",
  • "CertIssuerSubject": "string",
  • "CertIssuerPublicKey": "string"
}

UnixTarget

UnixPath
required
string
{
  • "UnixPath": "string"
}

UpstreamTarget

DisableLogging
boolean or null

Désactiver la journalisation pour cette cible.

Key
required
string

Clé du Cargo ou de la VM à cibler.

Path
string or null

Chemin HTTP à cibler lors de l’utilisation de HTTP.

Port
required
integer <int32> >= 0

Port du Cargo ou de la VM à cibler.

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 à cibler.

{
  • "Uri": "string"
}

UrlRedirect

string (UrlRedirect)
Valeurs possibles: "MovedPermanently" "Permanent" "Temporary"
"MovedPermanently"

Vm

CreatedAt
required
string <date-time>

Date de création de la VM.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (VmSpec)

Spécification de la VM.

CreatedAt
required
string <date-time>

Date de création de la spécification de la VM.

required
object (VmHostConfig)

Ressources d’une VM : processeur, mémoire et réseau.

Hostname
string or null

Nom d’hôte de la VM.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
Key
required
string <uuid>

Identifiant unique de la spécification de la VM.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC de la VM.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM (cloud).

SshKey
string or null

Clé SSH par défaut de l’utilisateur.

User
string or null

Utilisateur par défaut de la VM (cloud).

Version
required
string

Version de la spécification.

VmKey
required
string

Clé canonique de la VM au format {namespace}.{name}.

required
object (ObjPsStatus)

État de la VM.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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

Nombre de CPU de la VM ; 1 par défaut.

Dns
Tableau de strings or null

Liste des serveurs DNS à utiliser par la VM.

HostTun
boolean or null

Utiliser le périphérique tun de l’hôte.

Kvm
boolean or null

Activer l’accélération KVM ; false par défaut.

LinkNetIface
string or null

Interface réseau à laquelle relier la VM ; eth0 par défaut.

Memory
required
integer <int64> >= 0

Mémoire de la VM en Mo ; 512 par défaut.

NetIface
string or null

Interface réseau de la VM à configurer ; ens3 par défaut.

NetworkMode
string or null

Réseau du conteneur utilisé par le moteur d’exécution de la VM.

Runtime
string or null

Nom de l’image de conteneur à utiliser pour la VM ; nanocl-qemu par défaut.

{
  • "Cpu": 0,
  • "Memory": 0,
  • "NetIface": "string",
  • "LinkNetIface": "string",
  • "Kvm": true,
  • "Dns": [
    ],
  • "Runtime": "string",
  • "NetworkMode": "string",
  • "HostTun": true
}

VmInspect

CreatedAt
required
string <date-time>

Date de création de la VM.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

required
Tableau de objects (Process)

Liste des instances.

Array
CreatedAt
required
string <date-time>

Date de création.

required
object (ContainerInspectResponse)

Données du processus : un ContainerInspect.

IpAddress
string or null

Adresse IP effective résolue à partir du dernier état observé du processus.

Key
required
string

Clé du processus.

Kind
required
string (ProcessKind)
Valeurs possibles: "vm" "job" "cargo"

Type du processus (Job, Vm, Cargo).

KindKey
required
string

Clé canonique de la ressource pour les Cargoes et les VM ; les tâches utilisent leur nom.

Name
required
string

Nom du processus.

NodeName
required
string

Nom du nœud sur lequel le conteneur s’exécute.

UpdatedAt
required
string <date-time>

Date de dernière mise à jour de l’instance.

InstanceTotal
required
integer >= 0

Nombre d’instances.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (VmSpec)

Spécification de la VM.

CreatedAt
required
string <date-time>

Date de création de la spécification de la VM.

required
object (VmHostConfig)

Ressources d’une VM : processeur, mémoire et réseau.

Hostname
string or null

Nom d’hôte de la VM.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
Key
required
string <uuid>

Identifiant unique de la spécification de la VM.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC de la VM.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM (cloud).

SshKey
string or null

Clé SSH par défaut de l’utilisateur.

User
string or null

Utilisateur par défaut de la VM (cloud).

Version
required
string

Version de la spécification.

VmKey
required
string

Clé canonique de la VM au format {namespace}.{name}.

required
object (ObjPsStatus)

État de la VM.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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>

Date de création de la spécification de la VM.

required
object (VmHostConfig)

Ressources d’une VM : processeur, mémoire et réseau.

Cpu
required
integer <int64> >= 0

Nombre de CPU de la VM ; 1 par défaut.

Dns
Tableau de strings or null

Liste des serveurs DNS à utiliser par la VM.

HostTun
boolean or null

Utiliser le périphérique tun de l’hôte.

Kvm
boolean or null

Activer l’accélération KVM ; false par défaut.

LinkNetIface
string or null

Interface réseau à laquelle relier la VM ; eth0 par défaut.

Memory
required
integer <int64> >= 0

Mémoire de la VM en Mo ; 512 par défaut.

NetIface
string or null

Interface réseau de la VM à configurer ; ens3 par défaut.

NetworkMode
string or null

Réseau du conteneur utilisé par le moteur d’exécution de la VM.

Runtime
string or null

Nom de l’image de conteneur à utiliser pour la VM ; nanocl-qemu par défaut.

Hostname
string or null

Nom d’hôte de la VM.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
One of
null
Key
required
string <uuid>

Identifiant unique de la spécification de la VM.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
MacAddress
string or null

Adresse MAC de la VM.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM (cloud).

SshKey
string or null

Clé SSH par défaut de l’utilisateur.

User
string or null

Utilisateur par défaut de la VM (cloud).

Version
required
string

Version de la spécification.

VmKey
required
string

Clé canonique de la VM au format {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

Nom d’hôte de la VM ; généré à partir du nom par défaut.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

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

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
MacAddress
string or null

Adresse MAC de la VM ; générée par défaut.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM : cloud.

SshKey
string or null

Clé publique SSH par défaut de l’utilisateur ; recommandé.

User
string or null

Utilisateur par défaut de la 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

Nom d’hôte de la VM.

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

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
string or null

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM (cloud).

SshKey
string or null

Clé SSH par défaut de l’utilisateur.

User
string or null

Utilisateur par défaut de la VM (cloud).

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "InitContainer": { },
  • "Labels": {
    },
  • "HostConfig": { }
}

VmSummary

CreatedAt
required
string <date-time>

Date de création de la VM.

InstanceRunning
required
integer >= 0

Nombre d’instances en cours d’exécution.

InstanceTotal
required
integer >= 0

Nombre d’instances.

NamespaceName
required
string

Nom de l’espace de noms.

required
object (VmSpec)

Spécification de la VM.

CreatedAt
required
string <date-time>

Date de création de la spécification de la VM.

required
object (VmHostConfig)

Ressources d’une VM : processeur, mémoire et réseau.

Hostname
string or null

Nom d’hôte de la VM.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

null or Config (object)
Key
required
string <uuid>

Identifiant unique de la spécification de la VM.

object or null

Métadonnées clé/valeur définies par l’utilisateur.

MacAddress
string or null

Adresse MAC de la VM.

object

Métadonnées définies par l’utilisateur.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM (cloud).

SshKey
string or null

Clé SSH par défaut de l’utilisateur.

User
string or null

Utilisateur par défaut de la VM (cloud).

Version
required
string

Version de la spécification.

VmKey
required
string

Clé canonique de la VM au format {namespace}.{name}.

required
object (ObjPsStatus)

État de la VM.

Actual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Health
required
string (ObjPsHealthStatusKind)
Valeurs possibles: "healthy" "unhealthy" "unknown"
PrevActual
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
Valeurs possibles: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
Valeurs possibles: "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>

Date du premier enregistrement de ce réseau.

required
object (Network)

Réponse complète de l’inspection du réseau 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

Clé stable sous la forme {node_name}.{network_name}.

Metadata
any

Métadonnées définies par l’utilisateur conservées lors du rafraîchissement des instantanés.

Name
required
string

Nom du réseau Docker.

NodeName
required
string

Nœud dont le démon Docker possède ce réseau.

UpdatedAt
required
string <date-time>

Date de dernier rafraîchissement de l’instantané d’inspection Docker.

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

Secrets

Points d’accès de gestion des secrets.

Lister les secrets avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "kind": { "eq": "Env" } } } }

Filtre générique.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer un secret.

Request Body schema: application/json
required
required
object

Données du secret.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Immutable
boolean

Le secret ne peut pas être mis à jour.

Kind
required
string

Type de secret.

object

Métadonnées de la ressource, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom du secret.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les secrets.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Filtre générique.

Réponses

Exemples de réponse

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

Supprimer un secret.

path Parameters
key
required
string

Clé du secret.

Réponses

Exemples de réponse

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

Mettre à jour un secret.

path Parameters
key
required
string

Clé du secret.

Request Body schema: application/json
required
required
object

Données du secret sous forme d’objet JSON.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

object

Métadonnées du secret, définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Réponses

Exemples de requête

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

Exemples de réponse

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

Obtenir les informations détaillées d’un secret.

path Parameters
key
required
string

Clé du secret.

Réponses

Exemples de réponse

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

Points d’accès généraux du système.

Envoyer un ping au serveur pour vérifier sa disponibilité.

Réponses

Obtenir les informations système de l’hôte ou du nœud.

Réponses

Exemples de réponse

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": {
    }
}

Obtenir les informations de version.

Réponses

Exemples de réponse

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

Vms

Points d’accès de gestion des machines virtuelles.

Lister les machines virtuelles avec un filtre facultatif.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "my-vm" } } } }

Filtre générique.

namespace
string

Filtre facultatif d’espace de noms ; omis ou vide, il renvoie tous les espaces de noms.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Créer une machine virtuelle.

query Parameters
namespace
string

Espace de noms de la machine virtuelle.

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

Nom d’hôte de la VM ; généré à partir du nom par défaut.

Image
required
string

Image utilisée par la VM ; doit être un chemin complet, par exemple /var/lib/nanocl/vm/image.qcow2.

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

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
MacAddress
string or null

Adresse MAC de la VM ; générée par défaut.

object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
required
string

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM : cloud.

SshKey
string or null

Clé publique SSH par défaut de l’utilisateur ; recommandé.

User
string or null

Utilisateur par défaut de la VM : cloud.

Réponses

Exemples de requête

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

Exemples de réponse

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

Compter les images de VM.

query Parameters
filter
string
Exemple: filter={ "filter": { "where": { "name": { "eq": "global" } } } }

Filtre générique.

namespace
string

Filtre facultatif d’espace de noms ; omis ou vide, il renvoie tous les espaces de noms.

Réponses

Exemples de réponse

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

Supprimer une machine virtuelle par sa clé canonique.

path Parameters
key
required
string

Clé canonique de la VM au format {namespace}.{name}.

Réponses

Exemples de réponse

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

Modifier la configuration d’une machine virtuelle en fusionnant la configuration actuelle avec la nouvelle, puis ajouter une entrée d’historique.

path Parameters
key
required
string

Clé canonique de la VM au format {namespace}.{name}.

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

Nom d’hôte de la VM.

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

Métadonnées clé/valeur définies par l’utilisateur.

property name*
additional property
string
object

Métadonnées définies par l’utilisateur.

additional property
string or number or boolean or (Tableau de Primitive (strings or numbers or booleans)) or object (Any)

Utilitaire générant un type Any pour OpenApi, utile pour les objets JSON dynamiques comme ResourceSpec.

Name
string or null

Nom de la VM.

Password
string or null

Mot de passe par défaut de la VM (cloud).

SshKey
string or null

Clé SSH par défaut de l’utilisateur.

User
string or null

Utilisateur par défaut de la VM (cloud).

Réponses

Exemples de requête

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

Exemples de réponse

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

Lister les historiques des machines virtuelles.

path Parameters
key
required
string

Clé canonique de la VM au format {namespace}.{name}.

Réponses

Exemples de réponse

Content type
application/json
[
  • {
    }
]

Obtenir les informations détaillées d’une machine virtuelle.

path Parameters
key
required
string

Clé canonique de la VM au format {namespace}.{name}.

Réponses

Exemples de réponse

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