Agent Command API (v1.2.1)

Download OpenAPI specification:Download

intdash Edge Agent 2のデーモンの操作はUnix Domain Socket経由のREST APIから行うことができます。

リクエスト

全てのAPIエンドポイントは、先頭にベースURLhttp://unix/api/v1を付加することで、完全なURLとして使用できます。
例えば、「Agent Daemon APIのバージョンを取得する」APIエンドポイント/versionの完全なURLはhttp://unix/api/v1/versionになります。

curlを使用する場合は、以下のようにします。

--requestまたは-Xフラグを使用し、その後にHTTPメソッドを指定します。
--unix-socketフラグを使用し、その後にUnix Domain Socketのパスを指定します。
--urlフラグを使用し、その後に完全なURLを指定します。

curl --request GET --unix-socket /var/run/intdash/agentd.sock --url "http://unix/api/v1/version"

Connection to Server

Get Connection Settings

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

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"server_url": "https://xxxxx.intdash.jp",
"project_uuid": "b1c54490-f275-452b-96ae-6e318e7df5ec",
"edge_uuid": "fa12ae1b-7cfc-4e06-ae7a-210a1f0318b8",
"client_secret": "cK6YdByyZkT06dbDrdHxXCROwIumeJ1cqDccErxa7V4RhCvsdivfdKW0sCnYBEMN"
}

Update Connection Settings

Agentとintdashサーバー間の接続に関する設定を更新します。

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

server_url	string <uri> Default: "https://xxxxx.intdash.jp" 接続先intdashサーバーのURL
project_uuid	string <uuid> Default: "00000000-0000-0000-0000-000000000000" プロジェクトUUID
edge_uuid	string <uuid> Default: "00000000-0000-0000-0000-000000000000" intdashサーバーに接続する際に使用する、このエッジのUUID
client_secret	string <password> non-empty intdashサーバーに接続する際に使用するクライアントシークレット

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"server_url": "https://xxxxx.intdash.jp",
"project_uuid": "b1c54490-f275-452b-96ae-6e318e7df5ec",
"edge_uuid": "fa12ae1b-7cfc-4e06-ae7a-210a1f0318b8",
"client_secret": "cK6YdByyZkT06dbDrdHxXCROwIumeJ1cqDccErxa7V4RhCvsdivfdKW0sCnYBEMN"
}

Response samples

200
400

Content type

application/json; charset=UTF-8

{"server_url": "https://xxxxx.intdash.jp",
"project_uuid": "b1c54490-f275-452b-96ae-6e318e7df5ec",
"edge_uuid": "fa12ae1b-7cfc-4e06-ae7a-210a1f0318b8",
"client_secret": "cK6YdByyZkT06dbDrdHxXCROwIumeJ1cqDccErxa7V4RhCvsdivfdKW0sCnYBEMN"
}

Verify Connection Settings

Agentとintdashサーバー間の接続をテストします。トランスポートにはGet Transport Settingsに設定されている値を使用します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

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

Get Transport Settings

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

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"protocol": "quic",
"send_queue_size": 4096
}

Update Transport Settings

Agentとintdashサーバー間の接続方法に関する設定を更新します。

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

protocol	string Default: "websocket" Enum: "quic" "websocket" quic - QUIC による接続 websocket - WebSocket による接続
send_queue_size	integer [ 1 .. 4294967295 ] Default: 4096 iSCPでの送信で使用する送信キューのサイズ。WebSocketによる接続を使用していて、ネットワーク品質が低い環境において秒間データ量が大きいときに計測が停止してしまう場合は、大きな値を設定してください。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"protocol": "quic",
"send_queue_size": 4096
}

Response samples

200
400

Content type

application/json; charset=UTF-8

{"protocol": "quic",
"send_queue_size": 4096
}

Stream

List Upstream Settings

アップストリームに関する設定のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"id": "recoverable",
"enabled": true,
"recover": true,
"persist": true,
"qos": "partial",
"flush_policy": "interval",
"flush_interval": 5
}
]
}

