Skip to Content

82 操作 · 181 スキーマ · 仕様 v0.17.0

OpenAPI YAML をダウンロード ↗
API docs by Redocly

Nanocl Daemon (v0.17.0)

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

Nanocl Daemon は HTTP REST API です。
API は Nanocl Client が使うものであり、Nanocl Client でできることはすべて API で実行できます。

多くのコマンドは API エンドポイントに直接対応します。たとえば nanocl ps は GET /processes です。
主な例外は Cargo の実行で、複数の API 呼び出しで構成します。

OpenAPI 仕様

Utoipa を使い、OpenAPI 形式で記述しています。
開発モードでの実行時にだけ仕様を自動生成します。
バージョンのリリース時に、生成したファイルをドキュメントに移します。

クロスオリジンリソース共有

W3C 仕様に準拠する CORS を実装しています。
ブラウザーからのドメイン間通信を許可します。
すべてのレスポンスでオリジンをワイルドカードにしているため、完全に公開され、任意のサイトのコードを含め、誰でもアクセスできます。

Cargoes

任意のフィルターを使って Cargo を一覧表示する。

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

汎用フィルター。

namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

仕様を使って新しい Cargo を作成する。

query Parameters
namespace
string

Cargo を作成する名前空間。デフォルトは 'global'。

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

Cargo のコンテナ仕様。

ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

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

イメージ取得時に使うシークレット。

null or Config (object)
One of
null
object

Cargo のメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
One of
null
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

レスポンス

リクエストの例

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": { },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Container": {
    },
  • "Replication": { }
}

レスポンスの例

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

任意のフィルターを使って Cargo の件数を取得する。

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

汎用フィルター。

namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

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

create_exec_command

path Parameters
Name
required
string

Cargo の名前。

query Parameters
Namespace
string

Cargo の名前空間。

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

exec コマンドの stderr に接続します。

AttachStdin
boolean or null

exec コマンドの stdin に接続します。

AttachStdout
boolean or null

exec コマンドの stdout に接続します。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列。

DetachKeys
string or null

コンテナから切断するキー操作を上書きします。形式は単一文字の [a-Z]、または ctrl-<value> です。<value> には a-z、@、^、[、,、_ を指定できます。

Env
配列の要素型 strings or null

["VAR=value", ...]. 形式の環境変数の一覧。

Privileged
boolean or null

追加の権限で exec プロセスを実行します。

Tty
boolean or null

疑似 TTY を割り当てる。

User
string or null

コンテナ内で exec プロセスを実行するユーザーと、任意のグループ。形式は user、user:group、uid、uid:gid のいずれかです。

WorkingDir
string or null

コンテナ内で exec プロセスを実行する作業ディレクトリ。

レスポンス

リクエストの例

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

レスポンスの例

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

新しい仕様で Cargo を更新し、履歴を記録する。

path Parameters
name
required
string

Cargo の名前。

query Parameters
namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

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

Cargo のコンテナ仕様。

ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

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

イメージ取得時に使うシークレット。

null or Config (object)
One of
null
object

Cargo のメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
One of
null
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

レスポンス

リクエストの例

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": { },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Container": {
    },
  • "Replication": { }
}

レスポンスの例

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

名前で Cargo を削除する。

path Parameters
name
required
string

Cargo の名前。

query Parameters
force
required
boolean

true の場合、Cargo が起動中でも削除を強制します。

namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

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

現在の仕様と新しい仕様をマージして Cargo を更新し、履歴を記録する。

path Parameters
name
required
string

Cargo の名前。

query Parameters
namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

Request Body schema: application/json
required
null or Config (object)
One of
null
null or ImagePullPolicy (string)
One of
null
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

null or Config (object)
One of
null
object

Cargo の新しいメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
string or null

Cargo の新しい名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
One of
null
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

レスポンス

リクエストの例

Content type
application/json
{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": { },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Container": { },
  • "Replication": { }
}

レスポンスの例

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

Cargo の履歴を一覧表示する。

path Parameters
name
required
string

Cargo の名前。

query Parameters
namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

Cargo を指定した履歴の記録に戻す。

path Parameters
key
required
string

Cargo の履歴のキー。

name
required
string

Cargo の名前。

query Parameters
namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

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

名前で Cargo の詳細情報を取得する。

path Parameters
name
required
string

Cargo の名前。

query Parameters
namespace
string

Cargo が属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

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

Events

イベントの管理エンドポイント。

任意のフィルターを使ってイベントを一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

任意のフィルターを使ってイベントの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

すべてのピアノードの新しいイベントを監視する。ストリームを停止する任意の条件を指定できます。

Request Body schema: application/json
Array
required
配列の要素型 strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or objects (NativeEventAction)
ActorKey
string or null
null or EventActorKind (string)
Kind
required
配列の要素型 strings (EventKind)
許可される要素 列挙値: "error" "normal" "warning"
RelatedKey
string or null
null or EventActorKind (string)

レスポンス

リクエストの例

Content type
application/json
[
  • {
    }
]

イベントの詳細情報を取得する。

path Parameters
key
required
string

イベントのキー。

レスポンス

レスポンスの例

Content type
application/json
{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "ReportingNode": "string",
  • "ReportingController": "string",
  • "Kind": "error",
  • "Action": "string",
  • "Reason": "string",
  • "Note": "string",
  • "Actor": { },
  • "Related": { },
  • "Metadata": {
    }
}

Exec

Cargo 内で実行したコマンドの詳細を取得する。

path Parameters
id
required
string

詳細を取得する exec の ID。

レスポンス

レスポンスの例

Content type
application/json
{
  • "CanRemove": true,
  • "DetachKeys": "string",
  • "ID": "string",
  • "Running": true,
  • "ExitCode": 0,
  • "ProcessConfig": { },
  • "OpenStdin": true,
  • "OpenStderr": true,
  • "OpenStdout": true,
  • "ContainerID": "string",
  • "Pid": 0
}

start_exec_command

path Parameters
id
required
string

exec コマンドの ID。

Request Body schema: application/json
required
Detach
required
boolean

コマンドから切断する。

OutputCapacity
integer or null >= 0

出力の 1 行の最大サイズ。デフォルトは 8 * 1024（およそ 1024 文字）です。

Tty
required
boolean

疑似 TTY を割り当てる。

レスポンス

リクエストの例

Content type
application/json
{
  • "Detach": true,
  • "Tty": true,
  • "OutputCapacity": 0
}

レスポンスの例

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

Jobs

ジョブの管理エンドポイント。

任意のフィルターを使ってジョブを一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

新しいジョブを作成する。

Request Body schema: application/json
required
required
配列の要素型 objects (Config)

実行するコンテナの一覧。

Array
ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

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

イメージ取得時に使うシークレット。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

ジョブの名前。

Schedule
string or null

ジョブのスケジュール（cron）。

Secrets
配列の要素型 strings or null

環境変数として読み込むシークレット。

Ttl
integer or null >= 0

実行後 x 秒経過してからジョブを削除する。

レスポンス

リクエストの例

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

レスポンスの例

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

ジョブの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

名前でジョブを削除する。

path Parameters
name
required
string

ジョブの名前。

レスポンス

レスポンスの例

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

ジョブの詳細情報を取得する。

path Parameters
name
required
string

ジョブの名前。

レスポンス

レスポンスの例

Content type
application/json
{
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    },
  • "Instances": [
    ]
}

Metrics

メトリクスの管理エンドポイント。

任意のフィルターを使ってメトリクスを一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

新しいメトリクスを作成する。

Request Body schema: application/json
required
Data
required
any

メトリクスのデータ。

Kind
required
string

メトリクスの種類。

Note
string or null

メトリクスの任意の注記。

レスポンス

リクエストの例

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

レスポンスの例

Content type
application/json
{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "NodeName": "string",
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

任意のフィルターを使ってメトリクスの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

メトリクスの詳細情報を取得する。

path Parameters
key
required
string

メトリクスのキー。

レスポンス

レスポンスの例

Content type
application/json
{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "NodeName": "string",
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Namespaces

名前空間の管理エンドポイント。

任意のフィルターを使って名前空間を一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

新しい名前空間を作成する。

Request Body schema: application/json
required
Metadata
any

ユーザー定義のメタデータ。

Name
required
string

名前空間の名前。

レスポンス

リクエストの例

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

レスポンスの例

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

名前空間の件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

名前空間を削除する。

path Parameters
name
required
string

削除する名前空間の名前。

レスポンス

レスポンスの例

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

名前空間の詳細情報を取得する。

path Parameters
name
required
string

詳細を取得する名前空間の名前。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

Nodes

ノードの管理エンドポイント。

ノードを一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

ノードの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

内部のノード間通信に使う WebSocket エンドポイント。

レスポンス

Processes

プロセスの管理エンドポイント。

キー名でプロセスの統計情報を取得する。

path Parameters
name
required
string
例: deploy-example

プロセスの名前。

query Parameters
one_shot
boolean

統計情報を 1 回だけ返す。

stream
boolean

統計情報のストリームを返す。

レスポンス

レスポンスの例

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

任意のフィルターを使ってプロセスを一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

プロセスの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

指定した種類と名前（Cargo、ジョブ、VM）のすべてのプロセスにシグナルを送る。

path Parameters
kind
required
string
例: cargo

プロセスの種類。

name
required
string
例: deploy-example

プロセスの名前。

query Parameters
namespace
string

必要な場合の、プロセスが属する名前空間。

Request Body schema: application/json
required
signal
required
string

コンテナに送るシグナル。デフォルト：SIGKILL。

レスポンス

リクエストの例

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

指定した種類と名前（Cargo、ジョブ、VM）のプロセスログを取得する。

path Parameters
kind
required
string
例: cargo

プロセスの種類。

name
required
string
例: deploy-example

プロセスの名前。

query Parameters
follow
boolean

ストリームを返すかを指定する真偽値。

namespace
string

プロセスの名前空間。

since
integer <int64>

タイムスタンプ以降のログのみを返す。

tail
string

最後の n 件（整数）またはすべて（'all'）のログのみを返す。

timestamps
boolean

各ログ行にタイムスタンプを追加する。

until
integer <int64>

タイムスタンプまでのログのみを返す。

レスポンス

指定した種類と名前（Cargo、ジョブ、VM）のすべてのプロセスを再起動する。

path Parameters
kind
required
string
例: cargo

プロセスの種類。

name
required
string
例: deploy-example

プロセスの名前。

query Parameters
namespace
string

必要な場合の、プロセスが属する名前空間。

レスポンス

指定した種類と名前（Cargo、ジョブ、VM）のすべてのプロセスを起動する。

path Parameters
kind
required
string
例: cargo

プロセスの種類。

name
required
string
例: deploy-example

プロセスの名前。

query Parameters
namespace
string

必要な場合の、プロセスが属する名前空間。

レスポンス

指定した種類と名前（Cargo、ジョブ、VM）のすべてのプロセスの統計情報を取得する。

path Parameters
kind
required
string
例: cargo

プロセスの種類。

name
required
string
例: deploy-example

プロセスグループの名前。

query Parameters
namespace
string

必要な場合の、プロセスが属する名前空間。

one_shot
boolean

統計情報を 1 回だけ返す。

stream
boolean

統計情報のストリームを返す。

レスポンス

レスポンスの例

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

指定した種類と名前（Cargo、ジョブ、VM）のすべてのプロセスを停止する。

path Parameters
kind
required
string
例: cargo

プロセスの種類。

name
required
string
例: deploy-example

プロセスの名前。

query Parameters
namespace
string

必要な場合の、プロセスが属する名前空間。

レスポンス

すべてのプロセスが指定した状態になるまで待つ。

path Parameters
kind
required
string
例: cargo

プロセスインスタンスの種類。例：cargo、job、vm。

name
required
string

プロセスインスタンスの名前。

レスポンス

レスポンスの例

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

名前でプロセスの詳細情報を取得する。

path Parameters
name
required
string

プロセスの名前。

レスポンス

レスポンスの例

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

名前または ID で、単一のプロセスインスタンスのログを取得する。

path Parameters
name
required
string
例: deploy-example

プロセスの名前。

query Parameters
follow
boolean

ストリームを返すかを指定する真偽値。

since
integer <int64>

タイムスタンプ以降のログのみを返す。

tail
string

最後の n 件（整数）またはすべて（'all'）のログのみを返す。

timestamps
boolean

各ログ行にタイムスタンプを追加する。

until
integer <int64>

タイムスタンプまでのログのみを返す。

レスポンス

名前または ID で単一のプロセスを起動する。

path Parameters
pk
required
string
例: 1234567890

プロセスの主キー。

レスポンス

ResourceKinds

リソースの種類を一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

リソースの種類を作成する。

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

リソースの種類の仕様。

object

この種類とバージョンのリソースの JSONSchema。

Url
string or null

この種類とバージョンのリソースを作成、更新、削除するときに呼び出すサービス。

object

リソースの種類のメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

リソースの種類の名前。

Version
required
string

リソースの種類のバージョン。

レスポンス

リクエストの例

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

レスポンスの例

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

リソースの種類の件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

リソースの種類を削除する。

path Parameters
domain
required
string

リソースの種類のドメイン。

name
required
string

リソースの種類の名前。

レスポンス

レスポンスの例

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

リソースの種類の詳細情報を取得する。

path Parameters
domain
required
string

リソースの種類のドメイン。

name
required
string

リソースの種類の名前。

レスポンス

レスポンスの例

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

リソースの種類のバージョンの詳細情報を取得する。

path Parameters
domain
required
string

リソースの種類のドメイン。

name
required
string

リソースの種類の名前。

version
required
string

リソースの種類のバージョン。

レスポンス

レスポンスの例

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

Resources

リソースの管理エンドポイント。

任意のフィルターを使ってリソースを一覧表示する。

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

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

新しいリソースを作成する。

Request Body schema: application/json
required
required
object

リソースのデータ（JSON オブジェクト）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Kind
required
string

リソースの種類。

object

リソースのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

リソースの名前。

レスポンス

リクエストの例

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

レスポンスの例

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

リソースの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

新しいリソース仕様を作成し、履歴に記録する。

path Parameters
name
required
string

リソースの名前。

Request Body schema: application/json
required
required
object

JSON オブジェクト形式のリソースの仕様。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

object

JSON オブジェクト形式のリソースのメタデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

レスポンス

リクエストの例

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

レスポンスの例

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

名前でリソースを削除する。

path Parameters
name
required
string

削除するリソースの名前。

レスポンス

レスポンスの例

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

リソースの履歴を一覧表示する。

path Parameters
name
required
string

履歴を一覧表示するリソースの名前。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

リソースを指定した履歴に戻す。

path Parameters
id
required
string

戻すリソース履歴の ID。

name
required
string

元に戻すリソースの名前。

レスポンス

レスポンスの例

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

リソースの詳細情報を取得する。

path Parameters
name
required
string

詳細を取得するリソースの名前。

レスポンス

レスポンスの例

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

Secrets

シークレットの管理エンドポイント。

任意のフィルターを使ってシークレットを一覧表示する。

query Parameters
filter
string
例: filter={ "filter": { "where": { "kind": { "eq": "Env" } } } }

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

新しいシークレットを作成する。

Request Body schema: application/json
required
required
object

シークレットのデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Immutable
boolean

シークレットは更新できません。

Kind
required
string

シークレットの種類。

object

リソースのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

シークレットの名前。

レスポンス

リクエストの例

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

レスポンスの例

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

シークレットの件数を取得する。

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

汎用フィルター。

レスポンス

レスポンスの例

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

シークレットを削除する。

path Parameters
key
required
string

シークレットのキー。

レスポンス

レスポンスの例

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

シークレットを更新する。

path Parameters
key
required
string

シークレットのキー。

Request Body schema: application/json
required
required
object

JSON オブジェクト形式のシークレットのデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

object

シークレットのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

レスポンス

リクエストの例

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

レスポンスの例

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

シークレットの詳細情報を取得する。

path Parameters
key
required
string

シークレットのキー。

レスポンス

レスポンスの例

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

System

一般的なシステムエンドポイント。

サーバーの稼働を確認するために ping する。

レスポンス

ホストまたはノードのシステム情報を取得する。

レスポンス

レスポンスの例

Content type
application/json
{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": { },
  • "MemoryLimit": true,
  • "SwapLimit": true,
  • "KernelMemoryTCP": true,
  • "CpuCfsPeriod": true,
  • "CpuCfsQuota": true,
  • "CPUShares": true,
  • "CPUSet": true,
  • "PidsLimit": true,
  • "OomKillDisable": true,
  • "IPv4Forwarding": true,
  • "BridgeNfIptables": true,
  • "BridgeNfIp6tables": true,
  • "Debug": true,
  • "NFd": 0,
  • "NGoroutines": 0,
  • "SystemTime": "string",
  • "LoggingDriver": "string",
  • "CgroupDriver": { },
  • "CgroupVersion": { },
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": { },
  • "GenericResources": { },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": { },
  • "LiveRestoreEnabled": true,
  • "Isolation": { },
  • "InitBinary": "string",
  • "ContainerdCommit": { },
  • "RuncCommit": { },
  • "InitCommit": { },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ],
  • "HostGateway": "string",
  • "Network": {
    },
  • "Config": {
    }
}

バージョン情報を取得する。

レスポンス

レスポンスの例

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

VmImages

仮想マシンのイメージ管理エンドポイント。

任意のフィルターを使って仮想マシンのイメージを一覧表示する。

query Parameters
filter
string
例: filter={ "filter": { "where": { "name": { "eq": "my-image" } } } }

汎用フィルター。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

仮想マシンのイメージを削除する。

path Parameters
name
required
string

VM イメージの名前。

レスポンス

レスポンスの例

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

仮想マシンのイメージを複製する。

path Parameters
clone_name
required
string

複製の名前。

name
required
string

VM イメージの名前。

Request Body schema: text/plain
required
string

レスポンス

レスポンスの例

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Path": "string",
  • "Kind": "string",
  • "Format": "string",
  • "SizeActual": 0,
  • "SizeVirtual": 0
}

ファイルから仮想マシンのイメージをインポートする。

path Parameters
name
required
string

VM イメージの名前。

Request Body schema: text/plain
required
string

レスポンス

仮想マシンのイメージのサイズを変更する。

path Parameters
name
required
string

VM イメージの名前。

Request Body schema: application/json
required
Shrink
required
boolean

イメージを縮小するか。

Size
required
integer <int64> >= 0

イメージの新しいサイズ（バイト）。

レスポンス

リクエストの例

Content type
application/json
{
  • "Size": 0,
  • "Shrink": true
}

レスポンスの例

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Path": "string",
  • "Kind": "string",
  • "Format": "string",
  • "SizeActual": 0,
  • "SizeVirtual": 0
}

仮想マシンのイメージのスナップショットを作成する。

path Parameters
name
required
string

VM イメージの名前。

snap
required
string

スナップショットの名前。

Request Body schema: text/plain
required
string

レスポンス

レスポンスの例

Content type
application/json
{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Path": "string",
  • "Kind": "string",
  • "Format": "string",
  • "SizeActual": 0,
  • "SizeVirtual": 0
}

Vms

仮想マシンの管理エンドポイント。

任意のフィルターを使って仮想マシンを一覧表示する。

query Parameters
filter
string
例: filter={ "filter": { "where": { "name": { "eq": "my-vm" } } } }

汎用フィルター。

namespace
string

仮想マシンが属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

仮想マシンを作成する。

query Parameters
namespace
string

仮想マシンの名前空間。

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

VM のディスク設定（イメージ、サイズ）。必須です。

Image
required
string

使用するイメージの名前。

Size
integer or null <int64> >= 0

ディスクの許可する仮想サイズ（GB、デフォルト：20）。

null or VmHostConfig (object)
One of
null
Hostname
string or null

VM のホスト名（デフォルト：名前から生成）。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
MacAddress
string or null

