Terminal System API (1.0.0)

Download OpenAPI specification:Download

Base URL

ベースURLは以下のとおりです。各APIエンドポイントはこのベースURLから始まります。

http://<bind-address>/api

Third Party Notices

URL	説明
http://<bind-address>/third_party_notices/inherent/	インストールイメージに含まれるサードパーティ製のソフトウェアのライセンス情報を取得します。
http://<bind-address>/third_party_notices/extra/	インストールイメージに含まれないサードパーティ製のソフトウェアのライセンス情報を取得します。

Streamer

Get Streamer Default Settings File Contents

intdash-agent-streamerのデフォルト設定ファイルの内容を取得します。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Streamer Default Settings File Contents

intdash-agent-streamerのデフォルト設定ファイルの内容を更新します。

Authorizations:

basicAuth

Request Body schema: multipart/form-data

string <binary>

yamlフォーマットで記載されたintdash-agent-streamerのデフォルト設定。

使用できる項目

agent

キー	説明
channel_mode_default	スレッド間をつなぐチャンネルのバッファが溢れた場合の処理。 `wait`, `allow-drop`, `quit` が選択可能です。 * `wait`: バッファに制限を持たずメモリに保持す続けます。 * `allow-drop`: バッファに入れられなかったデータを破棄します。 * `quit`: バッファに入れられなかった場合エラー終了します。

例:

agent:
  channel_mode_default: quit

Responses

Response samples

400
403

Content type

application/json; charset=UTF-8

{"title": "Invalid request body",
"status": 400,
"detail": "request {request}: {detail}.",
"instance": "/pkg/error.go#123"
}

Connection to Server

Get Connection Settings

agentdのGet Connection Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Connection Settings

agentdのUpdate Connection Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Connection Settings State

Agentとintdashサーバー間の接続に関する設定の状態を取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

{"verified": true,
"edge_name": "edge01",
"edge_nickname": "nickname01"
}

Get Transport Settings

agentdのGet Transport Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Transport Settings

agentdのUpdate Transport Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Stream

List Upstream Settings

agentdのList Upstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Create Upstream Settings

agentdのCreate Upstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Upstream Settings

agentdのGet Upstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Upstream Settings

agentdのUpdate Upstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Upstream Settings

agentdのDelete Upstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List Upstream State

agentdのList Upstream Stateにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Upstream State

agentdのGet Upstream Stateにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List Downstream Settings

agentdのList Downstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Create Downstream Settings

agentdのCreate Downstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Downstream Settings

agentdのGet Downstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Downstream Settings

agentdのUpdate Downstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Downstream Settings

agentdのDelete Downstream Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List Downstream State

agentdのList Downstream Stateにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Downstream State

agentdのGet Downstream Stateにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Filter

List Filters for Upstream

agentdのList Filters for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Create Filter for Upstream

agentdのCreate Filter for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Filter for Upstream

agentdのGet Filter for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Filter for Upstream

agentdのUpdate Filter for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Filter for Upstream

agentdのDelete Filter for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List Filters for Downstream

agentdのList Filters for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Create Filter for Downstream

agentdのCreate Filter for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Filter for Downstream

agentdのGet Filter for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Filter for Downstream

agentdのUpdate Filter for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Filter for Downstream

agentdのDelete Filter for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Deferred Upload

Get Deferred Upload Settings

agentdのGet Deferred Upload Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Deferred Upload Settings

agentdのUpdate Deferred Upload Settingsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Deferred Upload State

agentdのGet Deferred Upload Stateにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Measurement

List Measurements

agentdのList Measurementsにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Measurement

agentdのGet Measurementにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

uuid

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Measurement

agentdのDelete Measurementにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

uuid

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Device Connector IPC

List Device Connector IPC Settings for Upstream

デバイスコネクターの送信用IPC設定。 agentdのList Device Connector IPC Settings for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Create Device Connector IPC Settings for Upstream

デバイスコネクターの送信用IPC設定。 agentdのCreate Device Connector IPC Settings for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Device Connector IPC Settings for Upstream

デバイスコネクターの送信用IPC設定。 agentdのGet Device Connector IPC Settings for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Update Device Connector IPC Settings for Upstream

デバイスコネクターの送信用IPC設定。 agentdのUpdate Device Connector IPC Settings for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Device Connector IPC Settings for Upstream

デバイスコネクターの送信用IPC設定。 agentdのDelete Device Connector IPC Settings for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List State of Device Connector IPC for Upstream

デバイスコネクターの送信用IPCの状態。 agentdのList Device Connector IPC States for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get State of Device Connector IPC for Upstream

デバイスコネクターの送信用IPCの状態。 agentdのGet Device Connector IPC State for Upstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List Device Connector IPC Settings for Downstream

デバイスコネクターの受信用IPC設定。 agentdのList Device Connector IPC Settings for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Create Device Connector IPC Settings for Downstream

デバイスコネクターの受信用IPC設定。 agentdのCreate Device Connector IPC Settings for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Device Connector IPC Settings for Downstream

デバイスコネクターの受信用IPC設定。 agentdのGet Device Connector IPC Settings for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Downdate Device Connector IPC Settings for Downstream

デバイスコネクターの受信用IPC設定。 agentdのUpdate Device Connector IPC Settings for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Delete Device Connector IPC Settings for Downstream

デバイスコネクターの受信用IPC設定。 agentdのDelete Device Connector IPC Settings for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List State of Device Connector IPC for Downstream

デバイスコネクターの受信用IPCの状態。 agentdのList Device Connector IPC State for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get State of Device Connector IPC for Downstream

デバイスコネクターの受信用IPCの状態。 agentdのGet Device Connector IPC State for Downstreamにリバースプロキシーされます。

Authorizations:

basicAuth

path Parameters

id

required

string

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Device Connector

List Device Connectors

Device Connectorのリストを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

[{"id": "can1",
"service_id": "H.264 NAL Unit for EDGEPLANT USB Camera",
"enabled": true,
"upstream_ipc_ids": ["usb0"
],
"downstream_ipc_ids": ["can1"
],
"service_substitutions": ["KEY=value"
]
}
]

Create Device Connector

Device Connectorを作成します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

id

required