Create Upstream Settings

アップストリームに関する設定を作成します。

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

id required	string [ 1 .. 100 ] characters ストリームのID。 `deferred` というIDは、遅延アップロードの設定です（予約されたIDです）。
enabled	boolean Default: true ストリームの有効(`true`)／無効(`false`)
recover	boolean Default: true アップストリームで送信が出来なかったと判断した場合の遅延アップロードの有効(`true`)／無効(`false`)。 persistがfalseの場合は強制的にfalseとして処理されます。
persist	boolean Default: true サーバーでのデータ永続化の有効(`true`)／無効(`false`)
qos	string Default: "unreliable" Enum: "partial" "unreliable" コネクションのトランスポートが信頼性のある接続とない接続をサポートしている場合にどちらを使用するかを表します。 partial - 信頼性のある接続を使用します（iSCPのQoSとしてPARTIALを指定）。 unreliable - 可能な場合は信頼性のない接続を使用します（iSCPのQoSとしてUNRELIABLEを指定）。
flush_policy	string Default: "interval" Enum: "interval" "immediately" interval - リアルタイム送信を一定周期ごとにフラッシュします。 immediately - リアルタイム送信をデータポイントごとにフラッシュします。
flush_interval	integer [ 1 .. 100000 ] Default: 5 リアルタイム送信をフラッシュする間隔（ミリ秒）。`flush_policy`が`interval`の場合のみ利用されます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"recover": true,
"persist": true,
"qos": "partial",
"flush_policy": "interval",
"flush_interval": 5
}

Response samples

200
400

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"recover": true,
"persist": true,
"qos": "partial",
"flush_policy": "interval",
"flush_interval": 5
}

Get Upstream Settings

アップストリームに関する設定を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"recover": true,
"persist": true,
"qos": "partial",
"flush_policy": "interval",
"flush_interval": 5
}

Update Upstream Settings

アップストリームに関する設定を更新します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

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

enabled	boolean Default: true ストリームの有効(`true`)／無効(`false`)
recover	boolean Default: true アップストリームで送信が出来なかったと判断した場合の遅延アップロードの有効(`true`)／無効(`false`)。 persistがfalseの場合は強制的にfalseとして処理されます。
persist	boolean Default: true サーバーでのデータ永続化の有効(`true`)／無効(`false`)
qos	string Default: "unreliable" Enum: "partial" "unreliable" コネクションのトランスポートが信頼性のある接続とない接続をサポートしている場合にどちらを使用するかを表します。 partial - 信頼性のある接続を使用します（iSCPのQoSとしてPARTIALを指定）。 unreliable - 可能な場合は信頼性のない接続を使用します（iSCPのQoSとしてUNRELIABLEを指定）。
flush_policy	string Default: "interval" Enum: "interval" "immediately" interval - リアルタイム送信を一定周期ごとにフラッシュします。 immediately - リアルタイム送信をデータポイントごとにフラッシュします。
flush_interval	integer [ 1 .. 100000 ] Default: 5 リアルタイム送信をフラッシュする間隔（ミリ秒）。`flush_policy`が`interval`の場合のみ利用されます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"enabled": true,
"recover": true,
"persist": true,
"qos": "partial",
"flush_policy": "interval",
"flush_interval": 5
}

Response samples

200
400
404

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"recover": true,
"persist": true,
"qos": "partial",
"flush_policy": "interval",
"flush_interval": 5
}

Delete Upstream Settings

アップストリームに関する設定を削除します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

List Upstream State

アップストリームの状態のリストを取得します。

query Parameters

enabled

bool

Example: enabled=true

取得対象をフィルターします。 enabled=true を指定すると enabled が true のオブジェクトのみが、enabled=false を指定すると、 false のオブジェクトのみが返されます。

Responses

Response samples

200
400

Content type

application/json; charset=UTF-8