VM の MAC アドレス（デフォルト：自動生成）。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（デフォルト：cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH 公開鍵（推奨）。

User
string or null

VM のデフォルトのユーザー（デフォルト：cloud）。

レスポンス

リクエストの例

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

レスポンスの例

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

名前で仮想マシンを削除する。

path Parameters
name
required
string

仮想マシンの名前。

query Parameters
namespace
string

仮想マシンが属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

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

現在の設定と新しい設定をマージして仮想マシンの設定を更新し、履歴に記録する。

path Parameters
name
required
string

仮想マシンの名前。

query Parameters
namespace
string

仮想マシンが属する名前空間。デフォルトは 'global'。

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

VM のホスト名。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
string or null

VM の名前。

Password
string or null

VM のデフォルトのパスワード（cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH キー。

User
string or null

VM のデフォルトのユーザー（cloud）。

レスポンス

リクエストの例

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

レスポンスの例

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

WebSocket 経由で仮想マシンに接続する。

path Parameters
name
required
string

仮想マシンの名前。

query Parameters
namespace
string

仮想マシンが属する名前空間。デフォルトは 'global'。

レスポンス

仮想マシンの履歴を一覧表示する。

path Parameters
name
required
string

仮想マシンの名前。

query Parameters
namespace
string

仮想マシンが属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

Content type
application/json
[
  • {
    }
]

仮想マシンの詳細情報を取得する。

path Parameters
name
required
string

仮想マシンの名前。

query Parameters
namespace
string

仮想マシンが属する名前空間。デフォルトは 'global'。

レスポンス

レスポンスの例

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

スキーマ

Address

Addr
string or null

IP アドレス。

PrefixLen
integer or null <int64>

IP アドレスのマスク長。

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

Any

One of
string

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

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

ApiError

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

BinaryInfo

Arch
required
string

Arch は現在のバイナリーのアーキテクチャです。

Channel
required
string

Channel は現在のバイナリーのチャンネルです。

CommitId
required
string

CommitID は現在のバイナリーのコミット ID です。

Version
required
string

Version は現在のバイナリーのバージョンです。

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

BlkioStats

配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
配列の要素型 objects or null (BlkioStatsEntry)
Array
major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
{
  • "io_service_bytes_recursive": [
    ],
  • "io_serviced_recursive": [
    ],
  • "io_queue_recursive": [
    ],
  • "io_service_time_recursive": [
    ],
  • "io_wait_time_recursive": [
    ],
  • "io_merged_recursive": [
    ],
  • "io_time_recursive": [
    ],
  • "sectors_recursive": [
    ]
}

BlkioStatsEntry

major
required
integer <int64> >= 0
minor
required
integer <int64> >= 0
op
required
string
value
required
integer <int64> >= 0
{
  • "major": 0,
  • "minor": 0,
  • "op": "string",
  • "value": 0
}

CPUStats

required
object (CPUUsage)

コンテナの CPU 使用量の統計情報。

percpu_usage
配列の要素型 integers or null <int64> [ items <int64 > >= 0 ]
total_usage
required
integer <int64> >= 0
usage_in_kernelmode
required
integer <int64> >= 0
usage_in_usermode
required
integer <int64> >= 0
online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

CPU スロットリングの統計情報。

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

CPUUsage

percpu_usage
配列の要素型 integers or null <int64> [ items <int64 > >= 0 ]
total_usage
required
integer <int64> >= 0
usage_in_kernelmode
required
integer <int64> >= 0
usage_in_usermode
required
integer <int64> >= 0
{
  • "percpu_usage": [
    ],
  • "usage_in_usermode": 0,
  • "total_usage": 0,
  • "usage_in_kernelmode": 0
}

Cargo

CreatedAt
required
string <date-time>

Cargo の作成時刻。

NamespaceName
required
string

名前空間の名前。

required
object (CargoSpec)

Cargo の仕様。

CargoKey
required
string

Cargo のキー。

required
object (Config)

Cargo のコンテナ仕様。

CreatedAt
required
string <date-time>

Cargo 仕様の作成日時。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

null or Config (object)
Key
required
string <uuid>

Cargo 仕様の一意な識別子。

object

Cargo のメタデータ（ユーザー定義）。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

Version
required
string

仕様のバージョン。

required
object (ObjPsStatus)

Cargo の状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

CargoInspect

CreatedAt
required
string <date-time>

Cargo の作成時刻。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

required
配列の要素型 objects (Process)

インスタンスの一覧。

Array
CreatedAt
required
string <date-time>

作成日時。

required
object (ContainerInspectResponse)

プロセスのデータ（ContainerInspect）。

Key
required
string

プロセスのキー。

Kind
required
string (ProcessKind)
列挙値: "vm" "job" "cargo"

プロセスの種類（Job、Vm、Cargo）。

KindKey
required
string

関連する種類のキー。

Name
required
string

プロセスの名前。

NodeName
required
string

コンテナを実行するノードの名前。

UpdatedAt
required
string <date-time>

インスタンスの最終更新時刻。

InstanceTotal
required
integer >= 0

インスタンス数。

NamespaceName
required
string

名前空間の名前。

required
object (CargoSpec)

Cargo の仕様。

CargoKey
required
string

Cargo のキー。

required
object (Config)

Cargo のコンテナ仕様。

CreatedAt
required
string <date-time>

Cargo 仕様の作成日時。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

null or Config (object)
Key
required
string <uuid>

Cargo 仕様の一意な識別子。

object

Cargo のメタデータ（ユーザー定義）。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

Version
required
string

仕様のバージョン。

required
object (ObjPsStatus)

Cargo の状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

CargoKillOptions

signal
required
string

コンテナに送るシグナル。デフォルト：SIGKILL。

{
  • "signal": "string"
}

CargoSpec

CargoKey
required
string

Cargo のキー。

required
object (Config)

Cargo のコンテナ仕様。

ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

CreatedAt
required
string <date-time>

Cargo 仕様の作成日時。

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

イメージ取得時に使うシークレット。

null or Config (object)
One of
null
Key
required
string <uuid>

Cargo 仕様の一意な識別子。

object

Cargo のメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
One of
null
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

Version
required
string

仕様のバージョン。

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CargoKey": "string",
  • "Version": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": { },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Container": {
    },
  • "Replication": { }
}

CargoSpecPartial

required
object (Config)

Cargo のコンテナ仕様。

ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

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

イメージ取得時に使うシークレット。

null or Config (object)
One of
null
object

Cargo のメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
One of
null
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": { },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Container": {
    },
  • "Replication": { }
}

CargoSpecUpdate

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

イメージ取得時に使うシークレット。

null or Config (object)
One of
null
object

Cargo の新しいメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
string or null

Cargo の新しい名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
One of
null
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

{
  • "Name": "string",
  • "Metadata": {
    },
  • "InitContainer": { },
  • "Secrets": [
    ],
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Container": { },
  • "Replication": { }
}

CargoSummary

CreatedAt
required
string <date-time>

Cargo の作成時刻。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

InstanceTotal
required
integer >= 0

インスタンス数。

NamespaceName
required
string

名前空間の名前。

required
object (CargoSpec)

Cargo の仕様。

CargoKey
required
string

Cargo のキー。

required
object (Config)

Cargo のコンテナ仕様。

CreatedAt
required
string <date-time>

Cargo 仕様の作成日時。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

null or Config (object)
Key
required
string <uuid>

Cargo 仕様の一意な識別子。

object

Cargo のメタデータ（ユーザー定義）。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

Version
required
string

仕様のバージョン。

required
object (ObjPsStatus)

Cargo の状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "Status": {
    },
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Spec": {
    }
}

ClusterInfo

null or String (string)
One of
null
DataPathPort
integer or null <int32> >= 0

DataPathPort はデータ通信のデータパスポート番号です。許可される範囲は 1024～49151 です。未設定または 0 の場合はデフォルトの 4789 を使います。

DefaultAddrPool
配列の要素型 strings or null

Default Address Pool はグローバルスコープのネットワークのデフォルトサブネットプールを指定します。

ID
string or null

swarm の ID。

RootRotationInProgress
boolean or null

swarm のルート CA のローテーションが現在進行中か。

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

SubnetSize は、デフォルトのサブネットプールから作成するネットワークのサブネットサイズを指定します。

null or TlsInfo (object)
One of
null
null or String (string)
One of
null
null or ObjectVersion (object)
One of
null
{
  • "ID": "string",
  • "Version": { },
  • "CreatedAt": { },
  • "UpdatedAt": { },
  • "Spec": { },
  • "TLSInfo": { },
  • "RootRotationInProgress": true,
  • "DataPathPort": 0,
  • "DefaultAddrPool": [
    ],
  • "SubnetSize": 0
}

Commit

Expected
string or null

ビルド時に設定した、dockerd が想定する外部ツールのコミット ID。

ID
string or null

外部ツールの実際のコミット ID。

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

Config

ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
One of
null
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

additional property
object
WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": { },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ],
  • "HostConfig": { },
  • "NetworkingConfig": { }
}

ContainerConfig

ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使う、または使ったイメージの名前（または参照）。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
MacAddress
string or null

コンテナの MAC アドレス。非推奨：API v1.44 以降では非推奨です。代わりに EndpointSettings.MacAddress を使ってください。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

additional property
object
WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

{
  • "Hostname": "string",
  • "Domainname": "string",
  • "User": "string",
  • "AttachStdin": true,
  • "AttachStdout": true,
  • "AttachStderr": true,
  • "ExposedPorts": {
    },
  • "Tty": true,
  • "OpenStdin": true,
  • "StdinOnce": true,
  • "Env": [
    ],
  • "Cmd": [
    ],
  • "Healthcheck": { },
  • "ArgsEscaped": true,
  • "Image": "string",
  • "Volumes": {
    },
  • "WorkingDir": "string",
  • "Entrypoint": [
    ],
  • "NetworkDisabled": true,
  • "MacAddress": "string",
  • "OnBuild": [
    ],
  • "Labels": {
    },
  • "StopSignal": "string",
  • "StopTimeout": 0,
  • "Shell": [
    ]
}

ContainerInspectResponse

AppArmorProfile
string or null
Args
配列の要素型 strings or null

実行するコマンドの引数。

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

コンテナの作成時刻。

Driver
string or null
ExecIDs
配列の要素型 strings or null

コンテナ内で実行中の exec インスタンスの ID。

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

コンテナの ID。

Image
string or null

コンテナのイメージ ID。

LogPath
string or null
MountLabel
string or null
配列の要素型 objects or null (MountPoint)
Array
Destination
string or null

Destination はコンテナのルート（/）からの相対パスです。コンテナ内のこの場所に Source をマウントします。

Driver
string or null

Driver はボリュームの作成に使うボリュームドライバーです（ボリュームの場合）。

Mode
string or null

Mode はバインドまたはボリュームのマウント作成時に、ユーザーが指定したオプションのカンマ区切り一覧です。デフォルトはプラットフォーム固有（Linux では \"z\"、Windows では空）です。

Name
string or null

Name は、Source が定義する元データを参照する名前（ボリューム名など）です。

Propagation
string or null

Propagation はホストとマウントポイントの間で、双方向にマウントを伝播する方法を表します。詳細は Linux カーネルのドキュメントを参照してください。Windows では使いません。

RW
boolean or null

マウントが書き込み可能（読み書き可能）か。

Source
string or null

マウント元の場所。ボリュームでは、/var/lib/docker/volumes/ 内の保存場所です。バインドマウントと npipe では、バインド元のホスト部分です。tmpfs マウントでは空です。

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

実行するコマンドのパス。

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

このコンテナ内のすべてのファイルの合計サイズ。

SizeRw
integer or null <int64>

このコンテナが作成または変更したファイルのサイズ。

null or ContainerState (object)
One of
null
{
  • "Id": "string",
  • "Created": "string",
  • "Path": "string",
  • "Args": [
    ],
  • "State": { },
  • "Image": "string",
  • "ResolvConfPath": "string",
  • "HostnamePath": "string",
  • "HostsPath": "string",
  • "LogPath": "string",
  • "Name": "string",
  • "RestartCount": 0,
  • "Driver": "string",
  • "Platform": "string",
  • "MountLabel": "string",
  • "ProcessLabel": "string",
  • "AppArmorProfile": "string",
  • "ExecIDs": [
    ],
  • "HostConfig": { },
  • "GraphDriver": { },
  • "SizeRw": 0,
  • "SizeRootFs": 0,
  • "Mounts": [
    ],
  • "Config": { },
  • "NetworkSettings": { }
}

ContainerState

Dead
boolean or null
Error
string or null
ExitCode
integer or null <int64>

このコンテナの最後の終了コード。

FinishedAt
string or null

このコンテナの最後の終了時刻。

null or Health (object)
One of
null
OOMKilled
boolean or null

最後の起動以降に、コンテナ内のプロセスがメモリー不足で終了させられたか。

Paused
boolean or null

このコンテナが一時停止中か。

Pid
integer or null <int64>

このコンテナのプロセス ID。

Restarting
boolean or null

このコンテナが再起動中か。

Running
boolean or null

このコンテナが実行中か。実行中のコンテナは_一時停止_の場合もあります。Running と Paused は相互排他的ではありません。Linux で一時停止するときは freezer cgroup で全プロセスを停止させます。停止にはプロセスが実行中である必要があるため、一時停止中のコンテナは Running かつ Paused です。状態が "running" かの判定には Status フィールドを使ってください。

StartedAt
string or null

このコンテナの最後の起動時刻。

null or ContainerStateStatusEnum (string)
One of
null
{
  • "Status": { },
  • "Running": true,
  • "Paused": true,
  • "Restarting": true,
  • "OOMKilled": true,
  • "Dead": true,
  • "Pid": 0,
  • "ExitCode": 0,
  • "Error": "string",
  • "StartedAt": "string",
  • "FinishedAt": "string",
  • "Health": { }
}

ContainerStateStatusEnum

string (ContainerStateStatusEnum)
列挙値: "EMPTY" "created" "running" "paused" "restarting" "removing" "exited" "dead"
"EMPTY"

CreateExecOptions

AttachStderr
boolean or null

exec コマンドの stderr に接続します。

AttachStdin
boolean or null

exec コマンドの stdin に接続します。

AttachStdout
boolean or null

exec コマンドの stdout に接続します。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列。

DetachKeys
string or null