string (device_connector_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

デバイスコネクターを識別するための文字列。

service_id

required

string (device_connector_service_id) [ 1 .. 100 ] characters ^[-_ .()a-zA-Z0-9]{1,100}$

デバイスコネクターサービスを識別するための文字列。

enabled

boolean

デバイスコネクターが使用する全の受信用IPC設定・送信用IPC設定の有効(true)／無効(false)。一部でも無効なIPC設定がある場合も無効(false)です。

upstream_ipc_ids

required

Array of strings (device_connector_ipc_id) [ items [ 1 .. 100 ] characters ]

デバイスコネクターサービスに割り当てる送信用IPC設定のID。 downstream_ipc_ids と合わせて一つ以上のIPCを設定する必要があります。

downstream_ipc_ids

required

Array of strings (device_connector_id) [ items [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ ]

デバイスコネクターサービスに割り当てる受信用IPC設定のID。 upstream_ipc_ids と合わせて一つ以上のIPCを設定する必要があります。

service_substitutions

required

Array of strings

デバイスコネクターサービスファイルの置換変数を置き換える値のリスト。KEY=valueのフォーマットで記載する必要があります。使用可能な変数はGET /device_connector_servicesのsubstitution_variablesで定義されており、その条件を満たしている必要があります。

以下のキーに対しては特別にデフォルト値が割り当てられます。

キー	デフォルト値
`DC_UPSTREAM_FIFO_%d` (`%d`には任意の数値が入ります)	upstream_ipc_ids で指定されたDevice Connector IPC Settings for Upstreamに定義されたipc.path（存在しない場合は空文字）。配列インデックスが0の場合はキーが`DC_UPSTREAM_FIFO_0`になります。
`DC_DOWNSTREAM_FIFO_%d` (`%d`には任意の数値が入ります)	downstream_ipc_ids で指定されたDevice Connector IPC Settings for Downstreamに定義されたipc.path（存在しない場合は空文字）。配列インデックスが0の場合はキーが`DC_DOWNSTREAM_FIFO_0`になります。
`DC_TAG`	id で指定された文字列

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "can1",
"service_id": "H.264 NAL Unit for EDGEPLANT USB Camera",
"enabled": true,
"upstream_ipc_ids": ["usb0"
],
"downstream_ipc_ids": ["can1"
],
"service_substitutions": ["KEY=value"
]
}

Response samples

201
400
403

Content type

application/json; charset=UTF-8

{"id": "can1",
"service_id": "H.264 NAL Unit for EDGEPLANT USB Camera",
"enabled": true,
"upstream_ipc_ids": ["usb0"
],
"downstream_ipc_ids": ["can1"
],
"service_substitutions": ["KEY=value"
]
}

Get Device Connector

Device Connectorを取得します。

Authorizations:

basicAuth

path Parameters

id

required

string (device_connector_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: can1

デバイスコネクターを識別するための文字列。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"id": "can1",
"service_id": "H.264 NAL Unit for EDGEPLANT USB Camera",
"enabled": true,
"upstream_ipc_ids": ["usb0"
],
"downstream_ipc_ids": ["can1"
],
"service_substitutions": ["KEY=value"
]
}

Update Device Connector

Device Connectorを更新します。

Authorizations:

basicAuth

path Parameters

id

required

string (device_connector_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: can1

デバイスコネクターを識別するための文字列。

Request Body schema: application/json; charset=UTF-8

enabled

boolean

デバイスコネクターが使用する全の受信用IPC設定・送信用IPC設定の有効(true)／無効(false)。一部でも無効なIPC設定がある場合も無効(false)です。

upstream_ipc_ids

Array of strings (device_connector_ipc_id) [ items [ 1 .. 100 ] characters ]

デバイスコネクターサービスに割り当てる送信用IPC設定のID。 downstream_ipc_ids と合わせて一つ以上のIPCを設定する必要があります。

downstream_ipc_ids

Array of strings (device_connector_id) [ items [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ ]

デバイスコネクターサービスに割り当てる受信用IPC設定のID。 upstream_ipc_ids と合わせて一つ以上のIPCを設定する必要があります。

service_substitutions

Array of strings

デバイスコネクターサービスファイルの置換変数を置き換える値のリスト。KEY=valueのフォーマットで記載する必要があります。使用可能な変数はGET /device_connector_servicesのsubstitution_variablesで定義されており、その条件を満たしている必要があります。

以下のキーに対しては特別にデフォルト値が割り当てられます。

キー	デフォルト値
`DC_UPSTREAM_FIFO_%d` (`%d`には任意の数値が入ります)	upstream_ipc_ids で指定されたDevice Connector IPC Settings for Upstreamに定義されたipc.path（存在しない場合は空文字）。配列インデックスが0の場合はキーが`DC_UPSTREAM_FIFO_0`になります。
`DC_DOWNSTREAM_FIFO_%d` (`%d`には任意の数値が入ります)	downstream_ipc_ids で指定されたDevice Connector IPC Settings for Downstreamに定義されたipc.path（存在しない場合は空文字）。配列インデックスが0の場合はキーが`DC_DOWNSTREAM_FIFO_0`になります。
`DC_TAG`	id で指定された文字列

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"enabled": true,
"upstream_ipc_ids": ["usb0"
],
"downstream_ipc_ids": ["can1"
],
"service_substitutions": ["KEY=value"
]
}

Response samples

200
400
403
404

Content type

application/json; charset=UTF-8

{"id": "can1",
"service_id": "H.264 NAL Unit for EDGEPLANT USB Camera",
"enabled": true,
"upstream_ipc_ids": ["usb0"
],
"downstream_ipc_ids": ["can1"
],
"service_substitutions": ["KEY=value"
]
}

Delete Device Connector

Device Connectorを削除します。

Authorizations:

basicAuth

path Parameters

id

required

string (device_connector_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: can1

デバイスコネクターを識別するための文字列。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Commit Device Connectors as docker-compose.override.yml

デバイスコネクターサービスファイルを元に計測用Docker Compose上書きファイル（docker-compose.override.yml）を作成します。
以下のいずれかの場合にはエラーになります。

GET /device_connectorのservice_idが存在しない場合。
GET /device_connectorのsubstitutionsがPUT /device_connector_services/{service_id}/contentsで定義されている条件を満たさない場合。
計測中のの場合。

作成されたdocker-compose.override.ymlはGET /docker/composes/measurement/files/docker-compose.override.yml/contentsにより確認できます。

Authorizations:

basicAuth

Responses

Response samples

403
409

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Device Connector Service

List Device Connector Services

Device Connectorサービスをリストを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

Example

options

[{"service_id": "CAN-USB Interface (Upstream)",
"substitution_variables": [{"key": "DC_APT_CANTRX_SRC_CONF_BAUDRATE",
"default": "57600",
"options": ["9600",
"14400",
"19200",
"38400",
"57600"
],
"display_strings_i18n": {"locale": "jpn",
"name": "ボーレート",
"description": "CAN 通信のボーレート",
"unit": "kbps"
}
}
],
"protected": true,
"absolute_path": "/lib/core/docker-compose/measurement/services/CAN-USB Interface (Upstream).yml"
}
]

Get Device Connector Service

Device Connectorサービスを取得します。

Authorizations:

basicAuth

path Parameters

service_id

required

string (device_connector_service_id) [ 1 .. 100 ] characters ^[-_ .()a-zA-Z0-9]{1,100}$

Example: H.264 NAL Unit for EDGEPLANT USB Camera

デバイスコネクターサービスを識別するための文字列。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

Example

options

{"service_id": "CAN-USB Interface (Upstream)",
"substitution_variables": [{"key": "DC_APT_CANTRX_SRC_CONF_BAUDRATE",
"default": "57600",
"options": ["9600",
"14400",
"19200",
"38400",
"57600"
],
"display_strings_i18n": {"locale": "jpn",
"name": "ボーレート",
"description": "CAN 通信のボーレート",
"unit": "kbps"
}
}
],
"protected": true,
"absolute_path": "/etc/core/docker-compose/measurement/services/CAN-USB Interface (Upstream).yml"
}

Delete Device Connector Service

Device Connectorサービスを削除します。

Authorizations:

basicAuth

path Parameters

service_id

required

string (device_connector_service_id) [ 1 .. 100 ] characters ^[-_ .()a-zA-Z0-9]{1,100}$

Example: H.264 NAL Unit for EDGEPLANT USB Camera

デバイスコネクターサービスを識別するための文字列。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Device Connector Service File Contents

Device Connectorサービスファイルの内容を取得します。

Authorizations:

basicAuth

path Parameters

service_id

required

string (device_connector_service_id) [ 1 .. 100 ] characters ^[-_ .()a-zA-Z0-9]{1,100}$

Example: H.264 NAL Unit for EDGEPLANT USB Camera

デバイスコネクターサービスを識別するための文字列。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Replace Device Connector Service File Contents

Device Connectorサービスファイルの内容を設定します。

Authorizations:

basicAuth

path Parameters

service_id

required

string (device_connector_service_id) [ 1 .. 100 ] characters ^[-_ .()a-zA-Z0-9]{1,100}$

Example: H.264 NAL Unit for EDGEPLANT USB Camera

デバイスコネクターサービスを識別するための文字列。

Request Body schema: multipart/form-data

string <binary> (device_connector_service_file_contents)

デバイスコネクターサービスファイルはPOST /device_connectors/-/commit実行時に一つのdocker-compose.override.ymlとして作成されます。

例（idをHelloで作成したデバイスコネクターサービスファイル）:

image: python:3
depends_on:
  intdash-edge-agent2:
    condition: service_healthy
volumes:
  - /var/run/core/intdash:/var/run/intdash
entrypoint: ["python3", "-c", "import struct, sys; f = open('${DC_UPSTREAM_FIFO_0}', 'wb'); f.write(struct.pack('<LLHHL6s2s5s', 1234, 123456789, 6, 2, 5, b'string', b'ab', b'Hello')); f.close();"]
environment:
  - ENV_VAL=${ENV_VAL}
substitution_variables:
  - key: DC_UPSTREAM_FIFO_0
  - key: ENV_VAL
    default: '/dev/ttyTHS0'
    path_glob: ['/dev/ttyTHS*']
    display_strings_i18n:
      - locale: jpn
        name: 設定値

例（作成されたdocker-compose.yml）:

version: "3"
services:
    Hello:
        depends_on:
            intdash-edge-agent2:
                condition: service_healthy
        entrypoint:
            - python3
            - -c
            - import struct, sys; f = open('/var/run/intdash/hello.fifo', 'wb'); f.write(struct.pack('<LLHHL6s2s5s', 1234, 123456789, 6, 2, 5, b'string', b'ab', b'Hello')); f.close();
        environment:
            - ENV_VAL=val
        image: python:3
        volumes:
            - /var/run/core/intdash:/var/run/intdash

デバイスコネクターサービスファイルの記載方法

depends_on - intdash Edge Agent 2 の起動準備が整ってから起動するために以下の設定を必ず追加してください。
```
depends_on:
    intdash-edge-agent2:
        condition: service_healthy
```
volumes - intdash Edge Agent 2 とのFIFO通信のために以下の設定を必ず追加してください。
```
volumes:
    - /var/run/core/intdash:/var/run/intdash
```
substitution_variables - GET /device_connector_services/{service_id}のsubstitution_variablesを生成するために使用する設定です。Terminal System Coreでのみ使用されdocker-compose.override.ymlには反映されません。
```
substitution_variables:
    - key: DC_APT_CANTRX_SRC_CONF_TIMESTAMP_MODE
      default: device
      options:
        - device
        - host
      display_strings_i18n:
        - locale: jpn
          name: タイムスタンプモード
          description: 受信したデータに対して、タイムスタンプをどのように付与するか
```
- key [string] (required) - 置換変数のキー名
- default [string] - 置換変数のデフォルト値。
- options [array of strings] - 置換変数に設定可能な値の配列。
- validation [string] - 置換変数の値が有効な値であるかを判定する正規表現。
```
substitution_variables:
    - key: DC_V4L2_SRC_CONF_FPS
      validation: '^[1-9][0-9]$|^100$'
```
- path_glob [array of strings] - 置換変数に設定可能な値の絶対パスをglob表現した文字列。GET /device_connector_services/{service_id}のsubstitution_variables.optionsに反映されます。optionsが指定されている場合はこの設定は使用されません。
```
substitution_variables:
    - key: DC_APT_CANTRX_SRC_CONF_PATH
      default: '/dev/aptUSB0'
      path_glob:
        - '/dev/aptUSB*'
```
- display_strings_i18n [array of objects] - 表示で使用する文字列セットの各言語の表現です。
  - locale [string] - ISO 639-3 言語コード
  - name [string] - 表示で使用する変数の名前
  - description [string] - 表示で使用する変数の説明
  - unit [string] - 表示で使用する変数の単位

作成されるdocker-compose.override.ymlについて

services - servicesのマップに使用されるキー名（上記例ではhello）はDevice Connectorのidで指定した文字列が使用されます。
${KEY} - デバイスコネクターサービスファイル内で置換変数を使用するには${KEY}のフォーマットを使用してください。この変数はDocker Composeで展開されるものではなくTerminal System APIで展開されるものです。Docker Composeへ設定するための環境変数には $KEY を使用してください。

Responses

Response samples

400
403

Content type

application/json; charset=UTF-8

{"title": "Invalid request body",
"status": 400,
"detail": "'{value}' does not follow the rule for '{key}' ({rule}).",
"instance": "/pkg/error.go#123"
}

System

Get Terminal System Information

Terminal Systemの情報を取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

{"os_name": "Terminal System (Yocto Project Distro)",
"os_version": "v2.0.0",
"components": [{"name": "Terminal System Core API",
"version": "v2.0.0",
"api_version": "1.0.0",
"go_version": "go1.18.1"
}
]
}

Get Terminal System Identification

Terminal Systemの識別情報を取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

{"computer_name": "terminal-system",
"serial_number": "TSBH000000000"
}

Update Terminal System Identification

Terminal Systemの識別情報を更新します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

computer_name

string [ 1 .. 63 ] characters ^[a-zA-Z0-9][-a-zA-Z0-9]{0,62}$

コンピューター名。ホスト名として使用されます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"computer_name": "terminal-system"
}

Response samples

200
400
403

Content type

application/json; charset=UTF-8

{"computer_name": "terminal-system",
"serial_number": "TSBH000000000"
}

Get Metrics

メトリクスを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

{"data_partition": {"total": 125488254976,
"available": 102351474688
},
"top": [{"time": "02:52:41",
"uptime": 428,
"users": 1,
"load_1m": 0.39,
"load_5m": 0.5,
"load_15m": 0.47,
"tasks_total": 239,
"tasks_running": 2,
"tasks_sleeping": 237,
"tasks_stopped": 0,
"tasks_zombie": 0,
"cpu_user": 19.8,
"cpu_sys": 10.3,
"cpu_nice": 0,
"cpu_idle": 68.1,
"cpu_wait": 0,
"cpu_hardware": 0.9,
"cpu_software": 0.9,
"cpu_steal": 0,
"mem_total": 3827.8,
"mem_free": 2279.7,
"mem_used": 511.1,
"mem_buff_cache": 1037.1,
"swap_total": 0,
"swap_free": 0,
"swap_used": 0,
"mem_available": 3154.8,
"processes": [{"pid": 375020,
"user": "root",
"priority": 20,
"nice": 0,
"virtual_mem": 14752,
"resident_mem": 11072,
"shared_mem": 5000,
"status": "running",
"percent_cpu": 100,
"percent_mem": 0.3,
"time_hundredths": "0:00.18",
"command": "python3"
},
{"pid": 375019,
"user": "root",
"priority": 20,
"nice": 0,
"virtual_mem": 5504,
"resident_mem": 2724,
"shared_mem": 2112,
"status": "running",
"percent_cpu": 17.6,
"percent_mem": 0.1,
"time_hundredths": "0:00.04",
"command": "top"
},
{"pid": 1,
"user": "root",
"priority": 20,
"nice": 0,
"virtual_mem": 94788,
"resident_mem": 9116,
"shared_mem": 6136,
"status": "sleeping",
"percent_cpu": 11.8,
"percent_mem": 0.2,
"time_hundredths": "1:30.82",
"command": "systemd"
},
{"pid": 4805,
"user": "root",
"priority": 20,
"nice": 0,
"virtual_mem": 1720908,
"resident_mem": 63064,
"shared_mem": 33712,
"status": "sleeping",
"percent_cpu": 11.8,
"percent_mem": 1.6,
"time_hundredths": "2:37.40",
"command": "contain+"
},
{"pid": 263512,
"user": "root",
"priority": 20,
"nice": 0,
"virtual_mem": 1600428,
"resident_mem": 17872,
"shared_mem": 7896,
"status": "sleeping",
"percent_cpu": 5.9,
"percent_mem": 0.5,
"time_hundredths": "0:37.68",
"command": "contain+"
}
]
}
],
"ip": {"lo": {"ifindex": 1,
"ifname": "lo",
"flags": ["LOOPBACK",
"UP",
"LOWER_UP"
],
"mtu": 65536,
"qdisc": "noqueue",
"operstate": "UNKNOWN",
"group": "default",
"txqlen": 1,
"link_type": "loopback",
"address": "00:00:00:00:00:00",
"broadcast": "00:00:00:00:00:00",
"addr_info": [{"family": "inet",
"local": "127.0.0.1",
"prefixlen": 8,
"scope": "host",
"label": "lo",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
},
{"family": "inet6",
"local": "::1",
"prefixlen": 128,
"scope": "host",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 25849838,
"packets": 83885,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 25849838,
"packets": 83885,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"dummy0": {"ifindex": 2,
"ifname": "dummy0",
"flags": ["BROADCAST",
"NOARP"
],
"mtu": 1500,
"qdisc": "noop",
"operstate": "DOWN",
"group": "default",
"txqlen": 1000,
"link_type": "ether",
"address": "1e:d2:cf:43:91:e1",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [ ],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"eth0": {"ifindex": 3,
"ifname": "eth0",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "fq",
"operstate": "UP",
"group": "default",
"txqlen": 1000,
"link_type": "ether",
"address": "00:04:4b:ea:a7:54",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "192.168.11.8",
"prefixlen": 24,
"broadcast": "192.168.11.255",
"scope": "global",
"dynamic": true,
"noprefixroute": true,
"label": "eth0",
"valid_life_time": 156593,
"preferred_life_time": 156593
},
{"family": "inet6",
"local": "2001:f71:87e0:5d00:23bb:34ad:a5a7:b9ad",
"prefixlen": 64,
"scope": "global",
"dynamic": true,
"noprefixroute": true,
"valid_life_time": 86384,
"preferred_life_time": 14384
},
{"family": "inet6",
"local": "fe80::c595:3285:eb66:9329",
"prefixlen": 64,
"scope": "link",
"noprefixroute": true,
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 205229854,
"packets": 175862,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 20812373,
"packets": 95185,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"eth1": {"ifindex": 4,
"ifname": "eth1",
"flags": ["NO-CARRIER",
"BROADCAST",
"MULTICAST",
"UP"
],
"mtu": 1500,
"qdisc": "fq",
"operstate": "DOWN",
"group": "default",
"txqlen": 1000,
"link_type": "ether",
"address": "04:ab:18:2d:54:10",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [ ],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"wwan0": {"ifindex": 5,
"ifname": "wwan0",
"flags": ["POINTOPOINT",
"MULTICAST",
"NOARP"
],
"mtu": 1500,
"qdisc": "noop",
"operstate": "DOWN",
"group": "default",
"txqlen": 1000,
"link_type": "none",
"addr_info": [ ],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"can0": {"ifindex": 6,
"ifname": "can0",
"flags": ["NOARP",
"ECHO"
],
"mtu": 16,
"qdisc": "noop",
"operstate": "DOWN",
"group": "default",
"txqlen": 10,
"link_type": "can",
"addr_info": [ ],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"can1": {"ifindex": 7,
"ifname": "can1",
"flags": ["NOARP",
"ECHO"
],
"mtu": 16,
"qdisc": "noop",
"operstate": "DOWN",
"group": "default",
"txqlen": 10,
"link_type": "can",
"addr_info": [ ],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"br-066fa411ce16": {"ifindex": 8,
"ifname": "br-066fa411ce16",
"flags": ["NO-CARRIER",
"BROADCAST",
"MULTICAST",
"UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "DOWN",
"group": "default",
"link_type": "ether",
"address": "02:42:c2:88:26:ca",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "172.23.0.1",
"prefixlen": 16,
"broadcast": "172.23.255.255",
"scope": "global",
"label": "br-066fa411ce16",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"br-541b89fad790": {"ifindex": 10,
"ifname": "br-541b89fad790",
"flags": ["NO-CARRIER",
"BROADCAST",
"MULTICAST",
"UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "DOWN",
"group": "default",
"link_type": "ether",
"address": "02:42:1f:58:a3:a6",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "172.18.0.1",
"prefixlen": 16,
"broadcast": "172.18.255.255",
"scope": "global",
"label": "br-541b89fad790",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"docker0": {"ifindex": 11,
"ifname": "docker0",
"flags": ["NO-CARRIER",
"BROADCAST",
"MULTICAST",
"UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "DOWN",
"group": "default",
"link_type": "ether",
"address": "02:42:23:52:a2:c5",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "172.17.0.1",
"prefixlen": 16,
"broadcast": "172.17.255.255",
"scope": "global",
"label": "docker0",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
},
{"family": "inet6",
"local": "fe80::42:23ff:fe52:a2c5",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 342,
"packets": 6,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"br-6fe3e0bcd5dc": {"ifindex": 12,
"ifname": "br-6fe3e0bcd5dc",
"flags": ["NO-CARRIER",
"BROADCAST",
"MULTICAST",
"UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "DOWN",
"group": "default",
"link_type": "ether",
"address": "02:42:2a:2f:75:61",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "172.31.0.1",
"prefixlen": 16,
"broadcast": "172.31.255.255",
"scope": "global",
"label": "br-6fe3e0bcd5dc",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"br-91b63e552af5": {"ifindex": 13,
"ifname": "br-91b63e552af5",
"flags": ["NO-CARRIER",
"BROADCAST",
"MULTICAST",
"UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "DOWN",
"group": "default",
"link_type": "ether",
"address": "02:42:c0:c8:70:2a",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "172.19.0.1",
"prefixlen": 16,
"broadcast": "172.19.255.255",
"scope": "global",
"label": "br-91b63e552af5",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"docker_gwbridge": {"ifindex": 14,
"ifname": "docker_gwbridge",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "02:42:36:24:8c:07",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "172.22.0.1",
"prefixlen": 16,
"broadcast": "172.22.255.255",
"scope": "global",
"label": "docker_gwbridge",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
},
{"family": "inet6",
"local": "fe80::42:36ff:fe24:8c07",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 1046,
"packets": 15,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"veth2cd13c9": {"ifindex": 20,
"link_index": 19,
"ifname": "veth2cd13c9",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"master": "docker_gwbridge",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "8a:59:93:49:b0:9a",
"broadcast": "ff:ff:ff:ff:ff:ff",
"link_netnsid": 1,
"addr_info": [{"family": "inet6",
"local": "fe80::8859:93ff:fe49:b09a",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 0,
"packets": 0,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 3159,
"packets": 39,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"br-842124ff9dd9": {"ifindex": 67,
"ifname": "br-842124ff9dd9",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "02:42:55:00:81:90",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "192.168.16.1",
"prefixlen": 20,
"broadcast": "192.168.31.255",
"scope": "global",
"label": "br-842124ff9dd9",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
},
{"family": "inet6",
"local": "fe80::42:55ff:fe00:8190",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 2291132,
"packets": 9297,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 1055323,
"packets": 12124,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"veth241dcd5": {"ifindex": 69,
"link_index": 68,
"ifname": "veth241dcd5",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"master": "br-842124ff9dd9",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "ca:48:8b:ff:68:73",
"broadcast": "ff:ff:ff:ff:ff:ff",
"link_netnsid": 2,
"addr_info": [{"family": "inet6",
"local": "fe80::c848:8bff:feff:6873",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 2388368,
"packets": 8810,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 1180829,
"packets": 11650,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"veth8633b7b": {"ifindex": 71,
"link_index": 70,
"ifname": "veth8633b7b",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"master": "br-842124ff9dd9",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "36:46:b4:f3:f1:e1",
"broadcast": "ff:ff:ff:ff:ff:ff",
"link_netnsid": 3,
"addr_info": [{"family": "inet6",
"local": "fe80::3446:b4ff:fef3:f1e1",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 32922,
"packets": 487,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 48093,
"packets": 521,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"br-38d52c94418f": {"ifindex": 79,
"ifname": "br-38d52c94418f",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "02:42:64:f7:12:ed",
"broadcast": "ff:ff:ff:ff:ff:ff",
"addr_info": [{"family": "inet",
"local": "192.168.48.1",
"prefixlen": 20,
"broadcast": "192.168.63.255",
"scope": "global",
"label": "br-38d52c94418f",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
},
{"family": "inet6",
"local": "fe80::42:64ff:fef7:12ed",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 280973,
"packets": 3378,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 251218,
"packets": 3218,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
},
"veth8c2c59f": {"ifindex": 81,
"link_index": 80,
"ifname": "veth8c2c59f",
"flags": ["BROADCAST",
"MULTICAST",
"UP",
"LOWER_UP"
],
"mtu": 1500,
"qdisc": "noqueue",
"master": "br-38d52c94418f",
"operstate": "UP",
"group": "default",
"link_type": "ether",
"address": "2a:d8:d0:2f:2b:03",
"broadcast": "ff:ff:ff:ff:ff:ff",
"link_netnsid": 4,
"addr_info": [{"family": "inet6",
"local": "fe80::28d8:d0ff:fe2f:2b03",
"prefixlen": 64,
"scope": "link",
"valid_life_time": 4294967295,
"preferred_life_time": 4294967295
}
],
"stats64": {"rx": {"bytes": 328265,
"packets": 3378,
"errors": 0,
"dropped": 0,
"over_errors": 0,
"multicast": 0
},
"tx": {"bytes": 297893,
"packets": 3238,
"errors": 0,
"dropped": 0,
"carrier_errors": 0,
"collisions": 0
}
}
}
},
"mmcli": [{"3gpp": {"5gnr": {"registration-settings": {"drx-cycle": "--",
"mico-mode": "--"
}
},
"enabled-locks": ["fixed-dialing"
],
"eps": {"initial-bearer": {"dbus-path": "/org/freedesktop/ModemManager1/Bearer/0",
"settings": {"apn": "spmode.ne.jp",
"ip-type": "ipv4",
"password": "user",
"user": "user"
}
},
"ue-mode-operation": "csps-2"
},
"imei": "359075062305874",
"operator-code": "44010",
"operator-name": "NTT DOCOMO",
"packet-service-state": "attached",
"pco": "--",
"registration-state": "home"
},
"cdma": {"activation-state": "--",
"cdma1x-registration-state": "--",
"esn": "--",
"evdo-registration-state": "--",
"meid": "--",
"nid": "--",
"sid": "--"
},
"dbus-path": "/org/freedesktop/ModemManager1/Modem/0",
"firmware": {"list": ["unique-id: 02.33.03.00_DOCOMO_001.049_000, current: yes, gobi-pri-unique id: 001.049_000, gobi-modem-unique id: ?_?",
"unique-id: 02.33.03.00_GENERIC_002.072_000, current: no, gobi-pri-unique id: 002.072_000, gobi-modem-unique id: ?_?",
"unique-id: 02.33.03.00_KDDI_001.047_000, current: no, gobi-pri-unique id: 001.047_000, gobi-modem-unique id: ?_?",
"unique-id: 02.33.03.00_SOFTBANK_001.047_001, current: no, gobi-pri-unique id: 001.047_001, gobi-modem-unique id: ?_?",
"unique-id: 02.33.03.00_TELSTRA_002.067_000, current: no, gobi-pri-unique id: 002.067_000, gobi-modem-unique id: ?_?"
]
},
"generic": {"access-technologies": ["lte"
],
"active-band": "eutran-1",
"bearers": ["/org/freedesktop/ModemManager1/Bearer/1"
],
"carrier-configuration": "default",
"carrier-configuration-revision": "--",
"current-bands": ["eutran-1",
"eutran-3",
"eutran-8",
"eutran-18",
"eutran-19"
],
"current-capabilities": ["gsm-umts, lte"
],
"current-modes": "allowed: 4g; preferred: none",
"device": "/sys/devices/3530000.xhci/usb2/2-3",
"device-identifier": "519e798d2579acb7a582ddfebd4c1687aeed145f",
"drivers": ["qcserial",
"qmi_wwan"
],
"equipment-identifier": "359075062305874",
"hardware-revision": "1.0",
"manufacturer": "Sierra Wireless, Incorporated",
"model": "EM7430",
"own-numbers": ["08078136281"
],
"plugin": "sierra",
"ports": ["cdc-wdm0 (qmi)",
"ttyUSB1 (qcdm)",
"ttyUSB2 (gps)",
"ttyUSB3 (at)",
"wwan0 (net)"
],
"power-state": "on",
"primary-port": "cdc-wdm0",
"primary-sim-slot": "1",
"revision": "SWI9X30C_02.33.03.00 r8209 CARMD-EV-FRMWR2 2019/08/28 20:59:30",
"signal-quality": {"recent": "yes",
"value": "91"
},
"sim": "/org/freedesktop/ModemManager1/SIM/0",
"sim-slots": ["/org/freedesktop/ModemManager1/SIM/0",
"/"
],
"state": "connected",
"state-failed-reason": "--",
"supported-bands": ["utran-1",
"utran-6",
"utran-5",
"utran-8",
"eutran-1",
"eutran-3",
"eutran-5",
"eutran-7",
"eutran-8",
"eutran-18",
"eutran-19",
"eutran-21",
"eutran-38",
"eutran-39",
"eutran-40",
"eutran-41",
"utran-19"
],
"supported-capabilities": ["gsm-umts, lte"
],
"supported-ip-families": ["ipv4",
"ipv6",
"ipv4v6"
],
"supported-modes": ["allowed: 3g; preferred: none",
"allowed: 4g; preferred: none",
"allowed: 3g, 4g; preferred: 4g",
"allowed: 3g, 4g; preferred: 3g"
],
"unlock-required": "sim-pin2",
"unlock-retries": ["sim-pin (3)",
"sim-puk (10)",
"sim-pin2 (3)",
"sim-puk2 (10)"
]
},
"location": {"capabilities": ["3gpp-lac-ci",
"gps-raw",
"gps-nmea",
"agps-msa",
"agps-msb"
],
"enabled": ["3gpp-lac-ci"
],
"gps": {"assistance": ["xtra"
],
"assistance-servers": ["http://xtrapath1.izatcloud.net/xtra3grc.bin",
"http://xtrapath2.izatcloud.net/xtra3grc.bin",
"http://xtrapath3.izatcloud.net/xtra3grc.bin"
],
"refresh-rate": "30",
"supl-server": "dcm-supl.com"
},
"signals": "no"
},
"messaging": {"default-storages": "me",
"supported-storages": "sm, me"
},
"signal": {"5g": {"error-rate": "--",
"rsrp": "--",
"rsrq": "--",
"snr": "--"
},
"cdma1x": {"ecio": "--",
"error-rate": "--",
"rssi": "--"
},
"evdo": {"ecio": "--",
"error-rate": "--",
"io": "--",
"rssi": "--",
"sinr": "--"
},
"gsm": {"error-rate": "--",
"rssi": "--"
},
"lte": {"error-rate": "--",
"rsrp": "-88.00",
"rsrq": "-12.00",
"rssi": "-57.00",
"snr": "1.40"
},
"refresh": {"rate": "10"
},
"threshold": {"error-rate": "no",
"rssi": "0"
},
"umts": {"ecio": "--",
"error-rate": "--",
"rscp": "--",
"rssi": "--"
}
},
"sim": {"dbus-path": "/org/freedesktop/ModemManager1/SIM/0",
"properties": {"active": "yes",
"eid": "--",
"emergency-numbers": [ ],
"esim-status": "--",
"gid1": "00FFFF",
"gid2": "FFFFFF",
"iccid": "8981100025409601902",
"imsi": "440103129001133",
"operator-code": "44010",
"operator-name": "NTT DOCOMO",
"removability": "--",
"sim-type": "--"
}
},
"time": {"current": "2023-06-01T14:28:21+09",
"dst-offset": "--",
"leap-seconds": "--"
},
"timezone": {"current": "540"
}
}
],
"gps": {"UBX-HNR-PVT": {"gpxFix": {"value": 3,
"description": "3D-Fix"
}
}
}
}

Upgrade Terminal System with Mender Artifact File

Authorizations:

basicAuth

Request Body schema: multipart/form-data

string <binary>

Responses

Response samples

200
400
403
409

Content type

application/json; charset=UTF-8

{"succeeded": true,
"reboot_required": true
}

Reload Terminal System

Terminal System の全ての設定を再読み込みします。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Network

Get Network Route for IP

ネットワークルートを取得します。

Authorizations:

basicAuth

path Parameters

ip

required

string (network_ip) ipv4

Example: 13.115.94.197

ネットワークルートを取得する対象のIPv4アドレス。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"ip": "13.115.94.197",
"nic_name": "wwan0"
}

Network Device

List Network Devices

Network Deviceに関する情報のリストを取得します。

Authorizations:

basicAuth

query Parameters

filters

string <json>

Example: filters={"enabled": [true]}

リストをフィルターします。リストされるオブジェクトにある第一階層のみを対象にフィルターできます。
filtersはJSONオブジェクトで記載してください。否定フィルターを設定したい場合は!に続けてJSONオブジェクトを記載してください。

例（enabledがtrue、のオブジェクトだけを取得）:

filters={"enabled": [true]}

例（enabledがtrueかつ、idが1または2、のオブジェクトだけを取得）:

filters={"enabled": [true], "id": [1,2]}

例（enabledがtrueかつ、idが1または2、でないオブジェクトだけを取得）:

filters=!{"enabled": [true], "id": [1,2]}

Responses

Response samples

200
403
422

Content type

application/json; charset=UTF-8

[{"device_name": "cdc-wdm0",
"device_type": "ethernet",
"nic_name": "wwan0",
"ip_address": "192.168.0.100",
"subnet_mask": "255.255.255.0",
"gateway": "192.168.0.1",
"dns_servers": ["8.8.8.8"
]
}
]

Network Connection

List Network Connections

Network Connectionのリストを取得します。

Terminal System APIは起動時にconnection_typeがethernetかつenabledがtrueのコネクションが無い場合は、自動的決定する１つのコネクションを有効化または作成します。

Authorizations:

basicAuth

Responses

Response samples

200
403
422

Content type

application/json; charset=UTF-8

[{"uuid": "77397428-dfa1-3427-a283-92face322b04",
"device_name": "cdc-wdm0",
"display_name": "Wireless connection 1",
"enabled": true,
"priority": 0,
"metric": -1,
"protected": false,
"ipv4_settings": {"manual": false,
"address": "",
"subnet_mask": "",
"default_gateway": "",
"dns_servers": [ ],
"dns_priority": 0
},
"connection_type": "gsm",
"ethernet_settings": {"mtu": 0
},
"gsm_settings": {"mtu": 0,
"apn": "xxxxx",
"username": "",
"password": "",
"band_preset": ""
},
"wireless_settings": {"mtu": 0,
"ssid": "xxxxx",
"psk": "xxxxxxxx"
}
}
]

Create Network Connection

Network Connectionを作成します。変更したNetwork Connectionを反映するにはTerminal Systemの再起動が必要です。

Terminal System APIは起動時にconnection_typeがethernetかつenabledがtrueのコネクションが無い場合は、自動的決定する１つのコネクションを有効化または作成します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

device_name required	string (network_device_name) Network Manager が管理するデバイス名。
display_name required	string non-empty ネットワークコネクションの表示名。分かりやすい任意の名前を設定できます。
enabled	boolean Default: true このネットワークコネクションの有効(`true`)／無効(`false`)。 `false`が指定されている場合でも、Terminal System APIの起動時に以下の条件を満たすと自動的に`true`に変更されます。 connection_typeが`ethernet`かつenabledが`true`のコネクションが無い自動的に有効化するコネクションとしてTerminal System APIが決定した
priority	integer [ -2147483648 .. 2147483647 ] Default: 0 ネットワークコネクションの優先度。 1つのネットワークデバイスに対して、2つ以上のネットワークコネクションを有効にした場合、priorityの高いネットワークコネクションが使用されます。 2つ以上のネットワークデバイスのうちどれを使用してデータを送信するかの設定はmetricを参照してください。
metric	integer [ -1 .. 9223372036854776000 ] Default: -1 ルートのデフォルトメトリック。`-1`の場合は自動的にメトリックが設定されます。任意の値に指定する場合は、DNSサーバーの優先度が適した値になっているか確認してください。適した値でない場合、名前解決に時間がかかったり、名前解決ができない可能性があります。
	object Default: {"manual":false,"address":"","subnet_mask":"","default_gateway":"","dns_servers":[],"dns_priority":0}
connection_type required	string Enum: "ethernet" "wireless" "wireless_access_point" "gsm" `ethernet` - Ethernet LAN `wireless` - 無線LAN（クライアントモード） `wireless_access_point` - 無線LAN（アクセスポイントモード） `gsm` - モバイル回線
	object (Ethernet Settings) Default: {"mtu":0} Ethernetの設定。connection_typeが`ethernet`のとき設定可能です。
	object (GSM Settings) Default: {"mtu":0,"apn":"xxxxx","username":"","password":"","band_preset":""} GSMの設定。connection_typeが`gsm`のとき設定可能です。
	object (Wireless Settings) Default: {"mtu":0,"ssid":"xxxxx","psk":"xxxxxxxx"} ワイヤレスLANの設定。connection_typeが`wlan`のとき設定可能です。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"device_name": "cdc-wdm0",
"display_name": "Wireless connection 1",
"enabled": true,
"priority": 0,
"metric": -1,
"ipv4_settings": {"manual": false,
"address": "",
"subnet_mask": "",
"default_gateway": "",
"dns_servers": [ ],
"dns_priority": 0
},
"connection_type": "gsm",
"ethernet_settings": {"mtu": 0
},
"gsm_settings": {"mtu": 0,
"apn": "xxxxx",
"username": "",
"password": "",
"band_preset": ""
},
"wireless_settings": {"mtu": 0,
"ssid": "xxxxx",
"psk": "xxxxxxxx"
}
}

Response samples

201
400
403
409

Content type

application/json; charset=UTF-8

{"uuid": "77397428-dfa1-3427-a283-92face322b04",
"device_name": "cdc-wdm0",
"display_name": "Wireless connection 1",
"enabled": true,
"priority": 0,
"metric": -1,
"protected": false,
"ipv4_settings": {"manual": false,
"address": "",
"subnet_mask": "",
"default_gateway": "",
"dns_servers": [ ],
"dns_priority": 0
},
"connection_type": "gsm",
"ethernet_settings": {"mtu": 0
},
"gsm_settings": {"mtu": 0,
"apn": "xxxxx",
"username": "",
"password": "",
"band_preset": ""
},
"wireless_settings": {"mtu": 0,
"ssid": "xxxxx",
"psk": "xxxxxxxx"
}
}

Get Network Connection

Network Connectionを取得します。

Terminal System APIは起動時にconnection_typeがethernetかつenabledがtrueのコネクションが無い場合は、自動的決定する１つのコネクションを有効化または作成します。

Authorizations:

basicAuth

path Parameters

uuid

required

uuid (network_connection_uuid)

Example: 77397428-dfa1-3427-a283-92face322b04

ネットワークコネクションを識別するための文字列。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"uuid": "77397428-dfa1-3427-a283-92face322b04",
"device_name": "cdc-wdm0",
"display_name": "Wireless connection 1",
"enabled": true,
"priority": 0,
"metric": -1,
"protected": false,
"ipv4_settings": {"manual": false,
"address": "",
"subnet_mask": "",
"default_gateway": "",
"dns_servers": [ ],
"dns_priority": 0
},
"connection_type": "gsm",
"ethernet_settings": {"mtu": 0
},
"gsm_settings": {"mtu": 0,
"apn": "xxxxx",
"username": "",
"password": "",
"band_preset": ""
},
"wireless_settings": {"mtu": 0,
"ssid": "xxxxx",
"psk": "xxxxxxxx"
}
}

Replace Network Connection

Network Connectionを設定します。変更したNetwork Connectionを反映するにはTerminal Systemの再起動が必要です。

Terminal System APIは起動時にconnection_typeがethernetかつenabledがtrueのコネクションが無い場合は、自動的決定する１つのコネクションを有効化または作成します。

Authorizations:

basicAuth

path Parameters

uuid

required

uuid (network_connection_uuid)

Example: 77397428-dfa1-3427-a283-92face322b04

ネットワークコネクションを識別するための文字列。

Request Body schema: application/json; charset=UTF-8

display_name required	string non-empty ネットワークコネクションの表示名。分かりやすい任意の名前を設定できます。
enabled	boolean Default: true このネットワークコネクションの有効(`true`)／無効(`false`)。 `false`が指定されている場合でも、Terminal System APIの起動時に以下の条件を満たすと自動的に`true`に変更されます。 connection_typeが`ethernet`かつenabledが`true`のコネクションが無い自動的に有効化するコネクションとしてTerminal System APIが決定した
priority	integer [ -2147483648 .. 2147483647 ] Default: 0 ネットワークコネクションの優先度。 1つのネットワークデバイスに対して、2つ以上のネットワークコネクションを有効にした場合、priorityの高いネットワークコネクションが使用されます。 2つ以上のネットワークデバイスのうちどれを使用してデータを送信するかの設定はmetricを参照してください。
metric	integer [ -1 .. 9223372036854776000 ] Default: -1 ルートのデフォルトメトリック。`-1`の場合は自動的にメトリックが設定されます。任意の値に指定する場合は、DNSサーバーの優先度が適した値になっているか確認してください。適した値でない場合、名前解決に時間がかかったり、名前解決ができない可能性があります。
	object Default: {"manual":false,"address":"","subnet_mask":"","default_gateway":"","dns_servers":[],"dns_priority":0}
	object (Ethernet Settings) Default: {"mtu":0} Ethernetの設定。connection_typeが`ethernet`のとき設定可能です。
	object (GSM Settings) Default: {"mtu":0,"apn":"xxxxx","username":"","password":"","band_preset":""} GSMの設定。connection_typeが`gsm`のとき設定可能です。
	object (Wireless Settings) Default: {"mtu":0,"ssid":"xxxxx","psk":"xxxxxxxx"} ワイヤレスLANの設定。connection_typeが`wlan`のとき設定可能です。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"display_name": "Wireless connection 1",
"enabled": true,
"priority": 0,
"metric": -1,
"ipv4_settings": {"manual": false,
"address": "",
"subnet_mask": "",
"default_gateway": "",
"dns_servers": [ ],
"dns_priority": 0
},
"ethernet_settings": {"mtu": 0
},
"gsm_settings": {"mtu": 0,
"apn": "xxxxx",
"username": "",
"password": "",
"band_preset": ""
},
"wireless_settings": {"mtu": 0,
"ssid": "xxxxx",
"psk": "xxxxxxxx"
}
}

Response samples

200
400
403
404

Content type

application/json; charset=UTF-8

{"uuid": "77397428-dfa1-3427-a283-92face322b04",
"device_name": "cdc-wdm0",
"display_name": "Wireless connection 1",
"enabled": true,
"priority": 0,
"metric": -1,
"protected": false,
"ipv4_settings": {"manual": false,
"address": "",
"subnet_mask": "",
"default_gateway": "",
"dns_servers": [ ],
"dns_priority": 0
},
"connection_type": "gsm",
"ethernet_settings": {"mtu": 0
},
"gsm_settings": {"mtu": 0,
"apn": "xxxxx",
"username": "",
"password": "",
"band_preset": ""
},
"wireless_settings": {"mtu": 0,
"ssid": "xxxxx",
"psk": "xxxxxxxx"
}
}

Delete Network Connection

Network Connectionを削除します。

Terminal System APIは起動時にconnection_typeがethernetかつenabledがtrueのコネクションが無い場合は、自動的決定する１つのコネクションを有効化または作成します。

Authorizations:

basicAuth

path Parameters

uuid

required

uuid (network_connection_uuid)

Example: 77397428-dfa1-3427-a283-92face322b04

ネットワークコネクションを識別するための文字列。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

GSM Frequency Band Preset

Get GSM Frequency Band Preset

GSM用周波数バンド設定のリストを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

[{"name": "TG.09.0113",
"bands": {"umts": ["B19"
],
"lte_fdd": ["B19"
],
"lte_tdd": ["B40"
]
}
}
]

IP Allowlist

Get IP Allowlist

IP許可リストを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

{"allowlist": ["192.168.0.1/24"
]
}

Replace IP Allowlist

IP許可リストを設定します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

allowlist

required

Array of strings

APIにアクセスを許可するIPをCIDR表記で指定したリスト。 IPv4で指定している場合にはIPv6のアドレスは許可されません。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"allowlist": ["192.168.0.1/24"
]
}

Response samples

200
400
403

Content type

application/json; charset=UTF-8

{"allowlist": ["192.168.0.1/24"
]
}

API User

Update API User user

APIユーザーを更新します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

password

string <password> (basic_auth_pass) [ 1 .. 256 ] characters ^[a-zA-Z0-9@$!%*?&]{1,256}$

Basic認証用のパスワード。ユーザー名とともに使用します。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"password": "p@ssword"
}

Response samples

200
400
403

Content type

application/json; charset=UTF-8

{"username": "user",
"password": "p@ssword"
}

Update API User admin

APIユーザーを更新します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

password

string <password> (basic_auth_pass) [ 1 .. 256 ] characters ^[a-zA-Z0-9@$!%*?&]{1,256}$

Basic認証用のパスワード。ユーザー名とともに使用します。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"password": "p@ssword"
}

Response samples

200
400
403

Content type

application/json; charset=UTF-8

{"username": "user",
"password": "p@ssword"
}

Login User

Regenerate maint SSH Private Key

maintユーザーののSSH秘密鍵を再生成します。

再生成を行うとSSH公開鍵も変わります。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get maint SSH Public Key

maintユーザーのSSH公開鍵を取得します。

Authorizations:

basicAuth

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get maint SSH Authorized Keys

maintユーザーのauthorized_keysファイルを取得します。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Replace maint SSH Authorized Keys

maintユーザーののauthorized_keysファイルを設定します。

Authorizations:

basicAuth

Request Body schema: multipart/form-data

string <binary> (authorized_keys)

このユーザーがログインに使用する、ECDSA、RSA、またはED25519による公開鍵。マニュアルページsshd(8)に記載されている、各行に1つの鍵を格納したフォーマットです。

Responses

Response samples

400
403

Content type

application/json; charset=UTF-8

Example

JSON parse error

{"title": "Invalid request body",
"status": 400,
"detail": "request {request}: {detail}.",
"instance": "/pkg/error.go#123"
}

Get admin SSH Authorized Keys

adminユーザーのauthorized_keysファイルを取得します。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Replace admin SSH Authorized Keys

adminユーザーののauthorized_keysファイルを設定します。

Authorizations:

basicAuth

Request Body schema: multipart/form-data

string <binary> (authorized_keys)

このユーザーがログインに使用する、ECDSA、RSA、またはED25519による公開鍵。マニュアルページsshd(8)に記載されている、各行に1つの鍵を格納したフォーマットです。

Responses

Response samples

400
403

Content type

application/json; charset=UTF-8

Example

JSON parse error

{"title": "Invalid request body",
"status": 400,
"detail": "request {request}: {detail}.",
"instance": "/pkg/error.go#123"
}

Remote Support

Create Remote Support

遠隔サポートを作成します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

fqdn required	string non-empty 中継サーバーのFQDN
forward_port_to required	number [ 1 .. 65535 ] 中継サーバーの待ち受けポート番号

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"fqdn": "maint.example.net",
"forward_port_to": 10022
}

Response samples

200
400
403
409

Content type

application/json; charset=UTF-8

{"login_user": "maint",
"fqdn": "maint.example.net",
"forward_port_to": 10022
}

Get Remote Support

遠隔サポートを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"login_user": "maint",
"fqdn": "maint.example.net",
"forward_port_to": 10022
}

Delete Remote Support

遠隔サポートを削除します。

Authorizations:

basicAuth

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Remote Support State

遠隔サポートの状態を取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"running": true
}

Event

List Events (experimental)

イベントのリストを取得します。

Authorizations:

basicAuth

query Parameters

filters

string <json>

Example: filters={"enabled": [true]}

リストをフィルターします。リストされるオブジェクトにある第一階層のみを対象にフィルターできます。
filtersはJSONオブジェクトで記載してください。否定フィルターを設定したい場合は!に続けてJSONオブジェクトを記載してください。

例（enabledがtrue、のオブジェクトだけを取得）:

filters={"enabled": [true]}

例（enabledがtrueかつ、idが1または2、のオブジェクトだけを取得）:

filters={"enabled": [true], "id": [1,2]}

例（enabledがtrueかつ、idが1または2、でないオブジェクトだけを取得）:

filters=!{"enabled": [true], "id": [1,2]}

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

[{"description": "can't open device",
"level": "ERROR",
"create_time": "2017-07-21T17:32:28Z"
}
]

Monitor

Get Monitors

モニター設定のリストを取得します。

Authorizations:

basicAuth

query Parameters

filters

string <json>

Example: filters={"enabled": [true]}

リストをフィルターします。リストされるオブジェクトにある第一階層のみを対象にフィルターできます。
filtersはJSONオブジェクトで記載してください。否定フィルターを設定したい場合は!に続けてJSONオブジェクトを記載してください。

例（enabledがtrue、のオブジェクトだけを取得）:

filters={"enabled": [true]}

例（enabledがtrueかつ、idが1または2、のオブジェクトだけを取得）:

filters={"enabled": [true], "id": [1,2]}

例（enabledがtrueかつ、idが1または2、でないオブジェクトだけを取得）:

filters=!{"enabled": [true], "id": [1,2]}

Responses

Response samples

200
403
422

Content type

application/json; charset=UTF-8

[{"id": "log_usb-disconnected",
"subsystem": "log",
"enabled": true,
"variables": ["key=value"
]
}
]

Create Monitor

モニター設定を作成します。POST /monitors/-/applyするまでモニター設定は適応されません。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

id required	string (monitor_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ モニター設定を識別するための文字列。文字列はsubsystemの文字列に`_`を付加した文字列で始まる必要があります。
subsystem required	string [ 1 .. 32 ] characters ^[a-z]{1,32}$ モニターのサブシステム。
enabled	boolean Default: true モニターの有効(`true`)／無効(`false`)
args	Array of strings サブシステム毎に必要とする引数のリスト。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "log_usb-disconnected",
"subsystem": "log",
"enabled": true,
"args": [["User logged out due to security policy: \\w+",
"@/opt/bin/logs-secure.sh"
]
]
}

Response samples

201
400
403

Content type

application/json; charset=UTF-8

{"id": "log_usb-disconnected",
"subsystem": "log",
"enabled": true,
"variables": ["key=value"
]
}

Get Monitor

モニター設定を取得します。

Authorizations:

basicAuth

path Parameters

id

required

string (monitor_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: log_usb-disconnected

モニター設定を識別するための文字列。文字列はsubsystemの文字列に_を付加した文字列で始まる必要があります。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"id": "log_usb-disconnected",
"subsystem": "log",
"enabled": true,
"variables": ["key=value"
]
}

Update Monitor

モニター設定を更新します。POST /monitors/-/applyするまでモニター設定は適応されません。

Authorizations:

basicAuth

path Parameters

id

required

string

Request Body schema: application/json; charset=UTF-8

enabled

boolean

Default: true

モニターの有効(true)／無効(false)

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"enabled": true
}

Response samples

200
400
403
404

Content type

application/json; charset=UTF-8

{"id": "log_usb-disconnected",
"subsystem": "log",
"enabled": true,
"variables": ["key=value"
]
}

Delete Monitor

モニター設定を削除します。POST /monitors/-/applyするまでモニター設定は適応されません。

Authorizations:

basicAuth

path Parameters

id

required

string (monitor_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: log_usb-disconnected

モニター設定を識別するための文字列。文字列はsubsystemの文字列に_を付加した文字列で始まる必要があります。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Apply Monitors

全てのモニター設定を適用します。

Authorizations:

basicAuth

path Parameters

id

required

string (monitor_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: log_usb-disconnected

モニター設定を識別するための文字列。文字列はsubsystemの文字列に_を付加した文字列で始まる必要があります。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Compose

List Docker Conposes

Docker Composeに関する設定のリストを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

[{"id": "custom",
"boot_after": "",
"prune_unused_tag": true,
"protected": false,
"docker_compose_yml": "/etc/core/docker-compose/measurement/docker-compose.yml",
"working_directory": "/var/lib/core/docker-compose/measurement"
}
]

Create Docker Compose

Docker Composeに関する設定を作成します。

Authorizations:

basicAuth

Request Body schema: application/json; charset=UTF-8

id required	string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ Docker Composeに関する設定を識別するための文字列。`system`は予約されているため使用できません。
boot_after	string Default: "system" Enum: "" "system" "measurement" Docker Composeプロジェクトを起動するタイミング。boot_afterで指定されたDocker Composeプロジェクトの起動が完了すると自動的に起動します。 boot_afterの設定にかかわらず、Start Docker Composeで起動することも可能です。 `""` - 自動的に起動はしません。 `"system"` - あらかじめインストールされているsystemプロジェクトの起動が完了すると自動的に起動します。systemプロジェクトは電源On後に起動します。 `"measurement"` - あらかじめインストールされているmeasurementプロジェクトの起動が完了すると自動的に起動します。
prune_unused_tag	bool Default: true Docker Composeが使用するDockerイメージのうち、使用しないタグを自動的に削除します。自動的に削除を行うタイミングは以下になります。 Terminal System APIの起動時 Docker Composeの起動時

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "custom",
"boot_after": "",
"prune_unused_tag": true
}

Response samples

201
400
403
409

Content type

application/json; charset=UTF-8

{"id": "custom",
"boot_after": "",
"prune_unused_tag": true,
"protected": false,
"docker_compose_yml": "/etc/core/docker-compose/measurement/docker-compose.yml",
"working_directory": "/var/lib/core/docker-compose/measurement"
}

Get Docker Compose

Docker Composeに関する設定を取得します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"id": "custom",
"boot_after": "",
"prune_unused_tag": true,
"protected": false,
"docker_compose_yml": "/etc/core/docker-compose/measurement/docker-compose.yml",
"working_directory": "/var/lib/core/docker-compose/measurement"
}

Update Docker Compose

Docker Composeに関する設定を更新します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Request Body schema: application/json; charset=UTF-8

boot_after

string

Default: "system"

Enum: "" "system" "measurement"

Docker Composeプロジェクトを起動するタイミング。boot_afterで指定されたDocker Composeプロジェクトの起動が完了すると自動的に起動します。 boot_afterの設定にかかわらず、Start Docker Composeで起動することも可能です。

"" - 自動的に起動はしません。
"system" - あらかじめインストールされているsystemプロジェクトの起動が完了すると自動的に起動します。systemプロジェクトは電源On後に起動します。
"measurement" - あらかじめインストールされているmeasurementプロジェクトの起動が完了すると自動的に起動します。

prune_unused_tag

bool

Default: true

Docker Composeが使用するDockerイメージのうち、使用しないタグを自動的に削除します。自動的に削除を行うタイミングは以下になります。

Terminal System APIの起動時
Docker Composeの起動時

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"boot_after": "",
"prune_unused_tag": true
}

Response samples

200
400
403
404

Content type

application/json; charset=UTF-8

{"id": "custom",
"boot_after": "",
"prune_unused_tag": true,
"protected": false,
"docker_compose_yml": "/etc/core/docker-compose/measurement/docker-compose.yml",
"working_directory": "/var/lib/core/docker-compose/measurement"
}

Delete Docker Compose

Docker Composeに関する設定を削除します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

List Docker Compose Files

Docker Composeディレクトリに保存されているファイルのリストを取得します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

[{"id": "custom",
"path": "docker-compose.yml",
"readonly": false,
"absolute_path": "/etc/core/docker-compose/{id}"
}
]

Get Docker Compose File

Docker Composeディレクトリに保存されているファイルを取得します。

Authorizations:

basicAuth

path Parameters

id required	string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ Example: custom Docker Composeに関する設定を識別するための文字列。`system`は予約されているため使用できません。
path required	string (docker_compose_file_path) Example: docker-compose.yml Docker Compose 実行時の作業ディレクトリからの相対パス。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"id": "custom",
"path": "docker-compose.yml",
"readonly": false,
"absolute_path": "/etc/core/docker-compose/{id}"
}

Delete Docker Compose File

Docker Composeディレクトリに保存されているファイルを削除します。

Authorizations:

basicAuth

path Parameters

id required	string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ Example: custom Docker Composeに関する設定を識別するための文字列。`system`は予約されているため使用できません。
path required	string (docker_compose_file_path) Example: docker-compose.yml Docker Compose 実行時の作業ディレクトリからの相対パス。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Get Docker Compose File Contents

Docker Composeディレクトリに保存されているファイルの内容を取得します。

Authorizations:

basicAuth

path Parameters

id required	string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ Example: custom Docker Composeに関する設定を識別するための文字列。`system`は予約されているため使用できません。
path required	string (docker_compose_file_path) Example: docker-compose.yml Docker Compose 実行時の作業ディレクトリからの相対パス。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Replace Docker Compose File Contents

Docker Composeディレクトリに保存されているファイルの内容を設定します。

Authorizations:

basicAuth

path Parameters

id required	string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$ Example: custom Docker Composeに関する設定を識別するための文字列。`system`は予約されているため使用できません。
path required	string (docker_compose_file_path) Example: docker-compose.yml Docker Compose 実行時の作業ディレクトリからの相対パス。

Request Body schema: multipart/form-data

string <binary> (docker_compose_file_contents)

docker-composeディレクトリ内のファイル。ファイル名property.jsonはAPiにより自動的に内容が変更されます。APIが読み取りできない内容が記載されている場合はpanicになります。

Responses

Response samples

400
403
404

Content type

application/json; charset=UTF-8

{"title": "Invalid request body",
"status": 400,
"detail": "'{value}' does not follow the rule for '{key}' ({rule}).",
"instance": "/pkg/error.go#123"
}

Start Docker Compose

Docker Composeを起動します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Stop Docker Compose

Docker Composeを終了します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Pull Docker Compose

Docker Composeに関連付けられたイメージを取得します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Build Docker Compose

Docker Composeをビルドします。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_compose_id) [ 1 .. 100 ] characters ^[-_a-zA-Z0-9]{1,100}$

Example: custom

Docker Composeに関する設定を識別するための文字列。systemは予約されているため使用できません。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Image

List Docker Images

Docker Imageのリストを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

[{"id": "b535b3285e1d",
"repository": "hello-world",
"tag": "latest",
"size": "155MB"
}
]

Get Docker Image

Dockerイメージを取得します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_image_id) = 12 characters ^[a-z0-9]{12}$

Example: b535b3285e1d

DockerイメージのIMAGE ID。

Responses

Response samples

200
403
404

Content type

application/json; charset=UTF-8

{"id": "b535b3285e1d",
"repository": "hello-world",
"tag": "latest",
"size": "155MB"
}

Delete Docker Compose

Dockerイメージを削除します。

Authorizations:

basicAuth

path Parameters

id

required

string (docker_image_id) = 12 characters ^[a-z0-9]{12}$

Example: b535b3285e1d

DockerイメージのIMAGE ID。

Responses

Response samples

403
404

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Container

List Docker Containers

Docker Engine APIのList containersにリバースプロキシーされます。

Authorizations:

basicAuth

Responses

Response samples

403

Content type

application/json; charset=UTF-8

{"title": "Request is rejected",
"status": 403,
"detail": "request is rejected due to '{reason}'",
"instance": "/pkg/error.go#123"
}

Version

Get Version

Terminal System APIのバージョンを取得します。

Authorizations:

basicAuth

Responses

Response samples

200
403

Content type

application/json; charset=UTF-8

{"version": "1.0.0"
}