[{"id": "recoverable",
"enabled": true,
"code": "error",
"error": "uninitialized",
"bitrate": 1024,
"update_time": "2017-02-11T12:34:56Z"
}
]

Get Upstream State

アップストリームの状態を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"code": "error",
"error": "uninitialized",
"bitrate": 1024,
"update_time": "2017-02-11T12:34:56Z"
}

List Downstream Settings

ダウンストリームに関する設定のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"id": "recoverable",
"dest_ids": ["dc1"
],
"qos": "partial",
"filters": [{"src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
"data_filters": [{"type": "bytes",
"name": "abc/efg"
}
]
}
]
}
]
}

Create Downstream Settings

ダウンストリームに関する設定を作成します。

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

id required	string [ 1 .. 100 ] characters ストリームのID。 `deferred` というIDは、遅延アップロードの設定です（予約されたIDです）。
enabled	boolean Default: true ストリームの有効(`true`)／無効(`false`)
dest_ids required	Array of strings[ items [ 1 .. 100 ] characters ] 送信先のダウンストリーム用デバイスコネクターIPCのID
qos	string Default: "unreliable" Enum: "partial" "unreliable" コネクションのトランスポートが信頼性のある接続とない接続をサポートしている場合にどちらを使用するかを表します。 partial - 信頼性のある接続を使用します（iSCPのQoSとしてPARTIALを指定）。 unreliable - 可能な場合は信頼性のない接続を使用します（iSCPのQoSとしてUNRELIABLEを指定）。
	Array of objects

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"dest_ids": ["dc1"
],
"qos": "partial",
"filters": [{"src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
"data_filters": [{"type": "bytes",
"name": "abc/efg"
}
]
}
]
}

Response samples

200
400

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"dest_ids": ["dc1"
],
"qos": "partial",
"filters": [{"src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
"data_filters": [{"type": "bytes",
"name": "abc/efg"
}
]
}
]
}

Get Downstream Settings

ダウンストリームに関する設定を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"dest_ids": ["dc1"
],
"qos": "partial",
"filters": [{"src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
"data_filters": [{"type": "bytes",
"name": "abc/efg"
}
]
}
]
}

Update Downstream Settings

ダウンストリームに関する設定を設定します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

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

enabled	boolean Default: true ストリームの有効(`true`)／無効(`false`)
dest_ids	Array of strings[ items [ 1 .. 100 ] characters ] 送信先のダウンストリーム用デバイスコネクターIPCのID
qos	string Default: "unreliable" Enum: "partial" "unreliable" コネクションのトランスポートが信頼性のある接続とない接続をサポートしている場合にどちらを使用するかを表します。 partial - 信頼性のある接続を使用します（iSCPのQoSとしてPARTIALを指定）。 unreliable - 可能な場合は信頼性のない接続を使用します（iSCPのQoSとしてUNRELIABLEを指定）。
	Array of objects

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"enabled": true,
"dest_ids": ["dc1"
],
"qos": "partial",
"filters": [{"src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
"data_filters": [{"type": "bytes",
"name": "abc/efg"
}
]
}
]
}

Response samples

200
400

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"dest_ids": ["dc1"
],
"qos": "partial",
"filters": [{"src_edge_uuid": "568ff243-d200-43c4-9942-473c08ccfac1",
"data_filters": [{"type": "bytes",
"name": "abc/efg"
}
]
}
]
}

Delete Downstream Settings

ダウンストリームに関する設定を削除します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

List Downstream State

ダウンストリームの状態のリストを取得します。

query Parameters

enabled

bool

Example: enabled=true

取得対象をフィルターします。 enabled=true を指定すると enabled が true のオブジェクトのみが、enabled=false を指定すると、 false のオブジェクトのみが返されます。

Responses

Response samples

200
400

Content type

application/json; charset=UTF-8

[{"id": "recoverable",
"enabled": true,
"code": "error",
"error": "uninitialized",
"bitrate": 1024,
"update_time": "2017-02-11T12:34:56Z"
}
]