コンテナから切断するキー操作を上書きします。形式は単一文字の [a-Z]、または ctrl-<value> です。<value> には a-z、@、^、[、,、_ を指定できます。

Env
配列の要素型 strings or null

["VAR=value", ...]. 形式の環境変数の一覧。

Privileged
boolean or null

追加の権限で exec プロセスを実行します。

Tty
boolean or null

疑似 TTY を割り当てる。

User
string or null

コンテナ内で exec プロセスを実行するユーザーと、任意のグループ。形式は user、user:group、uid、uid:gid のいずれかです。

WorkingDir
string or null

コンテナ内で exec プロセスを実行する作業ディレクトリ。

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

DaemonConfig

advertise_addr
required
string

ほかのノードに通知するアドレス。

conf_dir
required
string

設定ディレクトリ。

docker_host
string

使用する Docker ホスト。

gateway
required
string

ホストのゲートウェイ。未指定の場合はホストのデフォルトゲートウェイを自動検出します。

gid
required
integer <int32> >= 0

グループ ID。

hostname
required
string

ノードのホスト名。未指定の場合は自動検出します。

hosts
required
配列の要素型 strings

待ち受けるホストの一覧。

nodes
required
配列の要素型 strings

参加するノードの一覧。

null or SslConfig (object)
One of
null
state_dir
required
string

状態ディレクトリのパス。

store_addr
string or null

接続するストアのアドレス。

{
  • "hosts": [
    ],
  • "state_dir": "string",
  • "docker_host": "string",
  • "store_addr": "string",
  • "gateway": "string",
  • "hostname": "string",
  • "nodes": [
    ],
  • "advertise_addr": "string",
  • "conf_dir": "string",
  • "gid": 0,
  • "ssl": { }
}

DeviceMapping

CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
{
  • "PathOnHost": "string",
  • "PathInContainer": "string",
  • "CgroupPermissions": "string"
}

DeviceRequest

Capabilities
配列の要素型 strings or null[ items ]

ケーパビリティの一覧。内側の一覧を AND、外側の一覧を OR で評価します。

Count
integer or null <int64>
DeviceIDs
配列の要素型 strings or null
Driver
string or null
object or null

ドライバー固有のオプション。キーと値の組で指定し、ドライバーに直接渡します。

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

DnsEntry

required
string or string or string or string or object (NetworkKind)
One of
string
値: "All"

ネットワークのバインドの種類。

Name
required
string
{
  • "Name": "string",
  • "IpAddress": "All"
}

EndpointIpamConfig

IPv4Address
string or null
IPv6Address
string or null
LinkLocalIPs
配列の要素型 strings or null
{
  • "IPv4Address": "string",
  • "IPv6Address": "string",
  • "LinkLocalIPs": [
    ]
}

EndpointSettings

Aliases
配列の要素型 strings or null
DNSNames
配列の要素型 strings or null

特定のネットワークでエンドポイントが持つ DNS 名の一覧。コンテナ名、ネットワークの別名、コンテナの短い ID、ホスト名に基づきます。完全修飾名ではありませんが、複数のドットを含められます。.<network-name> を付けると完全修飾名になります。たとえばコンテナ名が my.ctr、ネットワーク名が testnet なら、DNSNames は my.ctr を含み、FQDN は my.ctr.testnet です。

object or null

DriverOpts はドライバーのオプションと値の対応です。ドライバーに直接渡す、ドライバー固有のオプションです。

property name*
additional property
string
EndpointID
string or null

Sandbox 内のサービスエンドポイントの一意な ID。

Gateway
string or null

このネットワークのゲートウェイアドレス。

GlobalIPv6Address
string or null

グローバル IPv6 アドレス。

GlobalIPv6PrefixLen
integer or null <int64>

グローバル IPv6 アドレスのマスク長。

IPAddress
string or null

IPv4 アドレス。

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

IPv4 アドレスのマスク長。

IPv6Gateway
string or null

IPv6 ゲートウェイアドレス。

Links
配列の要素型 strings or null
MacAddress
string or null

このネットワークのエンドポイントの MAC アドレス。ネットワークドライバーが無視する場合があります。

NetworkID
string or null

ネットワークの一意な ID。

{
  • "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 は対象の actor に対して実行した、または失敗したアクションを表します。機械が読み取れる形式です。新しい Events では空にできず、最大 128 文字です。

null or EventActor (object)
One of
null
CreatedAt
required
string <date-time>

イベントの作成時刻。

ExpiresAt
required
string <date-time>

イベントの有効期限。

Key
required
string <uuid>

このイベントの一意な識別子。

Kind
required
string (EventKind)
列挙値: "error" "normal" "warning"

イベントの種類（Error、Normal、Warning）。今後、新しい種類が追加される可能性があります。機械が読み取れる形式です。新しい Events では空にできません。

object

標準のメタデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Note
string or null

この操作の状態の、人が読み取れる説明。

Reason
required
string

Reason はアクションを実行した理由です。人が読み取れる形式です。 新しい Events では空にできず、最大 128 文字です。

null or EventActor (object)
One of
null
ReportingController
required
string

Reporting Controller は、この Event を発行したコントローラーの名前です。 例：nanocl.io/core。新しい Events では空にできません。

ReportingNode
required
string

Reporting Node は、Event が生成されたノードの名前です。

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "ReportingNode": "string",
  • "ReportingController": "string",
  • "Kind": "error",
  • "Action": "string",
  • "Reason": "string",
  • "Note": "string",
  • "Actor": { },
  • "Related": { },
  • "Metadata": {
    }
}

EventActor

object
additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Key
string or null
Kind
required
string (EventActorKind)
列挙値: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind は actor の種類に関連するイベントの種類です。

{
  • "Key": "string",
  • "Kind": "Namespace",
  • "Attributes": {
    }
}

EventActorKind

string (EventActorKind)
列挙値: "Namespace" "Cargo" "Vm" "Job" "Resource" "Secret" "Process" "ContainerImage"

Kind は actor の種類に関連するイベントの種類です。

"Namespace"

EventCondition

required
配列の要素型 strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or strings or objects (NativeEventAction)
Array
One of
string
値: "create"

Action はイベントを引き起こしたアクションです。

ActorKey
string or null
null or EventActorKind (string)
One of
null
Kind
required
配列の要素型 strings (EventKind)
許可される要素 列挙値: "error" "normal" "warning"
RelatedKey
string or null
null or EventActorKind (string)
One of
null
{
  • "ActorKey": "string",
  • "ActorKind": { },
  • "RelatedKey": "string",
  • "RelatedKind": { },
  • "Kind": [
    ],
  • "Action": [
    ]
}

EventKind

string (EventKind)
列挙値: "error" "normal" "warning"

イベントの種類（Error、Normal、Warning）。今後、新しい種類が追加される可能性があります。

"error"

ExecInspectResponse

CanRemove
boolean or null
ContainerID
string or null
DetachKeys
string or null
ExitCode
integer or null <int64>
ID
string or null
OpenStderr
boolean or null
OpenStdin
boolean or null
OpenStdout
boolean or null
Pid
integer or null <int64>

exec プロセスのシステムプロセス ID。

null or ProcessConfig (object)
One of
null
Running
boolean or null
{
  • "CanRemove": true,
  • "DetachKeys": "string",
  • "ID": "string",
  • "Running": true,
  • "ExitCode": 0,
  • "ProcessConfig": { },
  • "OpenStdin": true,
  • "OpenStderr": true,
  • "OpenStdout": true,
  • "ContainerID": "string",
  • "Pid": 0
}

GenericCount

Count
required
integer <int64>

項目数。

{
  • "Count": 0
}

GenericResourcesInner

null or GenericResourcesInnerDiscreteResourceSpec (object)
One of
null
null or GenericResourcesInnerNamedResourceSpec (object)
One of
null
{
  • "NamedResourceSpec": { },
  • "DiscreteResourceSpec": { }
}

GenericResourcesInnerDiscreteResourceSpec

Kind
string or null
Value
integer or null <int64>
{
  • "Kind": "string",
  • "Value": 0
}

GenericResourcesInnerNamedResourceSpec

Kind
string or null
Value
string or null
{
  • "Kind": "string",
  • "Value": "string"
}

GraphDriverData

required
object

低水準のストレージメタデータ。キーと値の組で提供します。使うストレージドライバーに依存する固有情報であり、参考情報としてのみ使ってください。

property name*
additional property
string
Name
required
string

ストレージドライバーの名前。

{
  • "Name": "string",
  • "Data": {
    }
}

HashMap

additional property
null or 配列の要素型 objects
One of
null
{
  • "property1": { },
  • "property2": { }
}

Health

FailingStreak
integer or null <int64>

FailingStreak は連続した失敗の回数です。

配列の要素型 objects or null (HealthcheckResult)

Log は直近のいくつかの結果を保持します（古い順）。

Array
null or String (string)
ExitCode
integer or null <int64>

ExitCode の意味： - 0 正常 - 1 異常 - 2 予約済み（異常と見なします） - その他の値：プローブ実行時のエラー。

Output
string or null

前回のチェックの出力。

null or String (string)
null or HealthStatusEnum (string)
One of
null
{
  • "Status": { },
  • "FailingStreak": 0,
  • "Log": [
    ]
}

HealthConfig

Interval
integer or null <int64>

チェック間の待ち時間（ナノ秒）。0 または 1000000（1 ms）以上にしてください。0 は継承を意味します。

Retries
integer or null <int64>

コンテナを異常と見なすまでに必要な連続失敗回数。0 は継承を意味します。

StartInterval
integer or null <int64>

開始期間中のチェック間の待ち時間（ナノ秒）。0 または 1000000（1 ms）以上にしてください。0 は継承を意味します。

StartPeriod
integer or null <int64>

ヘルスチェックの再試行カウントを始める前に、コンテナの初期化を待つ期間（ナノ秒）。0 または 1000000（1 ms）以上にしてください。0 は継承を意味します。

Test
配列の要素型 strings or null

実行するテスト。 - []：イメージまたは親イメージのヘルスチェックを継承 - [\"NONE\"]：ヘルスチェックを無効化 - [\"CMD\", args...]：引数を直接実行 - [\"CMD-SHELL\", command]：システムのデフォルトシェルでコマンドを実行。

Timeout
integer or null <int64>

チェックが応答停止したと見なすまで待つ時間。0 または 1000000（1 ms）以上にしてください。0 は継承を意味します。

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

HealthStatusEnum

string (HealthStatusEnum)
列挙値: "EMPTY" "none" "starting" "healthy" "unhealthy"
"EMPTY"

HealthcheckResult

null or String (string)
One of
null
ExitCode
integer or null <int64>

ExitCode の意味： - 0 正常 - 1 異常 - 2 予約済み（異常と見なします） - その他の値：プローブ実行時のエラー。

Output
string or null

前回のチェックの出力。

null or String (string)
One of
null
{
  • "Start": { },
  • "End": { },
  • "ExitCode": 0,
  • "Output": "string"
}

HostConfig

object or null

コンテナに付ける、識別用ではない任意のメタデータ。起動時にランタイムに渡します。

property name*
additional property
string
AutoRemove
boolean or null

コンテナのプロセスが終了するとコンテナを自動削除します。RestartPolicy が設定されている場合は効果がありません。

Binds
配列の要素型 strings or null

コンテナのボリュームバインドの一覧。各バインドは次のいずれかの形式の文字列です。 - host-src:container-dest[:options]：ホストのパスをコンテナにバインドマウントします。host-src と container-dest は両方とも_絶対_パスである必要があります。 - volume-name:container-dest[:options]：ボリュームドライバーが管理するボリュームをコンテナにバインドマウントします。container-dest は_絶対_パスである必要があります。 options は任意のカンマ区切り一覧です。 - nocopy：コンテナのパスからボリュームへの自動コピーを無効にします。nocopy は名前付きボリュームだけに適用します。 - [ro|rw]：それぞれ読み取り専用、読み書き可能でマウントします。省略または rw の場合は読み書き可能です。 - [z|Z]：SELinux ラベルを適用し、複数コンテナによる同じボリュームへの読み書きを許可または禁止します。 - z：内容に_共有_ラベルを適用し、複数コンテナがボリュームの内容を読み書きして共有できることを示します。 - Z：内容に_共有しない専用_ラベルを適用し、現在のコンテナだけが専用ボリュームを使えることを示します。SELinux などのラベルシステムでは、コンテナにマウントするボリュームの内容に適切なラベルが必要です。ラベルがないと、セキュリティシステムがコンテナのプロセスによる内容の利用を防ぐことがあります。デフォルトではホスト OS のラベルを変更しません。 - [[r]shared|[r]slave|[r]private]：マウントの伝播動作を指定します。バインドマウントしたボリュームだけに適用し、内部ボリュームや名前付きボリュームには適用しません。元のマウントポイント（ホスト OS で元のディレクトリをマウントしている場所）に正しい伝播属性が必要です。共有ボリュームでは shared に設定します。slave ボリュームでは shared または slave に設定する必要があります。

配列の要素型 objects or null (ThrottleDevice)

デバイスからの読み取り速度（毎秒のバイト数）を制限します。形式： [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

デバイスのパス。

Rate
integer or null <int64>

レート。

配列の要素型 objects or null (ThrottleDevice)

デバイスからの読み取り速度（毎秒の I/O 回数）を制限します。形式： [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

デバイスのパス。

Rate
integer or null <int64>

レート。

配列の要素型 objects or null (ThrottleDevice)

デバイスへの書き込み速度（毎秒のバイト数）を制限します。形式： [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

デバイスのパス。

Rate
integer or null <int64>

レート。

配列の要素型 objects or null (ThrottleDevice)

デバイスへの書き込み速度（毎秒の I/O 回数）を制限します。形式： [{\"Path\": \"device_path\", \"Rate\": rate}]

Array
Path
string or null

デバイスのパス。

Rate
integer or null <int64>

レート。

BlkioWeight
integer or null <int32> >= 0

ブロック I/O の重み（相対的な重み）。

配列の要素型 objects or null (ResourcesBlkioWeightDevice)

ブロック I/O の重み（相対的なデバイス重み）。形式： [{\"Path\": \"device_path\", \"Weight\": weight}]

Array
Path
string or null
Weight
integer or null >= 0
CapAdd
配列の要素型 strings or null

コンテナに追加するカーネルのケーパビリティの一覧。'Capabilities' オプションと競合します。

CapDrop
配列の要素型 strings or null

コンテナから削除するカーネルのケーパビリティの一覧。'Capabilities' オプションと競合します。

Cgroup
string or null

コンテナに使用する cgroup。

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

cgroups のパス。この下にコンテナの cgroup を作成します。絶対パスでない場合は、初期化プロセスの cgroups パスからの相対パスと見なします。存在しない cgroup は作成します。

ConsoleSize
配列の要素型 integers or null <int32> [ items <int32 > ]

初期コンソールサイズ。[height, width] 配列で指定します。

ContainerIDFile
string or null

コンテナ ID を書き込むファイルのパス。

CpuCount
integer or null <int64>

使用可能な CPU 数（Windows のみ）。Windows Server コンテナでは CPU リソース制御は相互排他的です。優先順は CPUCount、CPUShares、CPUPercent です。

CpuPercent
integer or null <int64>

利用可能な CPU の使用可能な割合（Windows のみ）。Windows Server コンテナでは CPU リソース制御は相互排他的です。優先順は CPUCount、CPUShares、CPUPercent です。

CpuPeriod
integer or null <int64>

CPU の期間の長さ（マイクロ秒）。

CpuQuota
integer or null <int64>

コンテナが CPU の期間内に取得できる CPU 時間（マイクロ秒）。

CpuRealtimePeriod
integer or null <int64>

CPU のリアルタイム期間の長さ（マイクロ秒）。0 にすると、リアルタイムタスクに時間を割り当てません。

CpuRealtimeRuntime
integer or null <int64>

CPU のリアルタイム実行時間の長さ（マイクロ秒）。0 にすると、リアルタイムタスクに時間を割り当てません。

CpusetCpus
string or null

実行を許可する CPU（例：0-3、0,1）。

CpusetMems
string or null

実行を許可するメモリーノード（MEMs）（0-3、0,1）。NUMA システムでのみ有効です。

CpuShares
integer or null <int64>

ほかのコンテナに対する、このコンテナの相対的な CPU 重みを表す整数値。

DeviceCgroupRules
配列の要素型 strings or null

コンテナに適用する cgroup ルールの一覧。

配列の要素型 objects or null (DeviceRequest)

デバイスドライバーに送るデバイス要求の一覧。

Array
Capabilities
配列の要素型 strings or null[ items ]

ケーパビリティの一覧。内側の一覧を AND、外側の一覧を OR で評価します。

Count
integer or null <int64>
DeviceIDs
配列の要素型 strings or null
Driver
string or null
object or null

ドライバー固有のオプション。キーと値の組で指定し、ドライバーに直接渡します。

配列の要素型 objects or null (DeviceMapping)

コンテナに追加するデバイスの一覧。

Array
CgroupPermissions
string or null
PathInContainer
string or null
PathOnHost
string or null
Dns
配列の要素型 strings or null

コンテナで使う DNS サーバーの一覧。

DnsOptions
配列の要素型 strings or null

DNS オプションの一覧。

DnsSearch
配列の要素型 strings or null

DNS 検索ドメインの一覧。

ExtraHosts
配列の要素型 strings or null

コンテナの /etc/hosts ファイルに追加するホスト名と IP の対応の一覧。[\"hostname:IP\"] 形式です。

GroupAdd
配列の要素型 strings or null

コンテナのプロセスに適用する追加グループの一覧。

Init
boolean or null

コンテナ内で、シグナルの転送と終了したプロセスの回収を行う init を実行します。空の場合はフィールドを省略し、デーモンに設定したデフォルトを使います。

IOMaximumBandwidth
integer or null <int64>

コンテナのシステムドライブの最大 I/O（毎秒のバイト数）。Windows のみ。

IOMaximumIOps
integer or null <int64>

コンテナのシステムドライブの最大 IOPS。Windows のみ。

IpcMode
string or null

コンテナの IPC 共有モード。指定可能な値： - \"none\"：独自の専用 IPC 名前空間。/dev/shm はマウントしません - \"private\"：独自の専用 IPC 名前空間 - \"shareable\"：ほかのコンテナと共有できる独自の専用 IPC 名前空間 - \"container:<name|id>\"：ほかの共有可能なコンテナの IPC 名前空間に参加 - \"host\"：ホストシステムの IPC 名前空間を使用。未指定の場合は、デーモンのバージョンと設定に応じて \"private\" または \"shareable\" のデフォルトを使います。

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

カーネル TCP バッファーメモリーのハードリミット（バイト）。OCI ランタイムによっては無視されます。デフォルトの runc ランタイムではサポートしていません。空の場合はこのフィールドを省略します。

Links
配列の要素型 strings or null

container_name:alias 形式のコンテナリンクの一覧。

null or HostConfigLogConfig (object)
One of
null
MaskedPaths
配列の要素型 strings or null

コンテナ内で隠すパスの一覧（デフォルトのパス集合を上書きします）。

Memory
integer or null <int64>

メモリー制限（バイト）。

MemoryReservation
integer or null <int64>

メモリーのソフトリミット（バイト）。

MemorySwap
integer or null <int64>

メモリー全体の制限（メモリーとスワップ）。-1 にするとスワップが無制限になります。

MemorySwappiness
integer or null <int64>

コンテナのメモリー swappiness を調整します。0～100 の整数を受け取ります。

配列の要素型 objects or null (Mount)

コンテナに追加するマウントの仕様。

Array
null or MountBindOptions (object)
Consistency
string or null

マウントの一貫性要件：default、consistent、cached、delegated。

ReadOnly
boolean or null

マウントを読み取り専用にするか。

Source
string or null

マウント元（ボリューム名、ホストのパスなど）。

Target
string or null

コンテナのパス。

null or MountTmpfsOptions (object)
null or MountTypeEnum (string)
null or MountVolumeOptions (object)
NanoCpus
integer or null <int64>

10-9 CPU 単位の CPU クォータ。

NetworkMode
string or null

コンテナで使うネットワークモード。標準の値は bridge、host、none、container:<name|id> です。その他の値は、接続するカスタムネットワークの名前として扱います。

OomKillDisable
boolean or null

コンテナの OOM Killer を無効にする。

OomScoreAdj
integer or null <int64>

OOM killer の優先度を調整するためにコンテナに与えるスコアを含む整数値。

PidMode
string or null

コンテナの PID（プロセス）名前空間モードを設定します。 - \"container:<name|id>\"：別のコンテナの PID 名前空間に参加 - \"host\"：コンテナ内でホストの PID 名前空間を使用。

PidsLimit
integer or null <int64>

コンテナの PID 数の制限を調整します。0 または -1 は無制限、null は変更しないことを意味します。

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

コンテナにホストへの完全なアクセスを与えます。

PublishAllPorts
boolean or null

コンテナの公開ポートすべてに一時的なホストポートを割り当てます。停止時に解放し、起動時に割り当てます。再起動でポートが変わる場合があります。カーネルに依存する一時ポートの範囲から選びます。Linux では /proc/sys/net/ipv4/ip_local_port_range で範囲を定義します。

ReadonlyPaths
配列の要素型 strings or null

コンテナ内で読み取り専用にするパスの一覧（デフォルトのパス集合を上書きします）。

ReadonlyRootfs
boolean or null

コンテナのルートファイルシステムを読み取り専用でマウントする。

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

このコンテナで使うランタイム。

SecurityOpt
配列の要素型 strings or null

SELinux などの MLS システム用のラベルをカスタマイズする文字列の一覧。

ShmSize
integer or null <int64>

/dev/shm のサイズ（バイト）。省略すると 64 MB を使います。

object or null

このコンテナのストレージドライバーのオプション。{\"size\": \"120G\"} 形式です。

property name*
additional property
string
object or null

コンテナに設定するカーネルパラメーター（sysctl）の一覧。例： {\"net.ipv4.ip_forward\": \"1\"}

property name*
additional property
string
object or null

tmpfs マウントに置き換えるコンテナのディレクトリと、対応するマウントオプションのマップ。例： { \"/run\": \"rw,noexec,nosuid,size=65536k\" }

property name*
additional property
string
配列の要素型 objects or null (ResourcesUlimits)

コンテナに設定するリソース制限の一覧。例： {\"Name\": \"nofile\", \"Soft\": 1024, \"Hard\": 2048}

Array
Hard
integer or null <int64>

ハードリミット。

Name
string or null

ulimit の名前。

Soft
integer or null <int64>

ソフトリミット。

UsernsMode
string or null

ユーザー名前空間の再マッピングが有効な場合に、コンテナのユーザー名前空間モードを設定します。

UTSMode
string or null

コンテナで使う UTS 名前空間。

VolumeDriver
string or null

このコンテナがボリュームのマウントに使うドライバー。

VolumesFrom
配列の要素型 strings or null

別のコンテナから継承するボリュームの一覧。<container name>[:<ro|rw>] 形式です。

{
  • "CpuShares": 0,
  • "Memory": 0,
  • "CgroupParent": "string",
  • "BlkioWeight": 0,
  • "BlkioWeightDevice": [
    ],
  • "BlkioDeviceReadBps": [
    ],
  • "BlkioDeviceWriteBps": [
    ],
  • "BlkioDeviceReadIOps": [
    ],
  • "BlkioDeviceWriteIOps": [
    ],
  • "CpuPeriod": 0,
  • "CpuQuota": 0,
  • "CpuRealtimePeriod": 0,
  • "CpuRealtimeRuntime": 0,
  • "CpusetCpus": "string",
  • "CpusetMems": "string",
  • "Devices": [
    ],
  • "DeviceCgroupRules": [
    ],
  • "DeviceRequests": [
    ],
  • "KernelMemoryTCP": 0,
  • "MemoryReservation": 0,
  • "MemorySwap": 0,
  • "MemorySwappiness": 0,
  • "NanoCpus": 0,
  • "OomKillDisable": true,
  • "Init": true,
  • "PidsLimit": 0,
  • "Ulimits": [
    ],
  • "CpuCount": 0,
  • "CpuPercent": 0,
  • "IOMaximumIOps": 0,
  • "IOMaximumBandwidth": 0,
  • "Binds": [
    ],
  • "ContainerIDFile": "string",
  • "LogConfig": { },
  • "NetworkMode": "string",
  • "PortBindings": { },
  • "RestartPolicy": { },
  • "AutoRemove": true,
  • "VolumeDriver": "string",
  • "VolumesFrom": [
    ],
  • "Mounts": [
    ],
  • "ConsoleSize": [
    ],
  • "Annotations": {
    },
  • "CapAdd": [
    ],
  • "CapDrop": [
    ],
  • "CgroupnsMode": { },
  • "Dns": [
    ],
  • "DnsOptions": [
    ],
  • "DnsSearch": [
    ],
  • "ExtraHosts": [
    ],
  • "GroupAdd": [
    ],
  • "IpcMode": "string",
  • "Cgroup": "string",
  • "Links": [
    ],
  • "OomScoreAdj": 0,
  • "PidMode": "string",
  • "Privileged": true,
  • "PublishAllPorts": true,
  • "ReadonlyRootfs": true,
  • "SecurityOpt": [
    ],
  • "StorageOpt": {
    },
  • "Tmpfs": {
    },
  • "UTSMode": "string",
  • "UsernsMode": "string",
  • "ShmSize": 0,
  • "Sysctls": {
    },
  • "Runtime": "string",
  • "Isolation": { },
  • "MaskedPaths": [
    ],
  • "ReadonlyPaths": [
    ]
}

HostConfigCgroupnsModeEnum

string (HostConfigCgroupnsModeEnum)
列挙値: "EMPTY" "private" "host"
"EMPTY"

HostConfigIsolationEnum

string (HostConfigIsolationEnum)
列挙値: "EMPTY" "default" "process" "hyperv"
"EMPTY"

HostConfigLogConfig

object or null
property name*
additional property
string
Type
string or null
{
  • "Type": "string",
  • "Config": {
    }
}

HostInfo

Architecture
string or null

Go ランタイム（GOARCH）が返すホストのハードウェアアーキテクチャ。指定可能な値の完全な一覧は Go のドキュメントで確認できます。

BridgeNfIp6tables
boolean or null

ホストで bridge-nf-call-ip6tables が利用可能かを示します。

BridgeNfIptables
boolean or null

ホストで bridge-nf-call-iptables が利用可能かを示します。

CDISpecDirs
配列の要素型 strings or null

CDI（Container Device Interface）仕様があるディレクトリの一覧。作成するコンテナの OCI ランタイム仕様に対する、ベンダー固有の変更を定義します。空の一覧は CDI デバイス注入が無効であることを示します。注入にはデーモンの実験的機能を有効にする必要があり、無効なデーモンでは常に空の一覧を返します。

null or SystemInfoCgroupDriverEnum (string)
One of
null
null or SystemInfoCgroupVersionEnum (string)
One of
null
required
object (DaemonConfig)

デーモンの設定。

advertise_addr
required
string

ほかのノードに通知するアドレス。

conf_dir
required
string

設定ディレクトリ。

docker_host
string

使用する Docker ホスト。

gateway
required
string

ホストのゲートウェイ。未指定の場合はホストのデフォルトゲートウェイを自動検出します。

gid
required
integer <int32> >= 0

グループ ID。

hostname
required
string

ノードのホスト名。未指定の場合は自動検出します。

hosts
required
配列の要素型 strings

待ち受けるホストの一覧。

nodes
required
配列の要素型 strings

参加するノードの一覧。

null or SslConfig (object)
state_dir
required
string

状態ディレクトリのパス。

store_addr
string or null

接続するストアのアドレス。

null or Commit (object)
One of
null
Containers
integer or null <int64>

ホスト上のコンテナ総数。

ContainersPaused
integer or null <int64>

状態が \"paused\" のコンテナ数。

ContainersRunning
integer or null <int64>

状態が \"running\" のコンテナ数。

ContainersStopped
integer or null <int64>

状態が \"stopped\" のコンテナ数。

CpuCfsPeriod
boolean or null

ホストが CPU CFS（Completely Fair Scheduler）の期間設定に対応するかを示します。

CpuCfsQuota
boolean or null

ホストが CPU CFS（Completely Fair Scheduler）のクォータに対応するかを示します。

CPUSet
boolean or null

ホストが CPUset（cpuset.cpus、cpuset.mems）に対応するかを示します。cpuset(7) を参照してください。

CPUShares
boolean or null

ホストが CPU Shares の制限に対応するかを示します。

Debug
boolean or null

デーモンがデバッグモード、またはデバッグレベルのログを有効にして動作しているかを示します。

配列の要素型 objects or null (SystemInfoDefaultAddressPools)

ローカルネットワークの独自のデフォルトアドレスプールの一覧。daemon.json または dockerd のオプションで指定できます。例：Base が "10.10.0.0/16"、Size が 24 なら、256 個の 10.10.[0-255].0/24 アドレスプールを定義します。

Array
Base
string or null

CIDR 形式のネットワークアドレス。

Size
integer or null <int64>

ネットワークプールのサイズ。

DefaultRuntime
string or null

コンテナの起動に使うデフォルトの OCI ランタイムの名前。作成時にコンテナごとに上書きできます。

DockerRootDir
string or null

Docker の永続状態のルートディレクトリ。Linux のデフォルトは /var/lib/docker、Windows では C:\\ProgramData\\docker です。

Driver
string or null

使用中のストレージドライバーの名前。

DriverStatus
配列の要素型 strings or null[ items ]

ストレージドライバー固有の情報。"label" と "value" の組で提供します。ドライバーが提供し、コマンドラインの docker info と一貫した形式に整えます。


> 注：値とラベルの形式を含め、この情報は安定していると見なさないでください。予告なく変わる場合があります。

ExperimentalBuild
boolean or null

デーモンで実験的な機能が有効かを示します。

null or GenericResourcesInner (object)
One of
null
HostGateway
required
string

HostGateway はホストのゲートウェイアドレスです。

HttpProxy
string or null

デーモンに設定した HTTP プロキシ。HTTP_PROXY 環境変数から取得します。プロキシ URL の認証情報（ユーザー情報の要素）は API レスポンス内で隠します。コンテナはこの設定を自動継承しません。

HttpsProxy
string or null

デーモンに設定した HTTPS プロキシ。HTTPS_PROXY 環境変数から取得します。プロキシ URL の認証情報（ユーザー情報の要素）は API レスポンス内で隠します。コンテナはこの設定を自動継承しません。

ID
string or null

デーモンの一意な識別子。


> 注：ID 自体の形式は API の一部ではなく、安定していると見なさないでください。

Images
integer or null <int64>

ホスト上のイメージ総数。_タグ付き_と_タグなし_（dangling）の両方を数えます。

IndexServerAddress
string or null

イメージ検索と、Docker Hub と Docker Cloud のユーザー認証のデフォルトに使うインデックスサーバーのアドレスまたは URL。

InitBinary
string or null

docker-init バイナリーの名前と、任意のパス。パスを省略すると、デーモンはホストの $PATH を検索し、最初の結果を使います。

null or Commit (object)
One of
null
IPv4Forwarding
boolean or null

IPv4 転送が有効かを示します。

null or SystemInfoIsolationEnum (string)
One of
null
KernelMemoryTCP
boolean or null

ホストでカーネルメモリーの TCP 制限が有効かを示します。未対応なら省略します。対応する memory.kmem.tcp.limit_in_bytes cgroup がない cgroup v2 では、カーネルメモリーの TCP 制限に対応しません。

KernelVersion
string or null

ホストのカーネルバージョン。Linux では uname から取得します。Windows では HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ のレジストリ値を問い合わせます。例：_"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_。

Labels
配列の要素型 strings or null

デーモンに設定したユーザー定義のラベル（キーと値のメタデータ）。


> 注：Swarm 内のノードには、デーモン設定による_デーモン_ラベルと、マネージャーノードから設定する_ノード_ラベルの両方があります。このフィールドにはノードラベルを含みません。 > マネージャーノードの /nodes/(id) エンドポイントで取得できます。

LiveRestoreEnabled
boolean or null

live restore が有効かを示します。有効なら、デーモン停止時や、起動時に実行中のコンテナを検出した場合もコンテナの実行を継続します。

LoggingDriver
string or null

新しいコンテナのデフォルトとして使うログドライバー。

MemoryLimit
boolean or null

ホストでメモリー制限のサポートが有効かを示します。

MemTotal
integer or null <int64>

ホスト上で利用可能な物理メモリーの総量（バイト）。

Name
string or null

ホストのホスト名。

NCPU
integer or null <int64>

デーモンが使える論理 CPU 数。起動時に OS に問い合わせて確認します。起動後の OS の CPU 割り当て変更は反映しません。

required
object (Network)

ネットワークの設定。

Attachable
boolean or null
object or null
null or String (string)
Driver
string or null
EnableIPv6
boolean or null
Id
string or null
Ingress
boolean or null
Internal
boolean or null
null or Ipam (object)
object or null
Name
string or null
object or null
Scope
string or null
NEventsListener
integer or null <int64>

購読中のイベントリスナー数。

NFd
integer or null <int64>

デーモンのプロセスが使用中のファイルディスクリプターの総数。デバッグモードが有効な場合だけ返します。

NGoroutines
integer or null <int64>

現在存在する goroutine の数。デバッグモードが有効な場合だけ返します。

NoProxy
string or null

プロキシを使わないドメイン拡張子のカンマ区切り一覧。NO_PROXY 環境変数から取得します。コンテナはこの設定を自動継承しません。

OomKillDisable
boolean or null

ホストが OOM killer の無効化に対応するかを示します。

OperatingSystem
string or null

ホストの OS 名。例："Ubuntu 16.04.2 LTS"、"Windows Server 2016 Datacenter"。

OSType
string or null

Go ランタイム（GOOS）が返す、ホスト OS の一般的な種類。現在の値は "linux" と "windows" です。指定可能な値の完全な一覧は Go のドキュメントで確認できます。

OSVersion
string or null

ホスト OS のバージョン。


> 注：このフィールドの存在や値の形式も含め、情報は安定していると見なさないでください。予告なく変わる場合があります。

PidsLimit
boolean or null

ホストカーネルで PID 制限のサポートが有効かを示します。

null or PluginsInfo (object)
One of
null
ProductLicense
string or null

デーモンの製品ライセンスの概要を報告します。商用ライセンスが適用されている場合は、ノード数や有効期限などの情報を含みます。

null or RegistryServiceConfig (object)
One of
null
null or Commit (object)
One of
null
object or null

デーモンに設定した OCI 準拠ランタイムの一覧。キーはランタイムを参照する "name" を保持します。Docker デーモンは、containerd を通じて呼び出す OCI 準拠ランタイムを、Linux カーネルの名前空間、cgroup、SELinux へのインターフェースとして使います。デフォルトの runc は自動設定されます。ユーザーが追加のランタイムを設定すると、ここに一覧されます。

additional property
object (Runtime)

Runtime は OCI 準拠ランタイムを表します。デーモンは containerd を通じて呼び出します。OCI ランタイムは、Linux カーネルの名前空間、cgroup、SELinux へのインターフェースです。

SecurityOptions
配列の要素型 strings or null

apparmor、seccomp、SELinux、userns、rootless、no-new-privileges など、デーモンで有効なセキュリティ機能の一覧。機能ごとの追加設定がある場合は、キーと値の組をカンマ区切りで含めます。

ServerVersion
string or null

デーモンのバージョン文字列。

SwapLimit
boolean or null

ホストでスワップメモリー制限のサポートが有効かを示します。

null or SwarmInfo (object)
One of
null
SystemTime
string or null

ナノ秒精度の RFC 3339 形式の現在のシステム時刻。

Warnings
配列の要素型 strings or null

機能不足やデーモン設定の問題に関する警告と情報メッセージの一覧。クライアントはユーザー向けの情報として表示できます。

{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": { },
  • "MemoryLimit": true,
  • "SwapLimit": true,
  • "KernelMemoryTCP": true,
  • "CpuCfsPeriod": true,
  • "CpuCfsQuota": true,
  • "CPUShares": true,
  • "CPUSet": true,
  • "PidsLimit": true,
  • "OomKillDisable": true,
  • "IPv4Forwarding": true,
  • "BridgeNfIptables": true,
  • "BridgeNfIp6tables": true,
  • "Debug": true,
  • "NFd": 0,
  • "NGoroutines": 0,
  • "SystemTime": "string",
  • "LoggingDriver": "string",
  • "CgroupDriver": { },
  • "CgroupVersion": { },
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": { },
  • "GenericResources": { },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": { },
  • "LiveRestoreEnabled": true,
  • "Isolation": { },
  • "InitBinary": "string",
  • "ContainerdCommit": { },
  • "RuncCommit": { },
  • "InitCommit": { },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ],
  • "HostGateway": "string",
  • "Network": {
    },
  • "Config": {
    }
}

Hsts

One of
string
値: "Recommended"
{
  • "Config": {
    }
}

HstsConfig

Always
required
boolean
IncludeSubDomains
required
boolean
MaxAge
required
integer <int64> >= 0
Preload
required
boolean
{
  • "MaxAge": 0,
  • "Preload": true,
  • "Always": true,
  • "IncludeSubDomains": true
}

HttpTarget

null or UrlRedirect (string)
One of
null
Url
required
string

ターゲットの URL。

{
  • "Url": "string",
  • "Redirect": { }
}

ImagePullPolicy

string (ImagePullPolicy)
列挙値: "Never" "Always" "IfNotPresent"

プロセスオブジェクト（ジョブ、Cargo、VM）に関連するイメージの取得ポリシー。

"Never"

IndexInfo

Mirrors
配列の要素型 strings or null

URI で表すミラーの一覧。

Name
string or null

レジストリの名前（例："docker.io"）。

Official
boolean or null

公式のレジストリ（Docker Hub / docker.io）かを示します。

Secure
boolean or null

レジストリが安全でないレジストリの一覧に含まれるかを示します。false の場合、そのレジストリは安全ではありません。暗号化しない HTTP や、未知の CA の証明書による信頼しない HTTPS の通信を受け付けます。 > 警告：ローカルレジストリでは便利な場合もありますが、セキュリティ上の脆弱性を生むため、テスト目的でのみ有効にしてください。 > セキュリティを高めるには、このオプションを有効にする代わりに、システムの信頼する CA 一覧に自分の CA を追加してください。

{
  • "Name": "string",
  • "Mirrors": [
    ],
  • "Secure": true,
  • "Official": true
}

Ipam

配列の要素型 objects or null (IpamConfig)

マップで指定する IPAM 設定オプションの一覧： {\"Subnet\": <CIDR>, \"IPRange\": <CIDR>, \"Gateway\": <IP address>, \"AuxAddress\": <device_name:IP address>}

Array
object or null
Gateway
string or null
IPRange
string or null
Subnet
string or null
Driver
string or null

使用する IPAM ドライバーの名前。

object or null

ドライバー固有のオプション。マップで指定します。

property name*
additional property
string
{
  • "Driver": "string",
  • "Config": [
    ],
  • "Options": {
    }
}

IpamConfig

object or null
property name*
additional property
string
Gateway
string or null
IPRange
string or null
Subnet
string or null
{
  • "Subnet": "string",
  • "IPRange": "string",
  • "Gateway": "string",
  • "AuxiliaryAddresses": {
    }
}

Job

required
配列の要素型 objects (Config)

実行するコンテナ。

Array
ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

CreatedAt
required
string <date-time>

ジョブの作成時刻。

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

イメージ取得時に使うシークレット。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

ジョブの名前。

Schedule
string or null

ジョブのスケジュール（cron）。

Secrets
配列の要素型 strings or null

環境変数として読み込むシークレット。

required
object (ObjPsStatus)

ジョブの状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
Ttl
integer or null >= 0

実行後 x 秒経過してからジョブを削除する。

UpdatedAt
required
string <date-time>

ジョブの更新時刻。

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

JobInspect

InstanceFailed
required
integer >= 0

失敗したインスタンス数。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

required
配列の要素型 objects (Process)

インスタンスの一覧。

Array
CreatedAt
required
string <date-time>

作成日時。

required
object (ContainerInspectResponse)

プロセスのデータ（ContainerInspect）。

Key
required
string

プロセスのキー。

Kind
required
string (ProcessKind)
列挙値: "vm" "job" "cargo"

プロセスの種類（Job、Vm、Cargo）。

KindKey
required
string

関連する種類のキー。

Name
required
string

プロセスの名前。

NodeName
required
string

コンテナを実行するノードの名前。

UpdatedAt
required
string <date-time>

インスタンスの最終更新時刻。

InstanceSuccess
required
integer >= 0

成功したインスタンス数。

InstanceTotal
required
integer >= 0

インスタンス数。

required
object (Job)

ジョブの仕様。

required
配列の要素型 objects (Config)

実行するコンテナ。

CreatedAt
required
string <date-time>

ジョブの作成時刻。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

object

メタデータ（ユーザー定義）。

Name
required
string

ジョブの名前。

Schedule
string or null

ジョブのスケジュール（cron）。

Secrets
配列の要素型 strings or null

環境変数として読み込むシークレット。

required
object (ObjPsStatus)

ジョブの状態。

Ttl
integer or null >= 0

実行後 x 秒経過してからジョブを削除する。

UpdatedAt
required
string <date-time>

ジョブの更新時刻。

{
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    },
  • "Instances": [
    ]
}

JobPartial

required
配列の要素型 objects (Config)

実行するコンテナの一覧。

Array
ArgsEscaped
boolean or null

コマンドはエスケープ済みです（Windows のみ）。

AttachStderr
boolean or null

stderr に接続するか。

AttachStdin
boolean or null

stdin に接続するか。

AttachStdout
boolean or null

stdout に接続するか。

Cmd
配列の要素型 strings or null

実行するコマンド。文字列または文字列の配列で指定します。

Domainname
string or null

コンテナで使うドメイン名。

Entrypoint
配列の要素型 strings or null

コンテナのエントリーポイント。文字列または文字列の配列です。配列が空文字列 1 つ（[\"\"]）だけなら、システムのデフォルトに戻します。これは ENTRYPOINT 命令が Dockerfile にない場合に Docker が使うエントリーポイントです。

Env
配列の要素型 strings or null

コンテナ内に設定する環境変数の一覧。[\"VAR=value\", ...] 形式です。= のない変数は空の値を設定せず、環境から削除します。

object or null

ポートを空のオブジェクトに対応付けるオブジェクト。形式： {\"<port>/<tcp|udp|sctp>\": {}}

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

コンテナで使う、RFC 1123 に準拠したホスト名。

Image
string or null

コンテナの作成時に使うイメージ名。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

コンテナの MAC アドレス。

NetworkDisabled
boolean or null

コンテナのネットワークを無効にする。

null or NetworkingConfig_String (object)
OnBuild
配列の要素型 strings or null

ONBUILD メタデータ。イメージの Dockerfile で定義したものです。

OpenStdin
boolean or null

stdin を開く。

Shell
配列の要素型 strings or null

RUN、CMD、ENTRYPOINT がシェルを使う場合のシェル。

StdinOnce
boolean or null

接続したクライアントが切断すると stdin を閉じる。

StopSignal
string or null

コンテナを停止するシグナル。文字列または符号なし整数。

StopTimeout
integer or null <int64>

コンテナを停止するタイムアウト（秒）。

Tty
boolean or null

閉じていない stdin を含め、標準ストリームを TTY に接続します。

User
string or null

コンテナ内でコマンドを実行するユーザー。

object or null

コンテナ内のマウントポイントのパスを空のオブジェクトに対応付けるオブジェクト。

WorkingDir
string or null

コマンドを実行する作業ディレクトリ。

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

イメージ取得時に使うシークレット。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

ジョブの名前。

Schedule
string or null

ジョブのスケジュール（cron）。

Secrets
配列の要素型 strings or null

環境変数として読み込むシークレット。

Ttl
integer or null >= 0

実行後 x 秒経過してからジョブを削除する。

{
  • "Name": "string",
  • "Secrets": [
    ],
  • "Metadata": {
    },
  • "Schedule": "string",
  • "Ttl": 0,
  • "ImagePullSecret": "string",
  • "ImagePullPolicy": { },
  • "Containers": [
    ]
}

JobSummary

InstanceFailed
required
integer >= 0

失敗したインスタンス数。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

InstanceSuccess
required
integer >= 0

成功したインスタンス数。

InstanceTotal
required
integer >= 0

インスタンス数。

required
object (Job)

ジョブの仕様。

required
配列の要素型 objects (Config)

実行するコンテナ。

CreatedAt
required
string <date-time>

ジョブの作成時刻。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

object

メタデータ（ユーザー定義）。

Name
required
string

ジョブの名前。

Schedule
string or null

ジョブのスケジュール（cron）。

Secrets
配列の要素型 strings or null

環境変数として読み込むシークレット。

required
object (ObjPsStatus)

ジョブの状態。

Ttl
integer or null >= 0

実行後 x 秒経過してからジョブを削除する。

UpdatedAt
required
string <date-time>

ジョブの更新時刻。

{
  • "InstanceTotal": 0,
  • "InstanceSuccess": 0,
  • "InstanceRunning": 0,
  • "InstanceFailed": 0,
  • "Spec": {
    }
}

LimitReq

Burst
required
integer >= 0

バーストサイズ。

Delay
integer or null >= 0

再試行まで待つ時間。

{
  • "Burst": 0,
  • "Delay": 0
}

LimitReqZone

Rate
required
integer >= 0

毎秒の最大リクエスト数。

Size
required
integer >= 0

キャッシュの最大サイズ（MB）。

{
  • "Size": 0,
  • "Rate": 0
}

LocalNodeState

string (LocalNodeState)
列挙値: "EMPTY" "inactive" "pending" "active" "error" "locked"

このノードの現在のローカル状態。 値の列挙型です。 各バリアントがデータを保持しないため、#[repr(C)] として簡単に定義でき、FFI に役立ちます。

"EMPTY"

LocationTarget

One of
DisableLogging
boolean or null

このターゲットのログを無効にする。

Key
required
string

ターゲットにする Cargo または VM のキー。

Path
string or null

HTTP 利用時にターゲットにする HTTP パス。

Port
required
integer <int32> >= 0

ターゲットにする Cargo または VM のポート。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
Example
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true,
  • "Ssl": { }
}

MemoryStats

commit
integer or null <int64> >= 0
commit_peak
integer or null <int64> >= 0
commitbytes
integer or null <int64> >= 0
commitpeakbytes
integer or null <int64> >= 0
failcnt
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
max_usage
integer or null <int64> >= 0
privateworkingset
integer or null <int64> >= 0
null or (MemoryStatsStats (MemoryStatsStatsV1 (object) or MemoryStatsStatsV2 (object)))
One of
null
usage
integer or null <int64> >= 0
{
  • "stats": { },
  • "max_usage": 0,
  • "usage": 0,
  • "failcnt": 0,
  • "limit": 0,
  • "commit": 0,
  • "commit_peak": 0,
  • "commitbytes": 0,
  • "commitpeakbytes": 0,
  • "privateworkingset": 0
}

MemoryStatsStats

One of
active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
cache
required
integer <int64> >= 0
dirty
required
integer <int64> >= 0
hierarchical_memory_limit
required
integer <int64> >= 0
hierarchical_memsw_limit
integer or null <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
mapped_file
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgpgin
required
integer <int64> >= 0
pgpgout
required
integer <int64> >= 0
rss
required
integer <int64> >= 0
rss_huge
required
integer <int64> >= 0
shmem
integer or null <int64> >= 0
total_active_anon
required
integer <int64> >= 0
total_active_file
required
integer <int64> >= 0
total_cache
required
integer <int64> >= 0
total_dirty
required
integer <int64> >= 0
total_inactive_anon
required
integer <int64> >= 0
total_inactive_file
required
integer <int64> >= 0
total_mapped_file
required
integer <int64> >= 0
total_pgfault
required
integer <int64> >= 0
total_pgmajfault
required
integer <int64> >= 0
total_pgpgin
required
integer <int64> >= 0
total_pgpgout
required
integer <int64> >= 0
total_rss
required
integer <int64> >= 0
total_rss_huge
required
integer <int64> >= 0
total_shmem
integer or null <int64> >= 0
total_unevictable
required
integer <int64> >= 0
total_writeback
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
writeback
required
integer <int64> >= 0
Example
{
  • "cache": 0,
  • "dirty": 0,
  • "mapped_file": 0,
  • "total_inactive_file": 0,
  • "pgpgout": 0,
  • "rss": 0,
  • "total_mapped_file": 0,
  • "writeback": 0,
  • "unevictable": 0,
  • "pgpgin": 0,
  • "total_unevictable": 0,
  • "pgmajfault": 0,
  • "total_rss": 0,
  • "total_rss_huge": 0,
  • "total_writeback": 0,
  • "total_inactive_anon": 0,
  • "rss_huge": 0,
  • "hierarchical_memory_limit": 0,
  • "total_pgfault": 0,
  • "total_active_file": 0,
  • "active_anon": 0,
  • "total_active_anon": 0,
  • "total_pgpgout": 0,
  • "total_cache": 0,
  • "total_dirty": 0,
  • "inactive_anon": 0,
  • "active_file": 0,
  • "pgfault": 0,
  • "inactive_file": 0,
  • "total_pgmajfault": 0,
  • "total_pgpgin": 0,
  • "hierarchical_memsw_limit": 0,
  • "shmem": 0,
  • "total_shmem": 0
}

MemoryStatsStatsV1

active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
cache
required
integer <int64> >= 0
dirty
required
integer <int64> >= 0
hierarchical_memory_limit
required
integer <int64> >= 0
hierarchical_memsw_limit
integer or null <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
mapped_file
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgpgin
required
integer <int64> >= 0
pgpgout
required
integer <int64> >= 0
rss
required
integer <int64> >= 0
rss_huge
required
integer <int64> >= 0
shmem
integer or null <int64> >= 0
total_active_anon
required
integer <int64> >= 0
total_active_file
required
integer <int64> >= 0
total_cache
required
integer <int64> >= 0
total_dirty
required
integer <int64> >= 0
total_inactive_anon
required
integer <int64> >= 0
total_inactive_file
required
integer <int64> >= 0
total_mapped_file
required
integer <int64> >= 0
total_pgfault
required
integer <int64> >= 0
total_pgmajfault
required
integer <int64> >= 0
total_pgpgin
required
integer <int64> >= 0
total_pgpgout
required
integer <int64> >= 0
total_rss
required
integer <int64> >= 0
total_rss_huge
required
integer <int64> >= 0
total_shmem
integer or null <int64> >= 0
total_unevictable
required
integer <int64> >= 0
total_writeback
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
writeback
required
integer <int64> >= 0
{
  • "cache": 0,
  • "dirty": 0,
  • "mapped_file": 0,
  • "total_inactive_file": 0,
  • "pgpgout": 0,
  • "rss": 0,
  • "total_mapped_file": 0,
  • "writeback": 0,
  • "unevictable": 0,
  • "pgpgin": 0,
  • "total_unevictable": 0,
  • "pgmajfault": 0,
  • "total_rss": 0,
  • "total_rss_huge": 0,
  • "total_writeback": 0,
  • "total_inactive_anon": 0,
  • "rss_huge": 0,
  • "hierarchical_memory_limit": 0,
  • "total_pgfault": 0,
  • "total_active_file": 0,
  • "active_anon": 0,
  • "total_active_anon": 0,
  • "total_pgpgout": 0,
  • "total_cache": 0,
  • "total_dirty": 0,
  • "inactive_anon": 0,
  • "active_file": 0,
  • "pgfault": 0,
  • "inactive_file": 0,
  • "total_pgmajfault": 0,
  • "total_pgpgin": 0,
  • "hierarchical_memsw_limit": 0,
  • "shmem": 0,
  • "total_shmem": 0
}

MemoryStatsStatsV2

active_anon
required
integer <int64> >= 0
active_file
required
integer <int64> >= 0
anon
required
integer <int64> >= 0
anon_thp
required
integer <int64> >= 0
file
required
integer <int64> >= 0
file_dirty
required
integer <int64> >= 0
file_mapped
required
integer <int64> >= 0
file_writeback
required
integer <int64> >= 0
inactive_anon
required
integer <int64> >= 0
inactive_file
required
integer <int64> >= 0
kernel_stack
required
integer <int64> >= 0
pgactivate
required
integer <int64> >= 0
pgdeactivate
required
integer <int64> >= 0
pgfault
required
integer <int64> >= 0
pglazyfree
required
integer <int64> >= 0
pglazyfreed
required
integer <int64> >= 0
pgmajfault
required
integer <int64> >= 0
pgrefill
required
integer <int64> >= 0
pgscan
required
integer <int64> >= 0
pgsteal
required
integer <int64> >= 0
shmem
required
integer <int64> >= 0
slab
required
integer <int64> >= 0
slab_reclaimable
required
integer <int64> >= 0
slab_unreclaimable
required
integer <int64> >= 0
sock
required
integer <int64> >= 0
thp_collapse_alloc
required
integer <int64> >= 0
thp_fault_alloc
required
integer <int64> >= 0
unevictable
required
integer <int64> >= 0
workingset_activate
required
integer <int64> >= 0
workingset_nodereclaim
required
integer <int64> >= 0
workingset_refault
required
integer <int64> >= 0
{
  • "anon": 0,
  • "file": 0,
  • "kernel_stack": 0,
  • "slab": 0,
  • "sock": 0,
  • "shmem": 0,
  • "file_mapped": 0,
  • "file_dirty": 0,
  • "file_writeback": 0,
  • "anon_thp": 0,
  • "inactive_anon": 0,
  • "active_anon": 0,
  • "inactive_file": 0,
  • "active_file": 0,
  • "unevictable": 0,
  • "slab_reclaimable": 0,
  • "slab_unreclaimable": 0,
  • "pgfault": 0,
  • "pgmajfault": 0,
  • "workingset_refault": 0,
  • "workingset_activate": 0,
  • "workingset_nodereclaim": 0,
  • "pgrefill": 0,
  • "pgscan": 0,
  • "pgsteal": 0,
  • "pgactivate": 0,
  • "pgdeactivate": 0,
  • "pglazyfree": 0,
  • "pglazyfreed": 0,
  • "thp_fault_alloc": 0,
  • "thp_collapse_alloc": 0
}

Metric

CreatedAt
required
string <date-time>

メトリクスの作成時刻。

Data
required
any

メトリクスのデータ。

ExpiresAt
required
string <date-time>

メトリクスの有効期限。

Key
required
string <uuid>

データベース内のメトリクスのキー（UUID）。

Kind
required
string

メトリクスの種類。

NodeName
required
string

メトリクスの取得元のノード。

Note
string or null

メトリクスの任意の注記。

{
  • "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "ExpiresAt": "2019-08-24T14:15:22Z",
  • "NodeName": "string",
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

MetricPartial

Data
required
any

メトリクスのデータ。

Kind
required
string

メトリクスの種類。

Note
string or null

メトリクスの任意の注記。

{
  • "Kind": "string",
  • "Data": null,
  • "Note": "string"
}

Mount

null or MountBindOptions (object)
One of
null
Consistency
string or null

マウントの一貫性要件：default、consistent、cached、delegated。

ReadOnly
boolean or null

マウントを読み取り専用にするか。

Source
string or null

マウント元（ボリューム名、ホストのパスなど）。

Target
string or null

コンテナのパス。

null or MountTmpfsOptions (object)
One of
null
null or MountTypeEnum (string)
One of
null
null or MountVolumeOptions (object)
One of
null
{
  • "Target": "string",
  • "Source": "string",
  • "Type": { },
  • "ReadOnly": true,
  • "Consistency": "string",
  • "BindOptions": { },
  • "VolumeOptions": { },
  • "TmpfsOptions": { }
}

MountBindOptions

CreateMountpoint
boolean or null

ホスト上のマウントポイントがなければ作成する。

NonRecursive
boolean or null

再帰的なバインドマウントを無効にする。

null or MountBindOptionsPropagationEnum (string)
One of
null
ReadOnlyForceRecursive
boolean or null

マウントを再帰的に読み取り専用にできない場合、エラーを発生させる。

ReadOnlyNonRecursive
boolean or null

マウントを再帰的でない読み取り専用にします。NonRecursive も同時に true に設定しない限り、マウント自体は再帰的なままです。v1.44 で追加しました。それ以前はすべての読み取り専用マウントがデフォルトで非再帰的でした。旧動作に合わせ、v1.44 より前のクライアントではデフォルトを true にします。

{
  • "Propagation": { },
  • "NonRecursive": true,
  • "CreateMountpoint": true,
  • "ReadOnlyNonRecursive": true,
  • "ReadOnlyForceRecursive": true
}

MountBindOptionsPropagationEnum

string (MountBindOptionsPropagationEnum)
列挙値: "EMPTY" "private" "rprivate" "shared" "rshared" "slave" "rslave"
"EMPTY"

MountPoint

Destination
string or null

Destination はコンテナのルート（/）からの相対パスです。コンテナ内のこの場所に Source をマウントします。

Driver
string or null

Driver はボリュームの作成に使うボリュームドライバーです（ボリュームの場合）。

Mode
string or null

Mode はバインドまたはボリュームのマウント作成時に、ユーザーが指定したオプションのカンマ区切り一覧です。デフォルトはプラットフォーム固有（Linux では \"z\"、Windows では空）です。

Name
string or null

Name は、Source が定義する元データを参照する名前（ボリューム名など）です。

Propagation
string or null

Propagation はホストとマウントポイントの間で、双方向にマウントを伝播する方法を表します。詳細は Linux カーネルのドキュメントを参照してください。Windows では使いません。

RW
boolean or null

マウントが書き込み可能（読み書き可能）か。

Source
string or null

マウント元の場所。ボリュームでは、/var/lib/docker/volumes/ 内の保存場所です。バインドマウントと npipe では、バインド元のホスト部分です。tmpfs マウントでは空です。

null or MountPointTypeEnum (string)
One of
null
{
  • "Type": { },
  • "Name": "string",
  • "Source": "string",
  • "Destination": "string",
  • "Driver": "string",
  • "Mode": "string",
  • "RW": true,
  • "Propagation": "string"
}

MountPointTypeEnum

string (MountPointTypeEnum)
列挙値: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountTmpfsOptions

Mode
integer or null <int64>

tmpfs マウントのアクセス許可モード。整数で指定します。

SizeBytes
integer or null <int64>

tmpfs マウントのサイズ（バイト）。

{
  • "SizeBytes": 0,
  • "Mode": 0
}

MountTypeEnum

string (MountTypeEnum)
列挙値: "EMPTY" "bind" "volume" "tmpfs" "npipe" "cluster"
"EMPTY"

MountVolumeOptions

null or MountVolumeOptionsDriverConfig (object)
One of
null
object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
NoCopy
boolean or null

ターゲットのデータでボリュームを初期化する。

Subpath
string or null

ボリューム内の元のパス。親ディレクトリへの移動を含まない相対パスである必要があります。

{
  • "NoCopy": true,
  • "Labels": {
    },
  • "DriverConfig": { },
  • "Subpath": "string"
}

MountVolumeOptionsDriverConfig

Name
string or null

ボリュームの作成に使うドライバーの名前。

object or null

ドライバー固有のオプションの、キーと値のマップ。

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

Namespace

CreatedAt
required
string <date-time>

名前空間の作成時刻。

Metadata
any

ユーザー定義のメタデータ。

Name
required
string

名前空間の主キーとなる名前。

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Metadata": null
}

NamespaceInspect

required
配列の要素型 objects (CargoInspect)

Cargo の数。

Array
CreatedAt
required
string <date-time>

Cargo の作成時刻。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

required
配列の要素型 objects (Process)

インスタンスの一覧。

InstanceTotal
required
integer >= 0

インスタンス数。

NamespaceName
required
string

名前空間の名前。

required
object (CargoSpec)

Cargo の仕様。

required
object (ObjPsStatus)

Cargo の状態。

Name
required
string

名前空間の名前。

{
  • "Name": "string",
  • "Cargoes": [
    ]
}

NamespacePartial

Metadata
any

ユーザー定義のメタデータ。

Name
required
string

名前空間の名前。

{
  • "Name": "string",
  • "Metadata": null
}

NamespaceSummary

Cargoes
required
integer >= 0

Cargo の数。

CreatedAt
required
string <date-time>

名前空間の作成時刻。

Instances
required
integer >= 0

インスタンス数。

Name
required
string

名前空間の名前。

{
  • "Name": "string",
  • "Cargoes": 0,
  • "Instances": 0,
  • "CreatedAt": "2019-08-24T14:15:22Z"
}

NativeEventAction

One of
string
値: "create"

Action はイベントを引き起こしたアクションです。

{
  • "other": "string"
}

Network

Attachable
boolean or null
object or null
additional property
object (NetworkContainer)
null or String (string)
One of
null
Driver
string or null
EnableIPv6
boolean or null
Id
string or null
Ingress
boolean or null
Internal
boolean or null
null or Ipam (object)
One of
null
object or null
property name*
additional property
string
Name
string or null
object or null
property name*
additional property
string
Scope
string or null
{
  • "Name": "string",
  • "Id": "string",
  • "Created": { },
  • "Scope": "string",
  • "Driver": "string",
  • "EnableIPv6": true,
  • "IPAM": { },
  • "Internal": true,
  • "Attachable": true,
  • "Ingress": true,
  • "Containers": {
    },
  • "Options": {
    },
  • "Labels": {
    }
}

NetworkContainer

EndpointID
string or null
IPv4Address
string or null
IPv6Address
string or null
MacAddress
string or null
Name
string or null
{
  • "Name": "string",
  • "EndpointID": "string",
  • "MacAddress": "string",
  • "IPv4Address": "string",
  • "IPv6Address": "string"
}

NetworkKind

One of
string
値: "All"

すべてのネットワーク。

{
  • "Other": "string"
}

NetworkSettings

Bridge
string or null

dockerd の --bridge フラグが設定されている場合の、デフォルトのブリッジインターフェース名。

EndpointID
string or null

EndpointID は Sandbox 内のサービスエンドポイントを一意に表します。


> 非推奨：このフィールドはデフォルトの "bridge" ネットワークに接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

Gateway
string or null

デフォルトの "bridge" ネットワークのゲートウェイアドレス。


> 非推奨：このフィールドはデフォルトの "bridge" ネットワークに接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

GlobalIPv6Address
string or null

デフォルトの "bridge" ネットワークのグローバル IPv6 アドレス。


> 非推奨：このフィールドはデフォルトの "bridge" ネットワークに接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

GlobalIPv6PrefixLen
integer or null <int64>

グローバル IPv6 アドレスのマスク長。


> 非推奨：デフォルトの "bridge" に接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" 情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

HairpinMode
boolean or null

仮想インターフェースでヘアピン NAT を有効にするかを示します。非推奨：設定されることがなく、今後のリリースで削除します。

IPAddress
string or null

デフォルトの "bridge" ネットワークの IPv4 アドレス。


> 非推奨：このフィールドはデフォルトの "bridge" ネットワークに接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

IPPrefixLen
integer or null <int64>

IPv4 アドレスのマスク長。


> 非推奨：デフォルトの "bridge" に接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

IPv6Gateway
string or null

このネットワークの IPv6 ゲートウェイアドレス。


> 非推奨：このフィールドはデフォルトの "bridge" ネットワークに接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

LinkLocalIPv6Address
string or null

リンクローカルのプレフィックスを使う IPv6 ユニキャストアドレス。非推奨：設定されることがなく、今後のリリースで削除します。

LinkLocalIPv6PrefixLen
integer or null <int64>

IPv6 ユニキャストアドレスのプレフィックス長。非推奨：設定されることがなく、今後のリリースで削除します。

MacAddress
string or null

デフォルトの "bridge" ネットワークでのコンテナの MAC アドレス。


> 非推奨：デフォルトの "bridge" に接続した場合だけ伝播します。 > 代わりに Networks マップ内の "bridge" ネットワーク情報を使ってください。同じ情報を含みます。 > Docker 1.9 で非推奨になり、Docker 17.12.0 で削除する予定です。

object or null

コンテナが接続するすべてのネットワークの情報。

additional property
object (EndpointSettings)

ネットワークエンドポイントの設定。

null or HashMap (object)
One of
null
SandboxID
string or null

SandboxID はコンテナのネットワークスタックを一意に表します。

SandboxKey
string or null

SandboxKey は netns ハンドルの完全なパスです。

配列の要素型 objects or null (Address)

非推奨：このフィールドは設定されることがなく、今後のリリースで削除します。

Array
Addr
string or null

IP アドレス。

PrefixLen
integer or null <int64>

IP アドレスのマスク長。

配列の要素型 objects or null (Address)

非推奨：このフィールドは設定されることがなく、今後のリリースで削除します。

Array
Addr
string or null

IP アドレス。

PrefixLen
integer or null <int64>

IP アドレスのマスク長。

{
  • "Bridge": "string",
  • "SandboxID": "string",
  • "HairpinMode": true,
  • "LinkLocalIPv6Address": "string",
  • "LinkLocalIPv6PrefixLen": 0,
  • "Ports": { },
  • "SandboxKey": "string",
  • "SecondaryIPAddresses": [
    ],
  • "SecondaryIPv6Addresses": [
    ],
  • "EndpointID": "string",
  • "Gateway": "string",
  • "GlobalIPv6Address": "string",
  • "GlobalIPv6PrefixLen": 0,
  • "IPAddress": "string",
  • "IPPrefixLen": 0,
  • "IPv6Gateway": "string",
  • "MacAddress": "string",
  • "Networks": {
    }
}

NetworkStats

rx_bytes
required
integer <int64> >= 0
rx_dropped
required
integer <int64> >= 0
rx_errors
required
integer <int64> >= 0
rx_packets
required
integer <int64> >= 0
tx_bytes
required
integer <int64> >= 0
tx_dropped
required
integer <int64> >= 0
tx_errors
required
integer <int64> >= 0
tx_packets
required
integer <int64> >= 0
{
  • "rx_dropped": 0,
  • "rx_bytes": 0,
  • "rx_errors": 0,
  • "tx_packets": 0,
  • "tx_dropped": 0,
  • "rx_packets": 0,
  • "tx_errors": 0,
  • "tx_bytes": 0
}

NetworkingConfig_String

required
object
additional property
object (EndpointSettings)

ネットワークエンドポイントの設定。

{
  • "EndpointsConfig": {
    }
}

Node

CreatedAt
required
string <date-time>

作成日時。

Endpoint
required
string

ノードに接続するエンドポイント。

IpAddress
required
string

ノードの IP アドレス。

Metadata
any

ユーザー定義のメタデータ。

Name
required
string

ノードの名前。

Version
required
string

ノードのバージョン。

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "IpAddress": "string",
  • "Endpoint": "string",
  • "Version": "string",
  • "Metadata": null
}

ObjPsStatus

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "UpdatedAt": "2019-08-24T14:15:22Z",
  • "Wanted": "create",
  • "PrevWanted": "create",
  • "Actual": "create",
  • "PrevActual": "create"
}

ObjPsStatusKind

string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
"create"

ObjectVersion

Index
integer or null <int64> >= 0
{
  • "Index": 0
}

PeerNode

Addr
string or null

このノードにアクセスできる IP アドレスとポート。

NodeID
string or null

swarm 内のこのノードの一意な識別子。

{
  • "NodeID": "string",
  • "Addr": "string"
}

PidsStats

current
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
{
  • "current": 0,
  • "limit": 0
}

PluginsInfo

Authorization
配列の要素型 strings or null

利用可能な認可プラグインの名前。

Log
配列の要素型 strings or null

利用可能なログドライバーと、そのプラグインの名前。

Network
配列の要素型 strings or null

利用可能なネットワークドライバーと、そのプラグインの名前。

Volume
配列の要素型 strings or null

利用可能なボリュームドライバーと、ネットワークドライバーのプラグインの名前。

{
  • "Volume": [
    ],
  • "Network": [
    ],
  • "Authorization": [
    ],
  • "Log": [
    ]
}

Primitive

One of
string
true

Process

CreatedAt
required
string <date-time>

作成日時。

required
object (ContainerInspectResponse)

プロセスのデータ（ContainerInspect）。

AppArmorProfile
string or null
Args
配列の要素型 strings or null

実行するコマンドの引数。

null or ContainerConfig (object)
Created
string or null

コンテナの作成時刻。

Driver
string or null
ExecIDs
配列の要素型 strings or null

コンテナ内で実行中の exec インスタンスの ID。

null or GraphDriverData (object)
null or HostConfig (object)
HostnamePath
string or null
HostsPath
string or null
Id
string or null

コンテナの ID。

Image
string or null

コンテナのイメージ ID。

LogPath
string or null
MountLabel
string or null
配列の要素型 objects or null (MountPoint)
Name
string or null
null or NetworkSettings (object)
Path
string or null

実行するコマンドのパス。

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

このコンテナ内のすべてのファイルの合計サイズ。

SizeRw
integer or null <int64>

このコンテナが作成または変更したファイルのサイズ。

null or ContainerState (object)
Key
required
string

プロセスのキー。

Kind
required
string (ProcessKind)
列挙値: "vm" "job" "cargo"

プロセスの種類（Job、Vm、Cargo）。

KindKey
required
string

関連する種類のキー。

Name
required
string

プロセスの名前。

NodeName
required
string

コンテナを実行するノードの名前。

UpdatedAt
required
string <date-time>

インスタンスの最終更新時刻。

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

ProcessConfig

arguments
配列の要素型 strings or null
entrypoint
string or null
privileged
boolean or null
tty
boolean or null
user
string or null
{
  • "privileged": true,
  • "user": "string",
  • "tty": true,
  • "entrypoint": "string",
  • "arguments": [
    ]
}

ProcessKind

string (ProcessKind)
列挙値: "vm" "job" "cargo"

プロセスの種類（Vm、Job、Cargo）。

"vm"

ProcessStats

Name
required
string
required
object (Stats)

コンテナの統計情報。

required
object (BlkioStats)

コンテナの I/O 統計情報。

required
object (CPUStats)

コンテナの一般的な CPU 統計情報。

id
string
required
object (MemoryStats)

コンテナの一般的なメモリー統計情報。

name
string
null or NetworkStats (object)
object or null
num_procs
required
integer <int32> >= 0
required
object (PidsStats)

コンテナのプロセス ID の統計情報。

required
object (CPUStats)

コンテナの一般的な CPU 統計情報。

preread
required
string
read
required
string
required
object (StorageStats)

コンテナのファイル I/O の統計情報。

{
  • "Name": "string",
  • "Stats": {
    }
}

ProxyHttp3

One of
boolean

デフォルト設定で HTTP/3 を有効にします。

Example
true

ProxyHttp3Config

ActiveConnectionIdLimit
integer or null >= 0

QUIC の active_connection_id_limit トランスポートパラメーター。

Bpf
boolean or null

eBPF を使った QUIC パケットのルーティングを有効にする（Linux 5.7 以降）。

Gso
boolean or null

QUIC の Generic Segmentation Offload を有効にする（UDP_SEGMENT を持つ Linux）。

HostKey
string or null

QUIC のホストキーのファイルパス。

Hq
boolean or null

QUIC の相互運用テストに使う HTTP/0.9 のプロトコルネゴシエーションを有効にします。

MaxConcurrentStreams
integer or null >= 0

接続ごとの HTTP/3 同時ストリーム数の上限。

Retry
boolean or null

QUIC のアドレス検証（retry）を有効にする。

StreamBufferSize
string or null

QUIC ストリームのバッファーサイズ（例："64k"、"8k"）。

{
  • "Hq": true,
  • "MaxConcurrentStreams": 0,
  • "StreamBufferSize": "string",
  • "ActiveConnectionIdLimit": 0,
  • "Bpf": true,
  • "Gso": true,
  • "HostKey": "string",
  • "Retry": true
}

ProxyHttpLocation

AllowedIps
配列の要素型 strings or null

許可する IP アドレス。

Headers
配列の要素型 strings or null

追加するヘッダー。

null or LimitReq (object)
One of
null
Path
required
string

パス。

required
object or object or object (LocationTarget)
One of
DisableLogging
boolean or null

このターゲットのログを無効にする。

Key
required
string

ターゲットにする Cargo または VM のキー。

Path
string or null

HTTP 利用時にターゲットにする HTTP パス。

Port
required
integer <int32> >= 0

ターゲットにする Cargo または VM のポート。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
Version
number or null <double>

使用する HTTP バージョン。

{
  • "Path": "string",
  • "Target": {
    },
  • "LimitReq": { },
  • "AllowedIps": [
    ],
  • "Headers": [
    ],
  • "Version": 0
}

ProxyRule

One of
Domain
string or null

ドメイン。

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
One of
null
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
One of
null
Includes
配列の要素型 strings or null

組み込む追加設定ファイルのパス。

null or LimitReqZone (object)
One of
null
required
配列の要素型 objects (ProxyHttpLocation)

複数のパスを処理する location。

Array
AllowedIps
配列の要素型 strings or null

許可する IP アドレス。

Headers
配列の要素型 strings or null

追加するヘッダー。

null or LimitReq (object)
Path
required
string

パス。

required
object or object or object (LocationTarget)
Version
number or null <double>

使用する HTTP バージョン。

required
string or string or string or string or object (NetworkKind)
One of
string
値: "All"

ネットワークのバインドの種類。

Port
integer or null <int32> >= 0

待ち受けるポート（デフォルト：80 または 443）。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
Example
{
  • "Domain": "string",
  • "Port": 0,
  • "Hsts": { },
  • "Network": "All",
  • "LimitReqZone": { },
  • "Locations": [
    ],
  • "Ssl": { },
  • "Http3": { },
  • "Includes": [
    ]
}

ProxyRuleHttp

Domain
string or null

ドメイン。

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
One of
null
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
One of
null
Includes
配列の要素型 strings or null

組み込む追加設定ファイルのパス。

null or LimitReqZone (object)
One of
null
required
配列の要素型 objects (ProxyHttpLocation)

複数のパスを処理する location。

Array
AllowedIps
配列の要素型 strings or null

許可する IP アドレス。

Headers
配列の要素型 strings or null

追加するヘッダー。

null or LimitReq (object)
Path
required
string

パス。

required
object or object or object (LocationTarget)
Version
number or null <double>

使用する HTTP バージョン。

required
string or string or string or string or object (NetworkKind)
One of
string
値: "All"

ネットワークのバインドの種類。

Port
integer or null <int32> >= 0

待ち受けるポート（デフォルト：80 または 443）。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
{
  • "Domain": "string",
  • "Port": 0,
  • "Hsts": { },
  • "Network": "All",
  • "LimitReqZone": { },
  • "Locations": [
    ],
  • "Ssl": { },
  • "Http3": { },
  • "Includes": [
    ]
}

ProxyRuleStream

required
string or string or string or string or object (NetworkKind)
One of
string
値: "All"

ネットワークのバインドの種類。

Port
required
integer <int32> >= 0

ノードで開くポート。

Protocol
required
string (ProxyStreamProtocol)
列挙値: "Tcp" "Udp"

使用するプロトコル：Tcp または Udp。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
required
object or object or object (StreamTarget)
One of
DisableLogging
boolean or null

このターゲットのログを無効にする。

Key
required
string

ターゲットにする Cargo または VM のキー。

Path
string or null

HTTP 利用時にターゲットにする HTTP パス。

Port
required
integer <int32> >= 0

ターゲットにする Cargo または VM のポート。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
{
  • "Network": "All",
  • "Protocol": "Tcp",
  • "Port": 0,
  • "Ssl": { },
  • "Target": {
    }
}

ProxySsl

One of
Certificate
required
string

証明書のパス。

CertificateClient
string or null

クライアント証明書のパス。

CertificateKey
required
string

証明書の秘密鍵のパス。

Dhparam
string or null

DH パラメーターファイルのパス。

VerifyClient
boolean or null

クライアントの検証を有効または無効にする。

Example
{
  • "Certificate": "string",
  • "CertificateKey": "string",
  • "CertificateClient": "string",
  • "VerifyClient": true,
  • "Dhparam": "string"
}

ProxySslConfig

Certificate
required
string

証明書のパス。

CertificateClient
string or null

クライアント証明書のパス。

CertificateKey
required
string

証明書の秘密鍵のパス。

Dhparam
string or null

DH パラメーターファイルのパス。

VerifyClient
boolean or null

クライアントの検証を有効または無効にする。

{
  • "Certificate": "string",
  • "CertificateKey": "string",
  • "CertificateClient": "string",
  • "VerifyClient": true,
  • "Dhparam": "string"
}

ProxyStreamProtocol

string (ProxyStreamProtocol)
列挙値: "Tcp" "Udp"

プロキシルールのモード。

"Tcp"

RegistryServiceConfig

AllowNondistributableArtifactsCIDRs
配列の要素型 strings or null

再配布できないアーティファクトを push できる IP 範囲一覧。CIDR 形式の RFC 4632 を使います。Windows のベースイメージなどは、ライセンスで配布を制限したアーティファクトを含みます。通常のレジストリへの push ではそれらを含みません。この設定は動作を上書きし、解決した IP が CIDR のサブネット内にあるすべてのレジストリに push できるようにします。閉域ネットワーク内のレジストリに push し、そのネットワークのホストがほかのサーバーに接続せずイメージを取得する際に便利です。 > 警告：通常、配布や共有の方法と場所に制限があります。この機能はプライベートレジストリへの push にだけ使い、再配布に関するすべての規約を順守してください。

AllowNondistributableArtifactsHostnames
配列の要素型 strings or null

再配布できないアーティファクトを push できるレジストリのホスト名一覧。<hostname>[:<port>] または <IP address>[:<port>] 形式です。Windows のベースイメージなどにはライセンスで配布を制限したアーティファクトがあります。通常の push では含みませんが、この設定は指定したレジストリの動作を上書きします。閉域ネットワーク内のレジストリに push し、そのネットワークのホストがほかのサーバーに接続せず取得する際に便利です。 > 警告：通常、配布や共有の方法と場所に制限があります。この機能はプライベートレジストリへの push にだけ使い、再配布に関するすべての規約を順守してください。

object or null
additional property
object (IndexInfo)

IndexInfo はレジストリの情報を含みます。

InsecureRegistryCIDRs
配列の要素型 strings or null

CIDR 形式（RFC 4632）で指定する、安全でないレジストリの IP 範囲一覧。暗号化しない HTTP や、未知の CA の証明書による信頼しない HTTPS を受け付けます。デフォルトではローカルレジストリ（127.0.0.0/8）だけが安全でないと設定され、ほかは安全と見なします。安全と見なしたレジストリとの安全でない通信はできません。この設定はその動作を上書きし、解決した IP が CIDR のサブネット内にあるレジストリとの安全でない通信を許可します。ホスト名でも指定でき、そのレジストリは IndexConfigs に一覧され、Secure フィールドが false になります。 > 警告：ローカルレジストリでは便利な場合もありますが、セキュリティ上の脆弱性を生むため、テスト目的でのみ使ってください。 > このオプションを有効にする代わりに、システムの信頼する CA 一覧に自分の CA を追加してください。

Mirrors
配列の要素型 strings or null

公式の docker.io レジストリのミラーとして動作する、レジストリ URL の一覧。

{
  • "AllowNondistributableArtifactsCIDRs": [
    ],
  • "AllowNondistributableArtifactsHostnames": [
    ],
  • "InsecureRegistryCIDRs": [
    ],
  • "IndexConfigs": {
    },
  • "Mirrors": [
    ]
}

ReplicationMode

One of
Mode
required
string
値: "Auto"
{
  • "names": [
    ],
  • "number": 0,
  • "Mode": "StaticByNodeNames"
}

ReplicationStatic

Number
required
integer >= 0
{
  • "Number": 0
}

Resource

CreatedAt
required
string <date-time>

リソースの作成日時。

Kind
required
string

リソースの種類。

required
object (ResourceSpec)

リソースの仕様。

CreatedAt
required
string <date-time>

リソースの作成日時。

required
object

JSON オブジェクト形式のリソースのデータ。

Key
required
string <uuid>

リソースのキー。

object

リソースのメタデータ（ユーザー定義）。

ResourceKey
required
string

データに関連付けるリソースのキー。

Version
required
string

リソースのバージョン。

{
  • "Kind": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Spec": {
    }
}

ResourceDnsRule

required
配列の要素型 objects (DnsEntry)
Array
required
string or string or string or string or object (NetworkKind)
Name
required
string
required
string or string or string or string or object (NetworkKind)
One of
string
値: "All"

ネットワークのバインドの種類。

{
  • "Network": "All",
  • "Entries": [
    ]
}

ResourceKind

CreatedAt
required
string <date-time>

種類の作成時刻。

required
object (ResourceKindSpec)

種類の作成時刻。

object

この種類とバージョンのリソースの JSONSchema。

Url
string or null

この種類とバージョンのリソースを作成、更新、削除するときに呼び出すサービス。

Metadata
any

種類の作成時刻。

Name
required
string

種類の名前。

Version
required
string

種類の作成時刻。

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

ResourceKindInspect

CreatedAt
required
string <date-time>

種類の作成時刻。

Name
required
string

種類の名前。

required
配列の要素型 objects (ResourceKindVersion)

利用可能なバージョンの一覧。

Array
CreatedAt
required
string <date-time>

バージョンの作成時刻。

required
object (ResourceKindSpec)

種類の仕様。

Key
required
string <uuid>

バージョンのキー。

KindKey
required
string

このバージョンに関連付ける種類。

object

メタデータ（ユーザー定義）。

Version
required
string

バージョン。

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

ResourceKindPartial

required
object (ResourceKindSpec)

リソースの種類の仕様。

object

この種類とバージョンのリソースの JSONSchema。

Url
string or null

この種類とバージョンのリソースを作成、更新、削除するときに呼び出すサービス。

object

リソースの種類のメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

リソースの種類の名前。

Version
required
string

リソースの種類のバージョン。

{
  • "Name": "string",
  • "Version": "string",
  • "Metadata": {
    },
  • "Data": {
    }
}

ResourceKindSpec

object

この種類とバージョンのリソースの JSONSchema。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Url
string or null

この種類とバージョンのリソースを作成、更新、削除するときに呼び出すサービス。

{
  • "Schema": {
    },
  • "Url": "string"
}

ResourceKindVersion

CreatedAt
required
string <date-time>

バージョンの作成時刻。

required
object (ResourceKindSpec)

種類の仕様。

object

この種類とバージョンのリソースの JSONSchema。

Url
string or null

この種類とバージョンのリソースを作成、更新、削除するときに呼び出すサービス。

Key
required
string <uuid>

バージョンのキー。

KindKey
required
string

このバージョンに関連付ける種類。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Version
required
string

バージョン。

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

ResourcePartial

required
object

リソースのデータ（JSON オブジェクト）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Kind
required
string

リソースの種類。

object

リソースのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

リソースの名前。

{
  • "Name": "string",
  • "Kind": "string",
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourceProxyRule

required
配列の要素型 ProxyRuleHttp (object) or ProxyRuleStream (object) (ProxyRule)

適用するルール。

Array
One of
Domain
string or null

ドメイン。

null or (Hsts (Hsts (string) or Hsts (string) or Hsts (object)))
null or (ProxyHttp3 (ProxyHttp3 (boolean) or ProxyHttp3Config (object)))
Includes
配列の要素型 strings or null

組み込む追加設定ファイルのパス。

null or LimitReqZone (object)
required
配列の要素型 objects (ProxyHttpLocation)

複数のパスを処理する location。

required
string or string or string or string or object (NetworkKind)
Port
integer or null <int32> >= 0

待ち受けるポート（デフォルト：80 または 443）。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
{
  • "Rules": [
    ]
}

ResourceSpec

CreatedAt
required
string <date-time>

リソースの作成日時。

required
object

JSON オブジェクト形式のリソースのデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Key
required
string <uuid>

リソースのキー。

object

リソースのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

ResourceKey
required
string

データに関連付けるリソースのキー。

Version
required
string

リソースのバージョン。

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

ResourceUpdate

required
object

JSON オブジェクト形式のリソースの仕様。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

object

JSON オブジェクト形式のリソースのメタデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

{
  • "Data": {
    },
  • "Metadata": {
    }
}

ResourcesBlkioWeightDevice

Path
string or null
Weight
integer or null >= 0
{
  • "Path": "string",
  • "Weight": 0
}

ResourcesUlimits

Hard
integer or null <int64>

ハードリミット。

Name
string or null

ulimit の名前。

Soft
integer or null <int64>

ソフトリミット。

{
  • "Name": "string",
  • "Soft": 0,
  • "Hard": 0
}

RestartPolicy

MaximumRetryCount
integer or null <int64>

on-failure を使う場合に、断念するまで再試行する回数。

null or RestartPolicyNameEnum (string)
One of
null
{
  • "Name": { },
  • "MaximumRetryCount": 0
}

RestartPolicyNameEnum

string (RestartPolicyNameEnum)
列挙値: "EMPTY" "no" "always" "unless-stopped" "on-failure"
"EMPTY"

Runtime

path
string or null

OCI 実行可能バイナリーの名前と、任意のパス。パスを省略すると、デーモンはホストの $PATH を検索し、最初の結果を使います。

runtimeArgs
配列の要素型 strings or null

呼び出し時にランタイムに渡すコマンドライン引数の一覧。

object or null

ランタイム固有の情報。この API 仕様ではランタイムが提供するデータを定義しませんが、既知の org.opencontainers.runtime-spec.features 属性が提供されることがあります。OCI Runtime Specification が定義する機能構造を JSON 文字列で表します。


> 注：値とラベルの形式を含め、このフィールドの情報は安定していると見なさないでください。予告なく変わる場合があります。

property name*
additional property
string
{
  • "path": "string",
  • "runtimeArgs": [
    ],
  • "status": {
    }
}

Secret

CreatedAt
required
string <date-time>

作成日時。

required
object

シークレットのデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Immutable
required
boolean

シークレットは更新できません。

Kind
required
string

シークレットの種類。

object
additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

シークレットの名前。

UpdatedAt
required
string <date-time>

最終更新日時。

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

SecretPartial

required
object

シークレットのデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Immutable
boolean

シークレットは更新できません。

Kind
required
string

シークレットの種類。

object

リソースのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

シークレットの名前。

{
  • "Name": "string",
  • "Kind": "string",
  • "Immutable": true,
  • "Metadata": {
    },
  • "Data": {
    }
}

SecretUpdate

required
object

JSON オブジェクト形式のシークレットのデータ。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

object

シークレットのメタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

{
  • "Metadata": {
    },
  • "Data": {
    }
}

SslConfig

Cert
string or null

証明書の内容。

CertCa
string or null

認証局証明書の内容。

CertKey
string or null

証明書の秘密鍵の内容。

Password
string or null

証明書のパスワード（設定されている場合）。

Verify
required
boolean

認証局を検証する。

{
  • "Cert": "string",
  • "CertKey": "string",
  • "CertCa": "string",
  • "Verify": true,
  • "Password": "string"
}

StartExecOptions

Detach
required
boolean

コマンドから切断する。

OutputCapacity
integer or null >= 0

出力の 1 行の最大サイズ。デフォルトは 8 * 1024（およそ 1024 文字）です。

Tty
required
boolean

疑似 TTY を割り当てる。

{
  • "Detach": true,
  • "Tty": true,
  • "OutputCapacity": 0
}

Statefile

ApiVersion
required
string

使用する API バージョンまたはリモート URL。

配列の要素型 objects or null (StatefileArg)

Statefile に渡す引数。

Array
Default
string or null

ビルド引数のデフォルト値。

Description
string or null

引数の短い説明。

Example
string or null

引数の値の例。

Kind
required
string (StatefileArgKind)
列挙値: "String" "Number" "Boolean"

ビルド引数の種類。

Multiple
boolean

引数で複数の値を受け取れる。

Name
required
string

ビルド引数の名前。

Required
boolean

必須の引数。

配列の要素型 objects or null (CargoSpecPartial)

作成して実行する Cargo の一覧。

Array
required
object (Config)

Cargo のコンテナ仕様。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

null or Config (object)
object

Cargo のメタデータ（ユーザー定義）。

Name
required
string

Cargo の名前。

null or (ReplicationMode (ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object) or ReplicationMode (object)))
Secrets
配列の要素型 strings or null

環境変数として使うシークレットの一覧。

Group
string or null

定義したオブジェクトのグループを設定する。デフォルトは {name_of_directory}.{name_of_file}。

配列の要素型 objects or null (JobPartial)

作成して実行するジョブの一覧。

Array
required
配列の要素型 objects (Config)

実行するコンテナの一覧。

null or ImagePullPolicy (string)
ImagePullSecret
string or null

イメージ取得時に使うシークレット。

object

メタデータ（ユーザー定義）。

Name
required
string

ジョブの名前。

Schedule
string or null

ジョブのスケジュール（cron）。

Secrets
配列の要素型 strings or null

環境変数として読み込むシークレット。

Ttl
integer or null >= 0

実行後 x 秒経過してからジョブを削除する。

null or StatefileMetadata (object)
One of
null
Namespace
string or null

Cargo と仮想マシンをデプロイする名前空間。

配列の要素型 objects or null (ResourcePartial)

作成するリソースの一覧。

Array
required
object

リソースのデータ（JSON オブジェクト）。

Kind
required
string

リソースの種類。

object

リソースのメタデータ（ユーザー定義）。

Name
required
string

リソースの名前。

配列の要素型 objects or null (SecretPartial)

作成するシークレットの一覧。

Array
required
object

シークレットのデータ。

Immutable
boolean

シークレットは更新できません。

Kind
required
string

シークレットの種類。

object

リソースのメタデータ（ユーザー定義）。

Name
required
string

シークレットの名前。

配列の要素型 strings or SubStateDef (object) or null (SubState)

現在の状態より前に適用するサブステートを含める。

Array
One of
string
配列の要素型 objects or null (VmSpecPartial)

作成して実行する仮想マシンの一覧。

Array
required
object (VmDisk)

VM のディスク設定（イメージ、サイズ）。必須です。

null or VmHostConfig (object)
Hostname
string or null

VM のホスト名（デフォルト：名前から生成）。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

VM の MAC アドレス（デフォルト：自動生成）。

object

メタデータ（ユーザー定義）。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（デフォルト：cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH 公開鍵（推奨）。

User
string or null

VM のデフォルトのユーザー（デフォルト：cloud）。

{
  • "ApiVersion": "string",
  • "Metadata": { },
  • "Args": [
    ],
  • "SubStates": [
    ],
  • "Group": "string",
  • "Namespace": "string",
  • "Secrets": [
    ],
  • "Resources": [
    ],
  • "Cargoes": [
    ],
  • "VirtualMachines": [
    ],
  • "Jobs": [
    ]
}

StatefileArg

Default
string or null

ビルド引数のデフォルト値。

Description
string or null

引数の短い説明。

Example
string or null

引数の値の例。

Kind
required
string (StatefileArgKind)
列挙値: "String" "Number" "Boolean"

ビルド引数の種類。

Multiple
boolean

引数で複数の値を受け取れる。

Name
required
string

ビルド引数の名前。

Required
boolean

必須の引数。

{
  • "Name": "string",
  • "Kind": "String",
  • "Default": "string",
  • "Required": true,
  • "Multiple": true,
  • "Description": "string",
  • "Example": "string"
}

StatefileArgKind

string (StatefileArgKind)
列挙値: "String" "Number" "Boolean"

Statefile に渡す引数の定義。

"String"

StatefileMetadata

About
string or null

Statefile の概要。名前の節で使います。

LongAbout
string or null

Statefile の詳しい説明。説明の節で使います。

ManContent
string or null

Statefile のマニュアルページの内容を上書きする。

Name
string or null

Statefile のドキュメントの任意のタイトル。

Tags
配列の要素型 strings or null

Statefile に関連付ける任意のタグ。

{
  • "Name": "string",
  • "About": "string",
  • "LongAbout": "string",
  • "Tags": [
    ],
  • "ManContent": "string"
}

Stats

required
object (BlkioStats)

コンテナの I/O 統計情報。

配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
配列の要素型 objects or null (BlkioStatsEntry)
required
object (CPUStats)

コンテナの一般的な CPU 統計情報。

required
object (CPUUsage)

コンテナの CPU 使用量の統計情報。

online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

CPU スロットリングの統計情報。

id
string
required
object (MemoryStats)

コンテナの一般的なメモリー統計情報。

commit
integer or null <int64> >= 0
commit_peak
integer or null <int64> >= 0
commitbytes
integer or null <int64> >= 0
commitpeakbytes
integer or null <int64> >= 0
failcnt
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
max_usage
integer or null <int64> >= 0
privateworkingset
integer or null <int64> >= 0
null or (MemoryStatsStats (MemoryStatsStatsV1 (object) or MemoryStatsStatsV2 (object)))
usage
integer or null <int64> >= 0
name
string
null or NetworkStats (object)
One of
null
object or null
additional property
object (NetworkStats)

コンテナのネットワーク統計情報。

num_procs
required
integer <int32> >= 0
required
object (PidsStats)

コンテナのプロセス ID の統計情報。

current
integer or null <int64> >= 0
limit
integer or null <int64> >= 0
required
object (CPUStats)

コンテナの一般的な CPU 統計情報。

required
object (CPUUsage)

コンテナの CPU 使用量の統計情報。

online_cpus
integer or null <int64> >= 0
system_cpu_usage
integer or null <int64> >= 0
required
object (ThrottlingData)

CPU スロットリングの統計情報。

preread
required
string
read
required
string
required
object (StorageStats)

コンテナのファイル I/O の統計情報。

read_count_normalized
integer or null <int64> >= 0
read_size_bytes
integer or null <int64> >= 0
write_count_normalized
integer or null <int64> >= 0
write_size_bytes
integer or null <int64> >= 0
{
  • "read": "string",
  • "preread": "string",
  • "num_procs": 0,
  • "pids_stats": {
    },
  • "network": { },
  • "networks": {
    },
  • "memory_stats": {
    },
  • "blkio_stats": {
    },
  • "cpu_stats": {
    },
  • "precpu_stats": {
    },
  • "storage_stats": {
    },
  • "name": "string",
  • "id": "string"
}

StorageStats

read_count_normalized
integer or null <int64> >= 0
read_size_bytes
integer or null <int64> >= 0
write_count_normalized
integer or null <int64> >= 0
write_size_bytes
integer or null <int64> >= 0
{
  • "read_count_normalized": 0,
  • "read_size_bytes": 0,
  • "write_count_normalized": 0,
  • "write_size_bytes": 0
}

StreamTarget

One of
DisableLogging
boolean or null

このターゲットのログを無効にする。

Key
required
string

ターゲットにする Cargo または VM のキー。

Path
string or null

HTTP 利用時にターゲットにする HTTP パス。

Port
required
integer <int32> >= 0

ターゲットにする Cargo または VM のポート。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
Example
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true,
  • "Ssl": { }
}

String

string (String)
"string"

SubState

One of
string
Example
"string"

SubStateArg

Name
required
string

引数の名前。

required
number or string or boolean (SubStateValue)
One of
number <double>

引数の値。

{
  • "Name": "string",
  • "Value": 0.1
}

SubStateDef

配列の要素型 objects or null (SubStateArg)
Array
Name
required
string

引数の名前。

required
number or string or boolean (SubStateValue)
Path
required
string
{
  • "Path": "string",
  • "Args": [
    ]
}

SubStateValue

One of
number <double>

Statefile に渡す引数の定義。

true

SwarmInfo

null or ClusterInfo (object)
One of
null
ControlAvailable
boolean or null
Error
string or null
null or LocalNodeState (string)
One of
null
Managers
integer or null <int64>

swarm 内のマネージャー総数。

NodeAddr
string or null

swarm 内のほかのノードから、このノードにアクセスできる IP アドレス。

NodeID
string or null

swarm 内のこのノードの一意な識別子。

Nodes
integer or null <int64>

swarm 内のノード総数。

配列の要素型 objects or null (PeerNode)

swarm 内のほかのマネージャーの ID とアドレスの一覧。

Array
Addr
string or null

このノードにアクセスできる IP アドレスとポート。

NodeID
string or null

swarm 内のこのノードの一意な識別子。

{
  • "NodeID": "string",
  • "NodeAddr": "string",
  • "LocalNodeState": { },
  • "ControlAvailable": true,
  • "Error": "string",
  • "RemoteManagers": [
    ],
  • "Nodes": 0,
  • "Managers": 0,
  • "Cluster": { }
}

SwarmSpec

null or SwarmSpecCaConfig (object)
One of
null
null or SwarmSpecDispatcher (object)
One of
null
null or SwarmSpecEncryptionConfig (object)
One of
null
object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
Name
string or null

swarm の名前。

null or SwarmSpecOrchestration (object)
One of
null
null or SwarmSpecRaft (object)
One of
null
null or SwarmSpecTaskDefaults (object)
One of
null
{
  • "Name": "string",
  • "Labels": {
    },
  • "Orchestration": { },
  • "Raft": { },
  • "Dispatcher": { },
  • "CAConfig": { },
  • "EncryptionConfig": { },
  • "TaskDefaults": { }
}

SwarmSpecCaConfig

配列の要素型 objects or null (SwarmSpecCaConfigExternalCas)

署名要求を外部の認証局に転送する設定。

Array
CACert
string or null

外部 CA が TLS 証明書の発行に使うルート CA 証明書（PEM 形式）。未指定なら現在の swarm のルート CA 証明書と見なします。

object or null

外部 CA ドライバーがプロトコル固有のオプションとして解釈する、キーと値の組を持つオブジェクト。

null or SwarmSpecCaConfigExternalCasProtocolEnum (string)
URL
string or null

証明書の署名要求の送信先 URL。

ForceRotate
integer or null <int64> >= 0

SigningCACert と SigningCAKey が未指定の場合に、swarm に新しい署名用 CA 証明書とキーを生成させるための整数。

NodeCertExpiry
integer or null <int64>

ノード証明書の有効期間。

SigningCACert
string or null

swarm のすべてのノードの末端 TLS 証明書に使う、希望する署名用 CA 証明書。PEM 形式。

SigningCAKey
string or null

swarm のすべてのノードの末端 TLS 証明書に使う、希望する署名用 CA キー。PEM 形式。

{
  • "NodeCertExpiry": 0,
  • "ExternalCAs": [
    ],
  • "SigningCACert": "string",
  • "SigningCAKey": "string",
  • "ForceRotate": 0
}

SwarmSpecCaConfigExternalCas

CACert
string or null

外部 CA が TLS 証明書の発行に使うルート CA 証明書（PEM 形式）。未指定なら現在の swarm のルート CA 証明書と見なします。

object or null

外部 CA ドライバーがプロトコル固有のオプションとして解釈する、キーと値の組を持つオブジェクト。

property name*
additional property
string
null or SwarmSpecCaConfigExternalCasProtocolEnum (string)
One of
null
URL
string or null

証明書の署名要求の送信先 URL。

{
  • "Protocol": { },
  • "URL": "string",
  • "Options": {
    },
  • "CACert": "string"
}

SwarmSpecCaConfigExternalCasProtocolEnum

string (SwarmSpecCaConfigExternalCasProtocolEnum)
列挙値: "EMPTY" "cfssl"
"EMPTY"

SwarmSpecDispatcher

HeartbeatPeriod
integer or null <int64>

エージェントがディスパッチャーにハートビートを送る間隔。

{
  • "HeartbeatPeriod": 0
}

SwarmSpecEncryptionConfig

AutoLockManagers
boolean or null

設定するとキーを生成し、マネージャーに保存するデータのロックに使います。

{
  • "AutoLockManagers": true
}

SwarmSpecOrchestration

TaskHistoryRetentionLimit
integer or null <int64>

インスタンスまたはノードごとに保持する過去のタスク数。負の場合、完了または失敗したタスクを削除しません。

{
  • "TaskHistoryRetentionLimit": 0
}

SwarmSpecRaft

ElectionTick
integer or null <int64>

フォロワーが候補になり選挙を始めるまで、リーダーのメッセージを待つ tick 数。ElectionTick は HeartbeatTick より大きい必要があります。現在の tick のデフォルトは 1 秒なので秒数に直接対応しますが、保証はありません。

HeartbeatTick
integer or null <int64>

ハートビート間の tick 数。リーダーは HeartbeatTick ごとにフォロワーに送信します。現在の tick のデフォルトは 1 秒なので秒数に直接対応しますが、保証はありません。

KeepOldSnapshots
integer or null <int64> >= 0

現在のスナップショットに加えて保持するスナップショット数。

LogEntriesForSlowFollowers
integer or null <int64> >= 0

スナップショット作成後に遅いフォロワーを同期させるため、保持するログ項目数。

SnapshotInterval
integer or null <int64> >= 0

スナップショット間のログ項目数。

{
  • "SnapshotInterval": 0,
  • "KeepOldSnapshots": 0,
  • "LogEntriesForSlowFollowers": 0,
  • "ElectionTick": 0,
  • "HeartbeatTick": 0
}

SwarmSpecTaskDefaults

null or SwarmSpecTaskDefaultsLogDriver (object)
One of
null
{
  • "LogDriver": { }
}

SwarmSpecTaskDefaultsLogDriver

Name
string or null

新しいタスクのデフォルトとして使うログドライバー。

object or null

選択したログドライバー固有のオプション。キーと値の組で指定します。

property name*
additional property
string
{
  • "Name": "string",
  • "Options": {
    }
}

SystemInfo

Architecture
string or null

Go ランタイム（GOARCH）が返すホストのハードウェアアーキテクチャ。指定可能な値の完全な一覧は Go のドキュメントで確認できます。

BridgeNfIp6tables
boolean or null

ホストで bridge-nf-call-ip6tables が利用可能かを示します。

BridgeNfIptables
boolean or null

ホストで bridge-nf-call-iptables が利用可能かを示します。

CDISpecDirs
配列の要素型 strings or null

CDI（Container Device Interface）仕様があるディレクトリの一覧。作成するコンテナの OCI ランタイム仕様に対する、ベンダー固有の変更を定義します。空の一覧は CDI デバイス注入が無効であることを示します。注入にはデーモンの実験的機能を有効にする必要があり、無効なデーモンでは常に空の一覧を返します。

null or SystemInfoCgroupDriverEnum (string)
One of
null
null or SystemInfoCgroupVersionEnum (string)
One of
null
null or Commit (object)
One of
null
Containers
integer or null <int64>

ホスト上のコンテナ総数。

ContainersPaused
integer or null <int64>

状態が \"paused\" のコンテナ数。

ContainersRunning
integer or null <int64>

状態が \"running\" のコンテナ数。

ContainersStopped
integer or null <int64>

状態が \"stopped\" のコンテナ数。

CpuCfsPeriod
boolean or null

ホストが CPU CFS（Completely Fair Scheduler）の期間設定に対応するかを示します。

CpuCfsQuota
boolean or null

ホストが CPU CFS（Completely Fair Scheduler）のクォータに対応するかを示します。

CPUSet
boolean or null

ホストが CPUset（cpuset.cpus、cpuset.mems）に対応するかを示します。cpuset(7) を参照してください。

CPUShares
boolean or null

ホストが CPU Shares の制限に対応するかを示します。

Debug
boolean or null

デーモンがデバッグモード、またはデバッグレベルのログを有効にして動作しているかを示します。

配列の要素型 objects or null (SystemInfoDefaultAddressPools)

ローカルネットワークの独自のデフォルトアドレスプールの一覧。daemon.json または dockerd のオプションで指定できます。例：Base が "10.10.0.0/16"、Size が 24 なら、256 個の 10.10.[0-255].0/24 アドレスプールを定義します。

Array
Base
string or null

CIDR 形式のネットワークアドレス。

Size
integer or null <int64>

ネットワークプールのサイズ。

DefaultRuntime
string or null

コンテナの起動に使うデフォルトの OCI ランタイムの名前。作成時にコンテナごとに上書きできます。

DockerRootDir
string or null

Docker の永続状態のルートディレクトリ。Linux のデフォルトは /var/lib/docker、Windows では C:\\ProgramData\\docker です。

Driver
string or null

使用中のストレージドライバーの名前。

DriverStatus
配列の要素型 strings or null[ items ]

ストレージドライバー固有の情報。"label" と "value" の組で提供します。ドライバーが提供し、コマンドラインの docker info と一貫した形式に整えます。


> 注：値とラベルの形式を含め、この情報は安定していると見なさないでください。予告なく変わる場合があります。

ExperimentalBuild
boolean or null

デーモンで実験的な機能が有効かを示します。

null or GenericResourcesInner (object)
One of
null
HttpProxy
string or null

デーモンに設定した HTTP プロキシ。HTTP_PROXY 環境変数から取得します。プロキシ URL の認証情報（ユーザー情報の要素）は API レスポンス内で隠します。コンテナはこの設定を自動継承しません。

HttpsProxy
string or null

デーモンに設定した HTTPS プロキシ。HTTPS_PROXY 環境変数から取得します。プロキシ URL の認証情報（ユーザー情報の要素）は API レスポンス内で隠します。コンテナはこの設定を自動継承しません。

ID
string or null

デーモンの一意な識別子。


> 注：ID 自体の形式は API の一部ではなく、安定していると見なさないでください。

Images
integer or null <int64>

ホスト上のイメージ総数。_タグ付き_と_タグなし_（dangling）の両方を数えます。

IndexServerAddress
string or null

イメージ検索と、Docker Hub と Docker Cloud のユーザー認証のデフォルトに使うインデックスサーバーのアドレスまたは URL。

InitBinary
string or null

docker-init バイナリーの名前と、任意のパス。パスを省略すると、デーモンはホストの $PATH を検索し、最初の結果を使います。

null or Commit (object)
One of
null
IPv4Forwarding
boolean or null

IPv4 転送が有効かを示します。

null or SystemInfoIsolationEnum (string)
One of
null
KernelMemoryTCP
boolean or null

ホストでカーネルメモリーの TCP 制限が有効かを示します。未対応なら省略します。対応する memory.kmem.tcp.limit_in_bytes cgroup がない cgroup v2 では、カーネルメモリーの TCP 制限に対応しません。

KernelVersion
string or null

ホストのカーネルバージョン。Linux では uname から取得します。Windows では HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\ のレジストリ値を問い合わせます。例：_"10.0 14393 (14393.1198.amd64fre.rs1_release_sec.170427-1353)"_。

Labels
配列の要素型 strings or null

デーモンに設定したユーザー定義のラベル（キーと値のメタデータ）。


> 注：Swarm 内のノードには、デーモン設定による_デーモン_ラベルと、マネージャーノードから設定する_ノード_ラベルの両方があります。このフィールドにはノードラベルを含みません。 > マネージャーノードの /nodes/(id) エンドポイントで取得できます。

LiveRestoreEnabled
boolean or null

live restore が有効かを示します。有効なら、デーモン停止時や、起動時に実行中のコンテナを検出した場合もコンテナの実行を継続します。

LoggingDriver
string or null

新しいコンテナのデフォルトとして使うログドライバー。

MemoryLimit
boolean or null

ホストでメモリー制限のサポートが有効かを示します。

MemTotal
integer or null <int64>

ホスト上で利用可能な物理メモリーの総量（バイト）。

Name
string or null

ホストのホスト名。

NCPU
integer or null <int64>

デーモンが使える論理 CPU 数。起動時に OS に問い合わせて確認します。起動後の OS の CPU 割り当て変更は反映しません。

NEventsListener
integer or null <int64>

購読中のイベントリスナー数。

NFd
integer or null <int64>

デーモンのプロセスが使用中のファイルディスクリプターの総数。デバッグモードが有効な場合だけ返します。

NGoroutines
integer or null <int64>

現在存在する goroutine の数。デバッグモードが有効な場合だけ返します。

NoProxy
string or null

プロキシを使わないドメイン拡張子のカンマ区切り一覧。NO_PROXY 環境変数から取得します。コンテナはこの設定を自動継承しません。

OomKillDisable
boolean or null

ホストが OOM killer の無効化に対応するかを示します。

OperatingSystem
string or null

ホストの OS 名。例："Ubuntu 16.04.2 LTS"、"Windows Server 2016 Datacenter"。

OSType
string or null

Go ランタイム（GOOS）が返す、ホスト OS の一般的な種類。現在の値は "linux" と "windows" です。指定可能な値の完全な一覧は Go のドキュメントで確認できます。

OSVersion
string or null

ホスト OS のバージョン。


> 注：このフィールドの存在や値の形式も含め、情報は安定していると見なさないでください。予告なく変わる場合があります。

PidsLimit
boolean or null

ホストカーネルで PID 制限のサポートが有効かを示します。

null or PluginsInfo (object)
One of
null
ProductLicense
string or null

デーモンの製品ライセンスの概要を報告します。商用ライセンスが適用されている場合は、ノード数や有効期限などの情報を含みます。

null or RegistryServiceConfig (object)
One of
null
null or Commit (object)
One of
null
object or null

デーモンに設定した OCI 準拠ランタイムの一覧。キーはランタイムを参照する "name" を保持します。Docker デーモンは、containerd を通じて呼び出す OCI 準拠ランタイムを、Linux カーネルの名前空間、cgroup、SELinux へのインターフェースとして使います。デフォルトの runc は自動設定されます。ユーザーが追加のランタイムを設定すると、ここに一覧されます。

additional property
object (Runtime)

Runtime は OCI 準拠ランタイムを表します。デーモンは containerd を通じて呼び出します。OCI ランタイムは、Linux カーネルの名前空間、cgroup、SELinux へのインターフェースです。

SecurityOptions
配列の要素型 strings or null

apparmor、seccomp、SELinux、userns、rootless、no-new-privileges など、デーモンで有効なセキュリティ機能の一覧。機能ごとの追加設定がある場合は、キーと値の組をカンマ区切りで含めます。

ServerVersion
string or null

デーモンのバージョン文字列。

SwapLimit
boolean or null

ホストでスワップメモリー制限のサポートが有効かを示します。

null or SwarmInfo (object)
One of
null
SystemTime
string or null

ナノ秒精度の RFC 3339 形式の現在のシステム時刻。

Warnings
配列の要素型 strings or null

機能不足やデーモン設定の問題に関する警告と情報メッセージの一覧。クライアントはユーザー向けの情報として表示できます。

{
  • "ID": "string",
  • "Containers": 0,
  • "ContainersRunning": 0,
  • "ContainersPaused": 0,
  • "ContainersStopped": 0,
  • "Images": 0,
  • "Driver": "string",
  • "DriverStatus": [
    ],
  • "DockerRootDir": "string",
  • "Plugins": { },
  • "MemoryLimit": true,
  • "SwapLimit": true,
  • "KernelMemoryTCP": true,
  • "CpuCfsPeriod": true,
  • "CpuCfsQuota": true,
  • "CPUShares": true,
  • "CPUSet": true,
  • "PidsLimit": true,
  • "OomKillDisable": true,
  • "IPv4Forwarding": true,
  • "BridgeNfIptables": true,
  • "BridgeNfIp6tables": true,
  • "Debug": true,
  • "NFd": 0,
  • "NGoroutines": 0,
  • "SystemTime": "string",
  • "LoggingDriver": "string",
  • "CgroupDriver": { },
  • "CgroupVersion": { },
  • "NEventsListener": 0,
  • "KernelVersion": "string",
  • "OperatingSystem": "string",
  • "OSVersion": "string",
  • "OSType": "string",
  • "Architecture": "string",
  • "NCPU": 0,
  • "MemTotal": 0,
  • "IndexServerAddress": "string",
  • "RegistryConfig": { },
  • "GenericResources": { },
  • "HttpProxy": "string",
  • "HttpsProxy": "string",
  • "NoProxy": "string",
  • "Name": "string",
  • "Labels": [
    ],
  • "ExperimentalBuild": true,
  • "ServerVersion": "string",
  • "Runtimes": {
    },
  • "DefaultRuntime": "string",
  • "Swarm": { },
  • "LiveRestoreEnabled": true,
  • "Isolation": { },
  • "InitBinary": "string",
  • "ContainerdCommit": { },
  • "RuncCommit": { },
  • "InitCommit": { },
  • "SecurityOptions": [
    ],
  • "ProductLicense": "string",
  • "DefaultAddressPools": [
    ],
  • "Warnings": [
    ],
  • "CDISpecDirs": [
    ]
}

SystemInfoCgroupDriverEnum

string (SystemInfoCgroupDriverEnum)
列挙値: "EMPTY" "cgroupfs" "systemd" "none"
"EMPTY"

SystemInfoCgroupVersionEnum

string (SystemInfoCgroupVersionEnum)
列挙値: "EMPTY" "1" "2"
"EMPTY"

SystemInfoDefaultAddressPools

Base
string or null

CIDR 形式のネットワークアドレス。

Size
integer or null <int64>

ネットワークプールのサイズ。

{
  • "Base": "string",
  • "Size": 0
}

SystemInfoIsolationEnum

string (SystemInfoIsolationEnum)
列挙値: "EMPTY" "default" "hyperv" "process"
"EMPTY"

ThrottleDevice

Path
string or null

デバイスのパス。

Rate
integer or null <int64>

レート。

{
  • "Path": "string",
  • "Rate": 0
}

ThrottlingData

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

TlsInfo

CertIssuerPublicKey
string or null

Base64 の URL セーフ形式でエンコードした、発行者の生の公開鍵バイト。

CertIssuerSubject
string or null

Base64 の URL セーフ形式でエンコードした、発行者の生の subject バイト。

TrustRoot
string or null

末端の TLS 証明書の検証に使うルート CA 証明書。

{
  • "TrustRoot": "string",
  • "CertIssuerSubject": "string",
  • "CertIssuerPublicKey": "string"
}

UnixTarget

UnixPath
required
string
{
  • "UnixPath": "string"
}

UpstreamTarget

DisableLogging
boolean or null

このターゲットのログを無効にする。

Key
required
string

ターゲットにする Cargo または VM のキー。

Path
string or null

HTTP 利用時にターゲットにする HTTP パス。

Port
required
integer <int32> >= 0

ターゲットにする Cargo または VM のポート。

null or (ProxySsl (ProxySslConfig (object) or ProxySsl (string)))
One of
null
{
  • "Key": "string",
  • "Port": 0,
  • "Path": "string",
  • "DisableLogging": true,
  • "Ssl": { }
}

UriTarget

Uri
required
string

ターゲットの URI。

{
  • "Uri": "string"
}

UrlRedirect

string (UrlRedirect)
列挙値: "MovedPermanently" "Permanent" "Temporary"
"MovedPermanently"

Vm

CreatedAt
required
string <date-time>

VM の作成時刻。

NamespaceName
required
string

名前空間の名前。

required
object (VmSpec)

VM の仕様。

CreatedAt
required
string <date-time>

VM 仕様の作成日時。

required
object (VmDisk)

VM のディスク設定。

required
object (VmHostConfig)

VM のリソース（CPU、メモリー、ネットワーク）。

Hostname
string or null

VM のホスト名。

Key
required
string <uuid>

VM 仕様の一意な識別子。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

VM の MAC アドレス。

object

メタデータ（ユーザー定義）。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH キー。

User
string or null

VM のデフォルトのユーザー（cloud）。

Version
required
string

仕様のバージョン。

VmKey
required
string

VM のキー。

required
object (ObjPsStatus)

VM の状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Status": {
    },
  • "Spec": {
    }
}

VmDisk

Image
required
string

使用するイメージの名前。

Size
integer or null <int64> >= 0

ディスクの許可する仮想サイズ（GB、デフォルト：20）。

{
  • "Image": "string",
  • "Size": 0
}

VmHostConfig

Cpu
required
integer <int64> >= 0

VM の CPU 数（デフォルト：1）。

Dns
配列の要素型 strings or null

VM で使う DNS サーバーの一覧。

HostTun
boolean or null

ホストの tun デバイスを使う。

Kvm
boolean or null

KVM アクセラレーションを有効にする（デフォルト：false）。

LinkNetIface
string or null

VM に接続するネットワークインターフェース（デフォルト：eth0）。

Memory
required
integer <int64> >= 0

VM のメモリー容量（MB、デフォルト：512）。

NetIface
string or null

VM に設定するネットワークインターフェース（デフォルト：ens3）。

Runtime
string or null

VM に使うコンテナイメージ名（デフォルト：nanocl-qemu）。

RuntimeNetwork
string or null
{
  • "Cpu": 0,
  • "Memory": 0,
  • "NetIface": "string",
  • "LinkNetIface": "string",
  • "Kvm": true,
  • "Dns": [
    ],
  • "Runtime": "string",
  • "RuntimeNetwork": "string",
  • "HostTun": true
}

VmImage

CreatedAt
required
string <date-time>

イメージの作成時刻。

Format
required
string

イメージの形式。

Kind
required
string

イメージの種類。

Name
required
string

イメージの名前。

Path
required
string

イメージのパス。

SizeActual
required
integer <int64>

イメージの実際のサイズ（バイト）。

SizeVirtual
required
integer <int64>

イメージの仮想サイズ（バイト）。

{
  • "Name": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "Path": "string",
  • "Kind": "string",
  • "Format": "string",
  • "SizeActual": 0,
  • "SizeVirtual": 0
}

VmImageResizePayload

Shrink
required
boolean

イメージを縮小するか。

Size
required
integer <int64> >= 0

イメージの新しいサイズ（バイト）。

{
  • "Size": 0,
  • "Shrink": true
}

VmInspect

CreatedAt
required
string <date-time>

VM の作成日時。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

required
配列の要素型 objects (Process)

インスタンスの一覧。

Array
CreatedAt
required
string <date-time>

作成日時。

required
object (ContainerInspectResponse)

プロセスのデータ（ContainerInspect）。

Key
required
string

プロセスのキー。

Kind
required
string (ProcessKind)
列挙値: "vm" "job" "cargo"

プロセスの種類（Job、Vm、Cargo）。

KindKey
required
string

関連する種類のキー。

Name
required
string

プロセスの名前。

NodeName
required
string

コンテナを実行するノードの名前。

UpdatedAt
required
string <date-time>

インスタンスの最終更新時刻。

InstanceTotal
required
integer >= 0

インスタンス数。

NamespaceName
required
string

名前空間の名前。

required
object (VmSpec)

VM の仕様。

CreatedAt
required
string <date-time>

VM 仕様の作成日時。

required
object (VmDisk)

VM のディスク設定。

required
object (VmHostConfig)

VM のリソース（CPU、メモリー、ネットワーク）。

Hostname
string or null

VM のホスト名。

Key
required
string <uuid>

VM 仕様の一意な識別子。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

VM の MAC アドレス。

object

メタデータ（ユーザー定義）。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH キー。

User
string or null

VM のデフォルトのユーザー（cloud）。

Version
required
string

仕様のバージョン。

VmKey
required
string

VM のキー。

required
object (ObjPsStatus)

VM の状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Status": {
    },
  • "Spec": {
    },
  • "Instances": [
    ]
}

VmSpec

CreatedAt
required
string <date-time>

VM 仕様の作成日時。

required
object (VmDisk)

VM のディスク設定。

Image
required
string

使用するイメージの名前。

Size
integer or null <int64> >= 0

ディスクの許可する仮想サイズ（GB、デフォルト：20）。

required
object (VmHostConfig)

VM のリソース（CPU、メモリー、ネットワーク）。

Cpu
required
integer <int64> >= 0

VM の CPU 数（デフォルト：1）。

Dns
配列の要素型 strings or null

VM で使う DNS サーバーの一覧。

HostTun
boolean or null

ホストの tun デバイスを使う。

Kvm
boolean or null

KVM アクセラレーションを有効にする（デフォルト：false）。

LinkNetIface
string or null

VM に接続するネットワークインターフェース（デフォルト：eth0）。

Memory
required
integer <int64> >= 0

VM のメモリー容量（MB、デフォルト：512）。

NetIface
string or null

VM に設定するネットワークインターフェース（デフォルト：ens3）。

Runtime
string or null

VM に使うコンテナイメージ名（デフォルト：nanocl-qemu）。

RuntimeNetwork
string or null
Hostname
string or null

VM のホスト名。

Key
required
string <uuid>

VM 仕様の一意な識別子。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
MacAddress
string or null

VM の MAC アドレス。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH キー。

User
string or null

VM のデフォルトのユーザー（cloud）。

Version
required
string

仕様のバージョン。

VmKey
required
string

VM のキー。

{
  • "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",
  • "User": "string",
  • "Disk": {
    },
  • "MacAddress": "string",
  • "Labels": {
    },
  • "HostConfig": {
    }
}

VmSpecPartial

required
object (VmDisk)

VM のディスク設定（イメージ、サイズ）。必須です。

Image
required
string

使用するイメージの名前。

Size
integer or null <int64> >= 0

ディスクの許可する仮想サイズ（GB、デフォルト：20）。

null or VmHostConfig (object)
One of
null
Hostname
string or null

VM のホスト名（デフォルト：名前から生成）。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
MacAddress
string or null

VM の MAC アドレス（デフォルト：自動生成）。

object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（デフォルト：cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH 公開鍵（推奨）。

User
string or null

VM のデフォルトのユーザー（デフォルト：cloud）。

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "Disk": {
    },
  • "MacAddress": "string",
  • "Labels": {
    },
  • "HostConfig": { }
}

VmSpecUpdate

null or VmHostConfig (object)
One of
null
Hostname
string or null

VM のホスト名。

object or null

ユーザー定義の、キーと値のメタデータ。

property name*
additional property
string
object

メタデータ（ユーザー定義）。

additional property
string or number or boolean or (配列の要素型 Primitive (strings or numbers or booleans)) or object (Any)

ResourceSpec などの動的な JSON オブジェクトに便利な、OpenApi の Any 型を生成するヘルパー。

Name
string or null

VM の名前。

Password
string or null

VM のデフォルトのパスワード（cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH キー。

User
string or null

VM のデフォルトのユーザー（cloud）。

{
  • "Name": "string",
  • "Metadata": {
    },
  • "Hostname": "string",
  • "User": "string",
  • "Password": "string",
  • "SshKey": "string",
  • "Labels": {
    },
  • "HostConfig": { }
}

VmSummary

CreatedAt
required
string <date-time>

VM の作成日時。

InstanceRunning
required
integer >= 0

実行中のインスタンス数。

InstanceTotal
required
integer >= 0

インスタンス数。

NamespaceName
required
string

名前空間の名前。

required
object (VmSpec)

VM の仕様。

CreatedAt
required
string <date-time>

VM 仕様の作成日時。

required
object (VmDisk)

VM のディスク設定。

required
object (VmHostConfig)

VM のリソース（CPU、メモリー、ネットワーク）。

Hostname
string or null

VM のホスト名。

Key
required
string <uuid>

VM 仕様の一意な識別子。

object or null

ユーザー定義の、キーと値のメタデータ。

MacAddress
string or null

VM の MAC アドレス。

object

メタデータ（ユーザー定義）。

Name
required
string

VM の名前。

Password
string or null

VM のデフォルトのパスワード（cloud）。

SshKey
string or null

ユーザーのデフォルトの SSH キー。

User
string or null

VM のデフォルトのユーザー（cloud）。

Version
required
string

仕様のバージョン。

VmKey
required
string

VM のキー。

required
object (ObjPsStatus)

VM の状態。

Actual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevActual
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
PrevWanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
UpdatedAt
required
string <date-time>
Wanted
required
string (ObjPsStatusKind)
列挙値: "create" "starting" "start" "updating" "update" "destroying" "destroy" "stopping" "stop" "fail" "finish" "unknown"
{
  • "NamespaceName": "string",
  • "Status": {
    },
  • "CreatedAt": "2019-08-24T14:15:22Z",
  • "InstanceTotal": 0,
  • "InstanceRunning": 0,
  • "Spec": {
    }
}