Get Downstream State

ダウンストリームの状態を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: recoverable

ストリームID。

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "recoverable",
"enabled": true,
"code": "error",
"error": "uninitialized",
"bitrate": 1024,
"update_time": "2017-02-11T12:34:56Z"
}

Device Connector IPC

List Device Connector IPC Settings for Upstream

アップストリーム用デバイスコネクターIPC設定のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"id": "dc1",
"data_name_prefix": "",
"dest_ids": ["recoverable"
],
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/up-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}
]
}

Create Device Connector IPC Settings for Upstream

アップストリーム用デバイスコネクターIPC設定を作成します。

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

id required	string [ 1 .. 100 ] characters デバイコネクターIPCのID
data_name_prefix	string Default: "" データ名称のプリフィックスとして使用する文字列。アップストリーム用のデバイスコネクターIPC設定では、プリフィックスをデータ名称に付加します。プリフィックスが付加されたデータ名称は、iSCPのデータ名称の仕様である以下のルールに従う必要があります。空文字を使用することはできません。セパレータ文字（`/`）での開始、終了はできません。セパレータ文字（`/`）を2文字以上連続して使用することはできません。ワイルドカード文字（`#` および `+`）は使用できません。
dest_ids required	Array of strings[ items [ 1 .. 100 ] characters ] 送信先のアップストリームのID。または、 `deferred`。データは、ここで指定されたIDのアップストリームを使ってサーバーに送られます。複数のIDを指定した場合、データポイントは複製され、それぞれのアップストリームからサーバーに送られます。
enabled	boolean Default: true デバイスコネクターIPCの有効(`true`)／無効(`false`)
format required	string Enum: "iscp-v2-compat" "logger-msg" デバイスコネクターとの通信に使用するデータフォーマット iscp-v2-compat : iSCP v2と同等のFIFOデータフォーマット logger-msg : 旧intdash Edge AgentのFIFOデータフォーマット
	object
	object

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"dest_ids": ["recoverable"
],
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/up-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Response samples

201
400

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"dest_ids": ["recoverable"
],
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/up-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Get Device Connector IPC Settings for Upstream

アップストリーム用デバイスコネクターIPC設定を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"dest_ids": ["recoverable"
],
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/up-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Update Device Connector IPC Settings for Upstream

アップストリーム用デバイスコネクターIPC設定を更新します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

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

data_name_prefix	string Default: "" データ名称のプリフィックスとして使用する文字列。アップストリーム用のデバイスコネクターIPC設定では、プリフィックスをデータ名称に付加します。プリフィックスが付加されたデータ名称は、iSCPのデータ名称の仕様である以下のルールに従う必要があります。空文字を使用することはできません。セパレータ文字（`/`）での開始、終了はできません。セパレータ文字（`/`）を2文字以上連続して使用することはできません。ワイルドカード文字（`#` および `+`）は使用できません。
dest_ids	Array of strings[ items [ 1 .. 100 ] characters ] 送信先のアップストリームのID。または、 `deferred`。データは、ここで指定されたIDのアップストリームを使ってサーバーに送られます。複数のIDを指定した場合、データポイントは複製され、それぞれのアップストリームからサーバーに送られます。
enabled	boolean Default: true デバイスコネクターIPCの有効(`true`)／無効(`false`)
format	string Enum: "iscp-v2-compat" "logger-msg" デバイスコネクターとの通信に使用するデータフォーマット iscp-v2-compat : iSCP v2と同等のFIFOデータフォーマット logger-msg : 旧intdash Edge AgentのFIFOデータフォーマット
	object
	object

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"data_name_prefix": "",
"dest_ids": ["recoverable"
],
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/up-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Response samples

200
400
404

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"dest_ids": ["recoverable"
],
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/up-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Delete Device Connector IPC Settings for Upstream

アップストリーム用デバイスコネクターIPC設定を削除します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

List Device Connector IPC States for Upstream

アップストリーム用デバイスコネクターIPCの状態のリストを取得します。

query Parameters

enabled

bool

Example: enabled=true

取得対象をフィルターします。 enabled=true を指定すると enabled が true のオブジェクトのみが、enabled=false を指定すると、 false のオブジェクトのみが返されます。

Responses

Response samples

200
400

Content type

application/json; charset=UTF-8

[{"id": "dc1",
"enabled": true,
"code": "error",
"error": "uninitialized",
"update_time": "2017-02-11T12:34:56Z"
}
]

Get Device Connector IPC State for Upstream

アップストリーム用デバイスコネクターIPCの状態を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "dc1",
"enabled": true,
"code": "error",
"error": "uninitialized",
"update_time": "2017-02-11T12:34:56Z"
}

List Device Connector IPC Settings for Downstream

ダウンストリーム用デバイスコネクターIPC設定のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"id": "dc1",
"data_name_prefix": "",
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/down-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}
]
}

Create Device Connector IPC Settings for Downstream

ダウンストリーム用デバイスコネクターIPC設定を作成します。

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

id required	string [ 1 .. 100 ] characters デバイコネクターIPCのID
data_name_prefix	string Default: "" データ名称のプリフィックスとして使用する文字列。ダウンストリーム用デバイスコネクターIPC設定では、プリフィックスが指定されている場合、以下の処理を行います。プリフィックスで始まるデータポイントのみをデバイスコネクターに送信する。データポイントのデータ名称からプリフィックスを削除する。
enabled	boolean Default: true デバイスコネクターIPCの有効(`true`)／無効(`false`)
format required	string Enum: "iscp-v2-compat" "logger-msg" デバイスコネクターとの通信に使用するデータフォーマット iscp-v2-compat : iSCP v2と同等のFIFOデータフォーマット logger-msg : 旧intdash Edge AgentのFIFOデータフォーマット
	object
	object

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/down-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Response samples

201
400

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/down-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Get Device Connector IPC Settings for Downstream

ダウンストリーム用デバイスコネクターIPC設定を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/down-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Update Device Connector IPC Settings for Downstream

ダウンストリーム用デバイスコネクターIPC設定を更新します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

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

data_name_prefix	string Default: "" データ名称のプリフィックスとして使用する文字列。ダウンストリーム用デバイスコネクターIPC設定では、プリフィックスが指定されている場合、以下の処理を行います。プリフィックスで始まるデータポイントのみをデバイスコネクターに送信する。データポイントのデータ名称からプリフィックスを削除する。
enabled	boolean Default: true デバイスコネクターIPCの有効(`true`)／無効(`false`)
format	string Enum: "iscp-v2-compat" "logger-msg" デバイスコネクターとの通信に使用するデータフォーマット iscp-v2-compat : iSCP v2と同等のFIFOデータフォーマット logger-msg : 旧intdash Edge AgentのFIFOデータフォーマット
	object
	object

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"data_name_prefix": "",
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/down-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Response samples

200
400
404

Content type

application/json; charset=UTF-8

{"id": "dc1",
"data_name_prefix": "",
"enabled": true,
"format": "iscp-v2-compat",
"ipc": {"type": "fifo",
"path": "/var/run/intdash/down-{id}.fifo"
},
"launch": {"cmd": "device-connector-intdash",
"args": ["--config"
],
"environment": ["KEY=value"
]
}
}

Delete Device Connector IPC Settings for Downstream

ダウンストリーム用デバイスコネクターIPC設定を削除します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

List Device Connector IPC States for Downstream

ダウンストリーム用デバイスコネクターIPCの状態のリストを取得します。

query Parameters

enabled

bool

Example: enabled=true

取得対象をフィルターします。 enabled=true を指定すると enabled が true のオブジェクトのみが、enabled=false を指定すると、 false のオブジェクトのみが返されます。

Responses

Response samples

200
400

Content type

application/json; charset=UTF-8

[{"id": "dc1",
"enabled": true,
"code": "error",
"error": "uninitialized",
"update_time": "2017-02-11T12:34:56Z"
}
]

Get Device Connector IPC State for Downstream

ダウンストリーム用デバイスコネクターIPCの状態を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: dc1

デバイコネクターIPCのID

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "dc1",
"enabled": true,
"code": "error",
"error": "uninitialized",
"update_time": "2017-02-11T12:34:56Z"
}

Filter

List Filters for Upstream

フィルター（アップストリーム方向）に関する設定のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "recoverable"
}
}
]
}

Create Filter for Upstream

フィルター（アップストリーム方向）に関する設定を作成します。

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

id required	string [ 1 .. 100 ] characters フィルターのID
enabled	boolean Default: true フィルターの有効(`true`)／無効(`false`)
type required	string non-empty フィルターの種類
required	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) 対象データポイントの条件指定。条件の指定方法はフィルターのタイプによって異なります。データポイントがここで記載された条件に一致した場合、データポイントに `change_to` で指定された変更が行われます。
required	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) フィルターの条件に合致したデータポイントは、ここに指定された変更が行われます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "recoverable"
}
}

Response samples

201
400

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "recoverable"
}
}

Get Filter for Upstream

フィルター（アップストリーム方向）に関する設定を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: data_sampling

フィルターのID

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "recoverable"
}
}

Update Filter for Upstream

フィルター（アップストリーム方向）に関する設定を更新します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: data_sampling

フィルターのID

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

enabled	boolean Default: true フィルターの有効(`true`)／無効(`false`)
type	string non-empty フィルターの種類
	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) 対象データポイントの条件指定。条件の指定方法はフィルターのタイプによって異なります。データポイントがここで記載された条件に一致した場合、データポイントに `change_to` で指定された変更が行われます。
	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) フィルターの条件に合致したデータポイントは、ここに指定された変更が行われます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "recoverable"
}
}

Response samples

200
400
404

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "recoverable"
}
}

Delete Filter for Upstream

フィルター（アップストリーム方向）に関する設定を削除します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: data_sampling

フィルターのID

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

List Filters for Downstream

フィルター（ダウンストリーム方向）に関する設定のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "dc1"
}
}
]
}

Create Filter for Downstream

フィルター（ダウンストリーム方向）に関する設定を作成します。

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

id required	string [ 1 .. 100 ] characters フィルターのID
enabled	boolean Default: true フィルターの有効(`true`)／無効(`false`)
type required	string non-empty フィルターの種類
required	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) 対象データポイントの条件指定。条件の指定方法はフィルターのタイプによって異なります。データポイントがここで記載された条件に一致した場合、データポイントに `change_to` で指定された変更が行われます。
required	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) フィルターの条件に合致したデータポイントは、ここに指定された変更が行われます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "dc1"
}
}

Response samples

201
400

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "dc1"
}
}

Get Filter for Downstream

フィルター（ダウンストリーム方向）に関する設定を取得します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: data_sampling

フィルターのID

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "dc1"
}
}

Update Filter for Downstream

フィルター（ダウンストリーム方向）に関する設定を更新します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: data_sampling

フィルターのID

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

enabled	boolean Default: true フィルターの有効(`true`)／無効(`false`)
type	string non-empty フィルターの種類
	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) 対象データポイントの条件指定。条件の指定方法はフィルターのタイプによって異なります。データポイントがここで記載された条件に一致した場合、データポイントに `change_to` で指定された変更が行われます。
	always (object) or type (object) or name (object) or src-id (object) or rename (object) or sampling (object) or h264-essential-nal-units (object) フィルターの条件に合致したデータポイントは、ここに指定された変更が行われます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "dc1"
}
}

Response samples

200
400
404

Content type

application/json; charset=UTF-8

{"id": "data_sampling",
"enabled": true,
"type": "sampling",
"target": {"dest_ids": ["recoverable"
]
},
"change_to": {"dest_id": "dc1"
}
}

Delete Filter for Downstream

フィルター（ダウンストリーム方向）に関する設定を削除します。

path Parameters

id

required

string [ 1 .. 100 ] characters

Example: data_sampling

フィルターのID

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

Deferred Upload

Get Deferred Upload Settings

遅延アップロードに関する設定を取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"priority": "higher_than_realtime",
"limit_data_storage": true,
"data_storage_capacity": 102400
}

Update Deferred Upload Settings

遅延アップロードに関する設定をします。

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

priority	string Default: "same_as_realtime" Enum: "higher_than_realtime" "same_as_realtime" "lower_than_realtime" 遅延アップロードのネットワーク通信の優先度 higher_than_realtime -リアルタイム送受信よりも高い優先度で遅延アップロードを行います。遅延アップロードが帯域を占有した場合はリアルタイム送信は行われません。 same_as_realtime -リアルタイム送受信と同じ優先度で遅延アップロードを行います。遅延アップロードが帯域を占有することはありませんが、遅延アップロードによりリアルタイム送受信が影響を受ける場合があります。 lower_than_realtime -リアルタイム送受信よりも低い優先度で遅延アップロードを行います。リアルタイム送受信が帯域を占有した場合は遅延アップロードは行われません。
limit_data_storage	boolean Default: true 計測データベースの容量を一定の容量以下にする処理の有効(`true`)／無効(`false`)。 `true` にすると、遅延アップロード用のデータが `data_storage_capacity` を超えた場合に、古いデータから順に削除されます。削除されたデータを復元することはできません。 `false` にすると、遅延アップロード用のデータが増加し、ディスクの使用量が90%以上になった場合、ストリーマーが自動的に終了し、計測が終了します。
data_storage_capacity	integer <int64> Default: 102400 遅延アップロード用のデータの保存のために使用するディスク容量(MiB)。 `limit_data_storage` を `true` にした場合、データの量がこの容量を超える場合は、古いデータから順に削除されます。

Responses

Request samples

Payload

Content type

application/json; charset=UTF-8

{"priority": "higher_than_realtime",
"limit_data_storage": true,
"data_storage_capacity": 102400
}

Response samples

200
400

Content type

application/json; charset=UTF-8

{"priority": "higher_than_realtime",
"limit_data_storage": true,
"data_storage_capacity": 102400
}

Get Deferred Upload State

遅延アップロードの状態を取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"code": "error",
"error": "uninitialized",
"bitrate": 1024,
"update_time": "2017-02-11T12:34:56Z"
}

Measurement

List Measurements

計測のリストを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"items": [{"uuid": "3c3b9741-51a1-4f22-ad77-2e1a08122531",
"base_time": "2017-02-11T12:34:56.999999999Z",
"pending_data_size": 0,
"chunk_count": 0
}
]
}

Get Measurement

計測を取得します。

path Parameters

uuid

required

string <uuid>

Example: 3c3b9741-51a1-4f22-ad77-2e1a08122531

計測のUUID。intdashサーバーで管理している計測UUIDと同じです。

Responses

Response samples

200
404

Content type

application/json; charset=UTF-8

{"uuid": "3c3b9741-51a1-4f22-ad77-2e1a08122531",
"base_time": "2017-02-11T12:34:56.999999999Z",
"pending_data_size": 0,
"chunk_count": 0
}

Delete Measurement

計測を削除します。

path Parameters

uuid

required

string <uuid>

Example: 3c3b9741-51a1-4f22-ad77-2e1a08122531

計測のUUID。intdashサーバーで管理している計測UUIDと同じです。

Responses

Response samples

404

Content type

application/json; charset=UTF-8

{"title": "Resource is not found",
"status": 404,
"detail": "'{id}' is not found.",
"instance": "/pkg/error.go#300"
}

Version

Get Version

Agent Command APIのバージョンを取得します。

Responses

Response samples

200

Content type

application/json; charset=UTF-8

{"version": "1.0.0"
}