MediaHarbor API (2023.10.25)

Download OpenAPI specification:Download

Layout

レイアウト関連

レイアウトを取得

指定のレイアウトIDのレイアウトを取得
指定が無い場合は全て取得

query Parameters

id	string <uuid> レイアウトID

Responses

Response Schema: application/json

Array

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string <Base64 Encoded Data>

背景画像

required

Array of objects (elements)

Array

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}
]
}
]

レイアウトを作成

新規レイアウトIDを作成。

Request Body schema: application/json

name required	string レイアウト名
background_image	string <Base64 Encoded Data> 背景画像

Responses

Response Schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string <Base64 Encoded Data>

背景画像

required

Array of objects (elements)

Array

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Request samples

Payload

Content type

application/json

{"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}
]
}

レイアウトを更新

指定のレイアウトIDのレイアウトを更新

query Parameters

id

required

string <uuid>

レイアウトID

Request Body schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string <Base64 Encoded Data>

背景画像

required

Array of objects (elements)

Array

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Responses

Response Schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string <Base64 Encoded Data>

背景画像

required

Array of objects (elements)

Array

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}
]
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}
]
}

レイアウトを削除

指定のレイアウトIDのレイアウト情報を削除します

query Parameters

id

required

string <uuid>

レイアウトID

Responses

現在のレイアウト情報を取得

指定のレイアウトIDのレイアウトを取得

Responses

Response Schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string <Base64 Encoded Data>

背景画像

required

Array of objects (elements)

Array

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}
]
}

レイアウト要素を追加

新規レイアウトIDを作成。

Request Body schema: application/json

layout_id required	string <uuid> レイアウトID
source_id required	string <uuid> ソースID
skin_id	string <uuid> スキンID
left required	integer <int32> 左上X座標
top required	integer <int32> 左上Y座標
width required	integer <int32> 幅
height required	integer <int32> 高さ

Responses

Response Schema: application/json

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Request samples

Payload

Content type

application/json

{"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 240,
"height": 135
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}

レイアウト要素を更新

指定のレイアウトIDのレイアウトを更新

Request Body schema: application/json

id required	string <uuid> 要素ID
source_id	string <uuid> ソースID
skin_id	string <uuid> スキンID
left	integer <int32> 左上X座標
top	integer <int32> 左上Y座標
width	integer <int32> 幅
height	integer <int32> 高さ

Responses

Response Schema: application/json

id

required

string <uuid>

レイアウトID

name

required

string

レイアウト名

background_image

string <Base64 Encoded Data>

背景画像

required

Array of objects (elements)

Array

id

required

string <uuid>

要素ID

layout_id

required

string <uuid>

レイアウトID

source_id

required

string <uuid>

ソースID

skin_id

string <uuid>

スキンID

left

required

integer <int32>

左上X座標

top

required

integer <int32>

左上Y座標

width

required

integer <int32>

幅

height

required

integer <int32>

高さ

createdAt

string <date-time>

作成日時

updatedAt

string <date-time>

更新日時

object

ソース情報

name	string ソース名
protocol_type_id	any Enum: 1 2 プロトコルタイプID(1:SRT, 2:FILE)
source_type_id	any Enum: 1 2 ソースタイプID(1:Vido, 2:Resource)

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 480,
"height": 270
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Layout1",
"background_image": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"layout_id": "118c4a32-91d1-4a21-89a4-a345ccd91280",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"skin_id": "91123d75-4c4f-49fe-82c0-4ff966bdbbb6",
"left": 0,
"top": 0,
"width": 0,
"height": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"source": {"name": "string",
"protocol_type_id": 1,
"source_type_id": 1
}
}
]
}

レイアウト要素を削除

指定のレイアウトIDのレイアウト情報を削除します

query Parameters

id

required

string <uuid>

要素ID

Responses

レイアウト要素を全削除

指定のレイアウトIDのレイアウト情報を全削除します

query Parameters

id

required

string <uuid>

レイアウトID

Responses

現在のレイアウトIDを取得

Responses

Response Schema: text/plain

string <uuid>

現在選択しているレイアウトID

レイアウト選択を切り替え

query Parameters

id

required

string <uuid>

レイアウトID

Responses

Response Schema: text/plain

string <uuid>

現在選択しているレイアウトID

レイアウト選択を切り替え

Request Body schema: application/json

id

required

string <uuid>

レイアウトID

Responses

Response Schema: text/plain

string <uuid>

現在選択しているレイアウトID

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Source

入力ソース関連

入力ソース情報を取得

入力ソースの情報を返します
ソースID指定無しの場合は全ての一覧を返します

query Parameters

id	string <uuid> ソースID

Responses

Response Schema: application/json

Array

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

object

パラメータ

object

mode	string Enum: "Listener" "Caller" モード
port	integer Listenポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sndbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) (0=無制限)
cryptomode	integer 暗号化(0=none,1=aes-128, 2=aes-256)
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object (mask)

マスクルール構造

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"mode": "Listener",
"port": 51000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sndbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitRate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitRate": "1K"
}
},
"mask": {"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}
}
]

入力ソースを新規登録

新しいソースを追加します。ソースIDは新しいUUIDを割り当て、返答に含めます。

Request Body schema: application/json

deehiveKey

string

ユニットID

name

required

string

ソース名

protocol_type_id

required

integer

プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

1

object

パラメータ

sourceProtocolSRTPropertyListener (object) or sourceProtocolSRTPropertyCaller (object)

One of

port required	integer MediaHarbor側ポート
receiver	integer 受信コンテナ側ポート
mode required	string Value: "Listener" モード

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sndbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) (0=無制限)
cryptomode	integer 暗号化(0=none,1=aes-128, 2=aes-256)
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

mask_rule_id

integer or null

マスクルールID

Responses

Response Schema: application/json

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

object

パラメータ

object

mode	string Enum: "Listener" "Caller" モード
port	integer Listenポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sndbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) (0=無制限)
cryptomode	integer 暗号化(0=none,1=aes-128, 2=aes-256)
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object (mask)

マスクルール構造

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Request samples

Payload

Content type

application/json

Example

1

{"deehiveKey": "AAA0000-000",
"name": "string",
"protocol_type_id": "1",
"parameter": {"connection": {"port": 51000,
"receiver": 51000,
"mode": "Listener"
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sndbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"probesize": 100
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitRate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitRate": "1K"
}
},
"mask_rule_id": 1
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"mode": "Listener",
"port": 51000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sndbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitRate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitRate": "1K"
}
},
"mask": {"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}
}

入力ソース情報を更新

指定のソースIDのソース情報を更新します

query Parameters

id

required

string <uuid>

ソースID

Request Body schema: application/json

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

required

integer

プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

object

パラメータ

object

mode	string Enum: "Listener" "Caller" モード
port	integer Listenポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sndbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) (0=無制限)
cryptomode	integer 暗号化(0=none,1=aes-128, 2=aes-256)
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

probesize

integer

フォーマット解析で読み込みデータ量(高ビットレートなソースの場合値を大きくすることで再生できるようになる)

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

mask_rule_id

integer or null

マスクルールID

Responses

Response Schema: application/json

id

required

string <uuid>

ソースID

name

required

string

ソース名

deehiveKey

string

ユニットID

protocol_type_id

integer

プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

object

パラメータ

object

mode	string Enum: "Listener" "Caller" モード
port	integer Listenポート

object

latency	integer レイテンシー(ms)
rcvbuf	integer 受信バッファサイズ(Byte)
sndbuf	integer 送信バッファサイズ(Byte)
maxbw	integer 最大帯域幅(bps) (0=無制限)
cryptomode	integer 暗号化(0=none,1=aes-128, 2=aes-256)
passphrase	string パスフレーズ
oheadbw	integer 帯域幅オーバーヘッド(%)
mss	integer [ 232 .. 1500 ] MTU値
ttl	integer [ 1 .. 255 ] TTL値
tos	string ToS

object

Zoom時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object

通常時のビデオパラメータ

video_type

string

Enum: "high" "low"

タイプ

object

width	integer
height	integer
avgBitRate	string

object (mask)

マスクルール構造

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Request samples

Payload

Content type

application/json

{"name": "string",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"mode": "Listener",
"port": 51000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sndbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
},
"probesize": 100
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitRate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitRate": "1K"
}
},
"mask_rule_id": 1
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"deehiveKey": "AAA0000-000",
"protocol_type_id": 1,
"parameter": {"connection": {"mode": "Listener",
"port": 51000
},
"srt": {"latency": 250,
"rcvbuf": 868608,
"sndbuf": 868608,
"maxbw": 0,
"cryptomode": 1,
"passphrase": "string",
"oheadbw": 25,
"mss": 1496,
"ttl": 64,
"tos": "0x2E"
}
},
"zoom": {"video_type": "high",
"streams": {"width": 1280,
"height": 720,
"avgBitRate": "2000K"
}
},
"deZoom": {"video_type": "low",
"streams": {"width": 256,
"height": 144,
"avgBitRate": "1K"
}
},
"mask": {"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}
}

入力ソース情報を削除

指定のソースIDのソース情報を削除します

query Parameters

id

required

string <uuid>

ソースID

Responses

Resource

リソース関連

リソース情報を取得

リソースの情報を返します
ソースID指定無しの場合は全ての一覧を返します

query Parameters

id	string <uuid> リソースID

Responses

Response Schema: application/json

Array

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

object

id	integer リソースタイプID
type	string リソースタイプ
data	string <Base64 Encoded Data> 画像ファイルデータ

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "ロゴ画像",
"parameter": {"id": 1,
"type": "picture",
"data": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
}
]

リソースを新規登録

新しいリソースを追加します。
リソースIDは新しいUUIDを割り当て、返答に含めます。

Request Body schema: application/json

One of

name

required

string

リソース名

object

id	integer リソースタイプID
type	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 (0 = 中央寄せ, 1 = 左寄せ, 2 = 右寄せ)
y_align	integer 縦方向の配置 (0 = 中央寄せ, 1 = 上寄せ, 2 = 下寄せ)
text_color	string テキストの色 (無かったら、デフォルトの色は白い)
text_border_color	string テキストの枠線の色 (無かったら、デフォルトの色はテキストの色と同じ)
text_background_color	string テキストの背景色　(無かったら、デフォルトの色は透明)
font_size	integer フォントサイズ

Responses

Response Schema: application/json

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

object

id	integer リソースタイプID
type	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 (0 = 中央寄せ, 1 = 左寄せ, 2 = 右寄せ)
y_align	integer 縦方向の配置 (0 = 中央寄せ, 1 = 上寄せ, 2 = 下寄せ)
text_color	string テキストの色 (無かったら、デフォルトの色は白い)
text_border_color	string テキストの枠線の色 (無かったら、デフォルトの色はテキストの色と同じ)
text_background_color	string テキストの背景色　(無かったら、デフォルトの色は透明)
font_size	integer フォントサイズ

Request samples

Payload

Content type

application/json

Example

resourceTypeText

{"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
}
}

Response samples

201

Content type

application/json

Example

resourceTypeText

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
}
}

リソース情報を更新

指定のソースIDのソース情報を更新します

query Parameters

id

required

string <uuid>

ソースID

Request Body schema: application/json

One of

name

required

string

リソース名

object

id	integer リソースタイプID
type	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 (0 = 中央寄せ, 1 = 左寄せ, 2 = 右寄せ)
y_align	integer 縦方向の配置 (0 = 中央寄せ, 1 = 上寄せ, 2 = 下寄せ)
text_color	string テキストの色 (無かったら、デフォルトの色は白い)
text_border_color	string テキストの枠線の色 (無かったら、デフォルトの色はテキストの色と同じ)
text_background_color	string テキストの背景色　(無かったら、デフォルトの色は透明)
font_size	integer フォントサイズ

Responses

Response Schema: application/json

One of

id

required

string <uuid>

リソースID

name

required

string

リソース名

object

id	integer リソースタイプID
type	string リソースタイプ
text	string 表示テキストデータ
x_align	integer 横方向の配置 (0 = 中央寄せ, 1 = 左寄せ, 2 = 右寄せ)
y_align	integer 縦方向の配置 (0 = 中央寄せ, 1 = 上寄せ, 2 = 下寄せ)
text_color	string テキストの色 (無かったら、デフォルトの色は白い)
text_border_color	string テキストの枠線の色 (無かったら、デフォルトの色はテキストの色と同じ)
text_background_color	string テキストの背景色　(無かったら、デフォルトの色は透明)
font_size	integer フォントサイズ

Request samples

Payload

Content type

application/json

Example

resourceTypeText

{"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
}
}

Response samples

200

Content type

application/json

Example

resourceTypeText

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "サンプルテキスト",
"parameter": {"id": 2,
"type": "text",
"text": "This is display text.",
"x_align": 0,
"y_align": 0,
"text_color": "#ff00ff",
"text_border_color": "#ffffff",
"text_background_color": "#adadad",
"font_size": 40
}
}

リソース情報を削除

指定のソースIDのソース情報を削除します

query Parameters

id

required

string <uuid>

ソースID

Responses

Config

設定関連

設定を取得

Responses

Response Schema: application/json

required

object

http_iface	string 合成部のHTTPポート
http_port	number 合成部のHTTPアドレス
mhbs_server_address	string MultiviewerサーバーのHTTPアドレス
mhb_api_address	string MediaHarborAPIサーバーのHTTPアドレス
media_dir	string ファイルソースの場所
media_json	string ソース設定jsonの場所
layout_json	string レイアウト設定jsonの場所

required

object

width	string 幅
height	string 高さ

required

object

SRT出力設定

enable

boolean

出力有効

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of arrays エンコーダー設定

width

number

出力動画の幅

height

number

出力動画の高さ

bitrate

number

出力動画のビットレート (byte単位)

required

object

SRT出力設定

enable

boolean

出力有効

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of arrays エンコーダー設定

width

number

出力動画の幅

height

number

出力動画の高さ

bitrate

number

出力動画のビットレート (byte単位)

required

object

外部表示出力設定

enable

boolean

出力有効

Response samples

200

Content type

application/json

{"global": {"http_iface": "127.0.0.1",
"http_port": 10080,
"mhbs_server_address": "http://127.0.0.1:10180",
"mhb_api_address": "http://127.0.0.1:8080",
"media_dir": "/usr/local/share/video",
"media_json": "./conf/input.json",
"layout_json": "./conf/layout.json"
},
"render": {"width": 1920,
"height": 1080
},
"srt": {"enable": true,
"video": {"endcoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
},
"webrtc": {"enable": true,
"video": {"endcoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
},
"displayout": {"enable": true
}
}

一般設定を更新

Request Body schema: application/json

http_iface required	string 合成部のHTTPポート
http_port required	number 合成部のHTTPアドレス
mhbs_server_address required	string MultiviewerサーバーのHTTPアドレス
mhb_api_address required	string MediaHarborAPIサーバーのHTTPアドレス
media_dir required	string ファイルソースの場所
media_json required	string ソース設定jsonの場所
layout_json required	string レイアウト設定jsonの場所

Responses

Response Schema: application/json

http_iface required	string 合成部のHTTPポート
http_port required	number 合成部のHTTPアドレス
mhbs_server_address required	string MultiviewerサーバーのHTTPアドレス
mhb_api_address required	string MediaHarborAPIサーバーのHTTPアドレス
media_dir required	string ファイルソースの場所
media_json required	string ソース設定jsonの場所
layout_json required	string レイアウト設定jsonの場所

Request samples

Payload

Content type

application/json

{"http_iface": "127.0.0.1",
"http_port": 10080,
"mhbs_server_address": "http://127.0.0.1:10180",
"mhb_api_address": "http://127.0.0.1:8080",
"media_dir": "/usr/local/share/video",
"media_json": "./conf/input.json",
"layout_json": "./conf/layout.json"
}

Response samples

200

Content type

application/json

{"http_iface": "127.0.0.1",
"http_port": 10080,
"mhbs_server_address": "http://127.0.0.1:10180",
"mhb_api_address": "http://127.0.0.1:8080",
"media_dir": "/usr/local/share/video",
"media_json": "./conf/input.json",
"layout_json": "./conf/layout.json"
}

レンダー設定を更新

Request Body schema: application/json

width required	string 幅
height required	string 高さ

Responses

Response Schema: application/json

width required	string 幅
height required	string 高さ

Request samples

Payload

Content type

application/json

{"width": 1920,
"height": 1080
}

Response samples

200

Content type

application/json

{"width": 1920,
"height": 1080
}

SRT設定を更新

Request Body schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of arrays エンコーダー設定

width

number

出力動画の幅

height

number

出力動画の高さ

bitrate

number

出力動画のビットレート (byte単位)

Responses

Response Schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of arrays エンコーダー設定

width

number

出力動画の幅

height

number

出力動画の高さ

bitrate

number

出力動画のビットレート (byte単位)

Request samples

Payload

Content type

application/json

{"enable": true,
"video": {"endcoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

Response samples

200

Content type

application/json

{"enable": true,
"video": {"endcoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

HLS設定を更新

Request Body schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

bitrate

required

number

出力動画のビットレート (byte単位)

Responses

Response Schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

bitrate

required

number

出力動画のビットレート (byte単位)

Request samples

Payload

Content type

application/json

{"enable": true,
"video": {"bitrate": 5000000
}
}

Response samples

200

Content type

application/json

{"enable": true,
"video": {"bitrate": 5000000
}
}

WebRTC設定を更新

Request Body schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of arrays エンコーダー設定

width

number

出力動画の幅

height

number

出力動画の高さ

bitrate

number

出力動画のビットレート (byte単位)

Responses

Response Schema: application/json

enable

required

boolean

出力有効

required

object

出力動画設定

object

出力エンコーダー設定

name	string エンコーダー名前
options	Array of arrays エンコーダー設定

width

number

出力動画の幅

height

number

出力動画の高さ

bitrate

number

出力動画のビットレート (byte単位)

Request samples

Payload

Content type

application/json

{"enable": true,
"video": {"endcoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

Response samples

200

Content type

application/json

{"enable": true,
"video": {"endcoder": {"name": "openh264",
"options": [ ]
},
"width": 1920,
"height": 1080,
"bitrate": 5000000
}
}

HDMI出力設定を更新

Request Body schema: application/json

enable

required

boolean

出力有効

Responses

Response Schema: application/json

enable

required

boolean

出力有効

Request samples

Payload

Content type

application/json

{"enable": true
}

Response samples

200

Content type

application/json

{"enable": true
}

Slack通知

Slack通知設定

Responses

Response Schema: application/json

token required	string Slack APIのOAuthトークン。
channel required	string Slackチャンネル行先（チャンネル名には"#"を含める必要があります）。
enable required	boolean Slack通知を有効にします。

Response samples

200

Content type

application/json

{"token": "xoxb-xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx",
"channel": "#alert",
"enable": true
}

Slack通知

Slack通知設定

Request Body schema: application/json

token required	string Slack APIのOAuthトークン。
channel required	string Slackチャンネル行先（チャンネル名には"#"を含める必要があります）。
enable required	boolean Slack通知を有効にします。

Responses

Response Schema: application/json

token required	string Slack APIのOAuthトークン。
channel required	string Slackチャンネル行先（チャンネル名には"#"を含める必要があります）。
enable required	boolean Slack通知を有効にします。

Request samples

Payload

Content type

application/json

{"token": "xoxb-xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx",
"channel": "#alert",
"enable": true
}

Response samples

200

Content type

application/json

{"token": "xoxb-xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx",
"channel": "#alert",
"enable": true
}

メール通知

メール通知設定

Responses

Response Schema: application/json

smtp_server required	string SMTPサーバー
smtp_port required	integer SMTPポート
smtp_helo required	string SMTP helo
sender required	string メール通知の送信者として表示される名前。
smtp_security required	integer SMTPセキュリティ（0 = なし、1 = STARTTLS、2 = SSLまたはTLS）。
smtp_verify_host required	boolean SMTPホストの検証。
smtp_verify_peer required	boolean SMTPピアの検証。
smtp_auth required	integer SMTPの認証レベル（0 = なし、1 = ユーザー名とパスワード）。
username required	string SMTP認証のユーザー名。smtp_authが0の場合、このプロパティは無視されます。
password required	string SMTP認証のパスワード。smtp_authが0の場合、このプロパティは無視されます。
format	integer メール通知のコンテンツタイプ（0 = プレーンテキスト、1 = HTML）。
smtp_for required	string 通知を受け取るメールアドレス。複数のメールアドレスを","で区切って指定できます。
enable required	boolean Slack通知を有効にします。

Response samples

200

Content type

application/json

{"smtp_server": "smtp.gmail.com",
"smtp_port": 587,
"smtp_helo": "smtp.gmail.com",
"sender": "Alert Manager <alert@example.com>",
"smtp_security": 1,
"smtp_verify_host": true,
"smtp_verify_peer": true,
"smtp_auth": 1,
"username": "username@email.com",
"password": "password",
"format": 0,
"smtp_for": "email1@email.com,email2@email.com,email3@email.com",
"enable": true
}

Email通知

Email通知設定

Request Body schema: application/json

smtp_server required	string SMTPサーバー
smtp_port required	integer SMTPポート
smtp_helo required	string SMTP helo
sender required	string メール通知の送信者として表示される名前。
smtp_security required	integer SMTPセキュリティ（0 = なし、1 = STARTTLS、2 = SSLまたはTLS）。
smtp_verify_host required	boolean SMTPホストの検証。
smtp_verify_peer required	boolean SMTPピアの検証。
smtp_auth required	integer SMTPの認証レベル（0 = なし、1 = ユーザー名とパスワード）。
username required	string SMTP認証のユーザー名。smtp_authが0の場合、このプロパティは無視されます。
password required	string SMTP認証のパスワード。smtp_authが0の場合、このプロパティは無視されます。
format	integer メール通知のコンテンツタイプ（0 = プレーンテキスト、1 = HTML）。
smtp_for required	string 通知を受け取るメールアドレス。複数のメールアドレスを","で区切って指定できます。
enable required	boolean Slack通知を有効にします。

Responses

Response Schema: application/json

smtp_server required	string SMTPサーバー
smtp_port required	integer SMTPポート
smtp_helo required	string SMTP helo
sender required	string メール通知の送信者として表示される名前。
smtp_security required	integer SMTPセキュリティ（0 = なし、1 = STARTTLS、2 = SSLまたはTLS）。
smtp_verify_host required	boolean SMTPホストの検証。
smtp_verify_peer required	boolean SMTPピアの検証。
smtp_auth required	integer SMTPの認証レベル（0 = なし、1 = ユーザー名とパスワード）。
username required	string SMTP認証のユーザー名。smtp_authが0の場合、このプロパティは無視されます。
password required	string SMTP認証のパスワード。smtp_authが0の場合、このプロパティは無視されます。
format	integer メール通知のコンテンツタイプ（0 = プレーンテキスト、1 = HTML）。
smtp_for required	string 通知を受け取るメールアドレス。複数のメールアドレスを","で区切って指定できます。
enable required	boolean Slack通知を有効にします。

Request samples

Payload

Content type

application/json

{"smtp_server": "smtp.gmail.com",
"smtp_port": 587,
"smtp_helo": "smtp.gmail.com",
"sender": "Alert Manager <alert@example.com>",
"smtp_security": 1,
"smtp_verify_host": true,
"smtp_verify_peer": true,
"smtp_auth": 1,
"username": "username@email.com",
"password": "password",
"format": 0,
"smtp_for": "email1@email.com,email2@email.com,email3@email.com",
"enable": true
}

Response samples

200

Content type

application/json

{"smtp_server": "smtp.gmail.com",
"smtp_port": 587,
"smtp_helo": "smtp.gmail.com",
"sender": "Alert Manager <alert@example.com>",
"smtp_security": 1,
"smtp_verify_host": true,
"smtp_verify_peer": true,
"smtp_auth": 1,
"username": "username@email.com",
"password": "password",
"format": 0,
"smtp_for": "email1@email.com,email2@email.com,email3@email.com",
"enable": true
}

監視ログ設定を取得

Responses

Response Schema: application/json

Array

id

required

string^[0-9a-fA-F]{8}$

ログID 8桁の16進数文字列
※詳細はログ一覧のスプレッドシートを参照してください。

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

required

string

ログメッセージ(日本語)

message_en

required

string

ログメッセージ(英語)

enable

required

boolean

監視ログ有効/無効

Response samples

200

Content type

application/json

[{"id": "00200201",
"type": "SYS",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected",
"enable": true
}
]

監視ログ設定を更新

監視ログ設定を更新する。

Request Body schema: application/json

id

required

string^[0-9a-fA-F]{8}$

ログID 8桁の16進数文字列
※詳細はログ一覧のスプレッドシートを参照してください。

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

required

string

ログメッセージ

message_en

required

string

ログメッセージ(英語)

enable

required

boolean

監視ログ有効/無効

Responses

Response Schema: application/json

id

required

string^[0-9a-fA-F]{8}$

ログID 8桁の16進数文字列
※詳細はログ一覧のスプレッドシートを参照してください。

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

required

string

ログメッセージ(日本語)

message_en

required

string

ログメッセージ(英語)

enable

required

boolean

監視ログ有効/無効

Request samples

Payload

Content type

application/json

{"id": "00200201",
"level": 6,
"message": "フリーズを検出しました",
"message_en": "Freeze detected",
"enable": true
}

Response samples

200

Content type

application/json

{"id": "00200201",
"type": "SYS",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected",
"enable": true
}

監視ログレベル設定を取得

Responses

Response Schema: application/json

Array

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Response samples

200

Content type

application/json

[{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}
]

監視ログレベル設定を更新

監視ログレベル設定を更新する。

Request Body schema: application/json

level

required

integer

監視ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Responses

Response Schema: application/json

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Request samples

Payload

Content type

application/json

{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}

Response samples

200

Content type

application/json

{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}

NICの一覧を取得

有効なネットワークインターフェースの一覧を取得します。
注意: このAPIを正しく動作させるためには、APIコンテナをnetwork_mode: hostで動作させる必要があります。

Responses

Response Schema: application/json

Array

string

Response samples

200

Content type

application/json

["lo",
"eth0",
"eth1"
]

Secret

Deehive関連シークレット更新

Request Body schema: application/json

auth_endpoint required	string deehive へのリクエストを認証するために使用するエンドポイント。
device_params_endpoint required	string デバイスのパラメータを更新するために使用されるエンドポイント（Deehiveビデオの解像度の変更など）
id required	string deehiveからのid
secret required	string deehiveからのsecret

Responses

Response Schema: application/json

auth_endpoint required	string deehive へのリクエストを認証するために使用するエンドポイント。
device_params_endpoint required	string デバイスのパラメータを更新するために使用されるエンドポイント（Deehiveビデオの解像度の変更など）
id required	string deehiveからのid
secret required	string deehiveからのsecret

Request samples

Payload

Content type

application/json

{"auth_endpoint": "<DeeHive_url>/api/v1/api/v1/authentication",
"device_params_endpoint": "<DeeHive_url>/api/v1/api/v1/device-params",
"id": "63eb3c972d17d200113d8765",
"secret": "secretkey12345"
}

Response samples

200

Content type

application/json

{"auth_endpoint": "<DeeHive_url>/api/v1/api/v1/authentication",
"device_params_endpoint": "<DeeHive_url>/api/v1/api/v1/device-params",
"id": "63eb3c972d17d200113d8765",
"secret": "secretkey12345"
}

License関連シークレット更新

Request Body schema: application/json

api_key required	string LicenseManagerでMediaHarbor割り当てたapi_key
url required	string LicenseManagerのAPI

Responses

Response Schema: application/json

api_key required	string LicenseManagerでMediaHarbor割り当てたapi_key
url required	string LicenseManagerのAPI

Request samples

Payload

Content type

application/json

{"api_key": "31cf8386-9fca-48a1-9572-2ba60d70be8e",
"url": "https://license.trafficsim.co.jp"
}

Response samples

200

Content type

application/json

{"api_key": "31cf8386-9fca-48a1-9572-2ba60d70be8e",
"url": "https://license.trafficsim.co.jp"
}

Notification

通知関連

通知を取得

通知を取得します。

Responses

Response Schema: application/json

Array

id

required

integer

通知ID

required

object

ログ情報

id

integer <int64>

ID

date

string <date-time>

監視日時

source_id

string <uuid>

ソースID

log_id

string^[0-9a-fA-F]{8}$

ログID

object

ソース情報

name	string ソース名
protocol_type_id	integer プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

object

詳細情報

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

integer

ログレベル

値	レベル	説明
0	EMERG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

string

ログメッセージ

message_en

string

ログメッセージ(英語)

jsondata

string

JSONデータ

required

object (NotificationRule)

通知ルール設定構造

id

required

integer

通知先ID

name

required

string

通知ルール名

enable

required

boolean

通知ルール有効フラグ

interval

required

integer

集約間隔(秒)

time_mask

required

json

時間マスク設定

Array of objects (notificationDestination)

通知先情報

Array

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Array of objects (configMonlogLevel)

ログレベル情報

Array

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

required

object (notificationDestination)

通知先設定構造

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

scheduled_time

required

string

通知予定日時

is_success

required

boolean

通知成功フラグ

error_message

required

json

エラーメッセージ

Response samples

200

Content type

application/json

[{"id": 1,
"log": {"id": 0,
"date": "2019-08-24T14:15:22Z",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"log_id": "00200201",
"source": {"name": "string",
"protocol_type_id": 1
},
"details": {"type": "VA",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected"
},
"jsondata": "{\"sid\": 1,\"last_updated_ms\": 1710856298571,\"last_updated_date\": \"2024/03/19 13:51:38\",\"video\": {\"freeze\": {\"is_occuring\": true,\"last_updated_ms\": 1710856298168,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"black\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"img_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"action_trigger\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"audio\": {\"silent\": {\"is_occuring\": false,\"last_updated_ms\": 1710856298569,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"port\": \"50001\"}"
},
"rule": {"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"distinations": [{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}
],
"levels": [{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}
]
},
"distination": {"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
},
"scheduled_time": "2021-01-01T00:00:00Z",
"is_success": true,
"error_message": {"message": "通知に失敗しました。"
}
}
]

通知先設定を取得

Responses

Response Schema: application/json

Array

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Response samples

200

Content type

application/json

[{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}
]

通知先設定を新規登録

Request Body schema: application/json

name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Responses

Response Schema: application/json

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Request samples

Payload

Content type

application/json

{"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

通知先設定を更新

Request Body schema: application/json

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Responses

Response Schema: application/json

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

通知先設定を削除

query Parameters

id

required

integer

通知先ID

Responses

通知テストを送信

Request Body schema: application/json

type required	integer 通知先タイプ (1=slack, 2=email)
lang required	string 言語
detail required	json 通知先詳細

Responses

Request samples

Payload

Content type

application/json

{"type": 1,
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}

通知ルール設定を取得

Responses

Response Schema: application/json

Array

id

required

integer

通知先ID

name

required

string

通知ルール名

enable

required

boolean

通知ルール有効フラグ

interval

required

integer

集約間隔(秒)

time_mask

required

json

時間マスク設定

Array of objects (notificationDestination)

通知先情報

Array

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Array of objects (configMonlogLevel)

ログレベル情報

Array

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Response samples

200

Content type

application/json

[{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"distinations": [{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}
],
"levels": [{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}
]
}
]

通知ルール設定を新規登録

Request Body schema: application/json

name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	json 時間マスク設定
distination_ids required	Array of integers 通知先情報
levels required	Array of integers ログレベル情報

Responses

Response Schema: application/json

id

required

integer

通知先ID

name

required

string

通知ルール名

enable

required

boolean

通知ルール有効フラグ

interval

required

integer

集約間隔(秒)

time_mask

required

json

時間マスク設定

Array of objects (notificationDestination)

通知先情報

Array

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Array of objects (configMonlogLevel)

ログレベル情報

Array

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Request samples

Payload

Content type

application/json

{"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"distination_ids": [1,
2
],
"levels": [1,
2
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"distinations": [{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}
],
"levels": [{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}
]
}

通知ルール設定を更新

Request Body schema: application/json

id required	integer 通知ルールID
name required	string 通知ルール名
enable required	boolean 通知ルール有効フラグ
interval required	integer 集約間隔(秒)
time_mask required	json 時間マスク設定
distination_ids required	Array of integers 通知先情報
levels required	Array of integers ログレベル情報

Responses

Response Schema: application/json

id

required

integer

通知先ID

name

required

string

通知ルール名

enable

required

boolean

通知ルール有効フラグ

interval

required

integer

集約間隔(秒)

time_mask

required

json

時間マスク設定

Array of objects (notificationDestination)

通知先情報

Array

id required	integer 通知先ID
name required	string 通知先名
type required	integer 通知先タイプ (1=slack, 2=email)
tz required	string タイムゾーン
lang required	string 言語
detail required	json 通知先詳細

Array of objects (configMonlogLevel)

ログレベル情報

Array

level

required

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

color

required

string

カラーコード

name

required

string

監視ログレベル名

name_en

required

string

監視ログレベル名(英語)

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"distination_ids": [1,
2
],
"levels": [1,
2
]
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "通知ルール 1",
"enable": 1,
"interval": 1,
"time_mask": {"enable": true,
"resend": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"distinations": [{"id": 1,
"name": "Slack 1",
"type": 1,
"tz": "Asia/Tokyo",
"lang": "ja",
"detail": {"url": "https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxx",
"channel": "C04QJ70B2G6",
"username": "mediaharbor",
"iconEmoji": "",
"iconUrl": "",
"mention": "none"
}
}
],
"levels": [{"level": 6,
"color": "#F44336",
"name": "情報",
"name_en": "INFO"
}
]
}

通知ルール設定を削除

query Parameters

id

required

integer

通知ルールID

Responses

Mask

マスク関連

マスクルールを取得

マスクルール設定を取得

Responses

Response Schema: application/json

Array

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Response samples

200

Content type

application/json

[{"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}
]

マスクルール設定を新規登録

Request Body schema: application/json

name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log	json ログマスク設定
overlay	json オーバーレイマスク設定
cover	json 蓋マスク設定

Responses

Response Schema: application/json

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Request samples

Payload

Content type

application/json

{"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}

マスクルール設定を更新

Request Body schema: application/json

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Responses

Response Schema: application/json

id required	integer マスクルールID
name required	string マスクルール名
enable required	boolean マスクルール有効フラグ
log required	json ログマスク設定
overlay required	json オーバーレイマスク設定
cover required	json 蓋マスク設定

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}

Response samples

200

Content type

application/json

{"id": 1,
"name": "マスクルール 1",
"enable": 1,
"log": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"overlay": {"enable": true,
"tz": "Asia/Tokyo",
"time": [{"start": "22:50",
"duration": 10,
"dayOfWeek": [1,
2,
3,
4,
5
]
}
]
},
"cover": {"enable": true,
"img": "data:image/png;base64,AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"log": true,
"orverlay": true,
"silent": false
}
}

マスクルール設定を削除

query Parameters

id

required

integer

マスクルールID

Responses

Other

その他

カーソル選択

選択したソースの音が出る

Request Body schema: text/plain

string <uuid>

選択するソースIDのUUID

Responses

1画面拡大表示

指定したソースIDを拡大表示する。空を指定するとZoom解除

Request Body schema: text/plain

string <uuid>

拡大するソースIDのUUID文字列を指定。空でZoom解除。

Responses

残りポイント情報を取得

Responses

Response Schema: application/json

Array

id	string <uuid> WalletID
casthive_id	string <uuid> 組織ID
available_dates	number <float> 利用可能日数
point	number <float> 残りポイント数
pointType	any Enum: "MHP" "MHTP" "MONP" "MONTP" ポイント種別

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"casthive_id": "434b9872-024a-4aab-a019-2ea4b02b26e8",
"available_dates": 3347.63,
"point": 40171.54,
"pointType": "MHP"
}
]

サーバーステータスを取得

Responses

Response Schema: application/json

platform	string <string> プラットフォーム名
cpuCount	number <integer> CPUコア数
systemUptime	number <float> システム稼働時間
processUptime	number <float> プロセス稼働時間

Response samples

200

Content type

application/json

{"platform": "linux",
"cpuCount": 8,
"systemUptime": 7253930.68,
"processUptime": 3110.161115491
}

CPUステータスを取得

Responses

Response Schema: application/json

cpuCount	number <integer> CPUコア数
loadAvg	number <float> CPU負荷率
cpuUsage	number <float> CPU使用率

Response samples

200

Content type

application/json

{"cpuCount": 8,
"loadAvg": 5.03,
"cpuUsage": 0.4098360655737705
}

メモリーステータスを取得

Responses

Response Schema: application/json

totalMemory	number <float> メモリー総容量
freeMemory	number <float> メモリー空き容量
freeMemoryPercentage	number <float> メモリー空き容量率

Response samples

200

Content type

application/json

{"totalMemory": 15603.640625,
"freeMemory": 11087.9453125,
"freeMemoryPercentage": 0.7105998900496979
}

ストレージステータスを取得

Responses

Response Schema: application/json

total	number <integer> ストレージ総容量
free	number <integer> ストレージ空き容量
used	number <integer> ストレージ使用容量
usagePercent	number <float> ストレージ使用率

Response samples

200

Content type

application/json

{"total": 287886413824,
"free": 243327467520,
"used": 44558946304,
"usagePercent": 15.477960808265587
}

コンテナ情報を取得

Responses

Response Schema: application/json

Array

Id

string

Dockerコンテナの一意の識別子。

Created

string <date-time>

Dockerコンテナが作成されたタイムスタンプ。

Path

string

エントリポイントスクリプトへのパス。

Args

Array of strings

エントリポイントスクリプトに渡された引数。

object

Dockerコンテナの現在の状態。

Status	string コンテナの状態（例：running、pausedなど）。
Running	boolean コンテナが実行中であるかどうかを示します。
Paused	boolean コンテナが一時停止されているかどうかを示します。
Restarting	boolean コンテナが再起動中であるかどうかを示します。
OOMKilled	boolean コンテナがOOM（Out Of Memory）キルされたかどうかを示します。
Dead	boolean コンテナが死んでいるかどうかを示します。
Pid	integer コンテナのプロセスID。
ExitCode	integer コンテナの終了コード。
Error	string エラーメッセージ。
StartedAt	string <date-time> コンテナが開始されたタイムスタンプ。
FinishedAt	string <date-time> コンテナが終了したタイムスタンプ。

Image

string

DockerイメージのSHA256ハッシュ。

ResolvConfPath

string

resolv.confファイルへのパス。

HostnamePath

string

hostnameファイルへのパス。

HostsPath

string

hostsファイルへのパス。

LogPath

string

ログファイルへのパス。

Name

string

コンテナの名前。

RestartCount

integer

コンテナの再起動回数。

Driver

string

ストレージドライバーの種類。

Platform

string

プラットフォーム名。

MountLabel

string

マウントラベル。

ProcessLabel

string

プロセスラベル。

AppArmorProfile

string

AppArmorプロファイル。

ExecIDs

Array of strings

実行IDのリスト。

object

ホストの設定。

Binds

Array of strings

このコンテナのボリュームバインディングのリスト。

ContainerIDFile

string

コンテナIDを保存するファイルのパス。

object

ログの設定。

Type

string

ログのタイプ。

object

ログ設定の構成。

max-file	string 最大ファイル数。
max-size	string 最大ファイルサイズ。

NetworkMode

string

ネットワークモード。

object

ポートバインディングの設定。

Array of objects

Array

HostIp	string ホストのIPアドレス。
HostPort	string ホストのポート番号。

object

再起動ポリシーの設定。

Name	string 再起動ポリシーの名前。
MaximumRetryCount	integer 最大リトライ回数。

AutoRemove

boolean

コンテナが停止したときに自動的に削除するかどうか。

VolumeDriver

string

ボリュームドライバー。

VolumesFrom

Array of strings

他のコンテナからボリュームをマウントする設定。

ConsoleSize

Array of integers

コンソールのサイズ設定。

CapAdd

Array of strings

追加するケーパビリティのリスト。

CapDrop

Array of strings

削除するケーパビリティのリスト。

CgroupnsMode

string

cgroup名前空間モード。

Dns

Array of strings

DNSサーバのリスト。

DnsOptions

Array of strings

DNSオプションのリスト。

DnsSearch

Array of strings

DNS検索ドメインのリスト。

ExtraHosts

Array of strings

追加のホスト名とIPアドレスのマッピングのリスト。

GroupAdd

Array of strings

追加するグループのリスト。

IpcMode

string

IPCモード。

Cgroup

string

cgroupオプション。

Links

Array of strings

他のコンテナへのリンクのリスト。

OomScoreAdj

integer

OOMスコア調整値。

PidMode

string

PIDモード。

Privileged

boolean

特権モードで実行するかどうか。

PublishAllPorts

boolean

すべてのポートを公開するかどうか。

ReadonlyRootfs

boolean

読み取り専用のルートファイルシステムを使用するかどうか。

SecurityOpt

Array of strings

セキュリティオプションのリスト。

UTSMode

string

UTSモード。

UsernsMode

string

ユーザ名前空間モード。

ShmSize

integer

共有メモリのサイズ。

Runtime

string

ランタイム。

Isolation

string

アイソレーションモード。

CpuShares

integer

CPU共有の設定。

Memory

integer

メモリの制限。

NanoCpus

integer

NanoCPUsの設定。

CgroupParent

string

cgroup親の設定。

BlkioWeight

integer

ブロックI/Oのウェイト。

BlkioWeightDevice

Array of objects

ブロックI/Oウェイトデバイスのリスト。

BlkioDeviceReadBps

Array of objects

ブロックI/Oデバイスの読み取り速度（バイト/秒）のリスト。

BlkioDeviceWriteBps

Array of objects

ブロックI/Oデバイスの書き込み速度（バイト/秒）のリスト。

BlkioDeviceReadIOps

Array of objects

ブロックI/Oデバイスの読み取り速度（I/O操作/秒）のリスト。

BlkioDeviceWriteIOps

Array of objects

ブロックI/Oデバイスの書き込み速度（I/O操作/秒）のリスト。

CpuPeriod

integer

CPUの周期。

CpuQuota

integer

CPUクォータ。

CpuRealtimePeriod

integer

CPUリアルタイム周期。

CpuRealtimeRuntime

integer

CPUリアルタイムランタイム。

CpusetCpus

string

CPUセットのCPU。

CpusetMems

string

CPUセットのメモリ。

Devices

Array of objects

デバイスのリスト。

DeviceCgroupRules

Array of strings

デバイスcgroupルールのリスト。

DeviceRequests

Array of objects

デバイスリクエストのリスト。

MemoryReservation

integer

メモリの予約。

MemorySwap

integer

メモリのスワップ設定。

MemorySwappiness

integer

メモリのスワッピネス。

OomKillDisable

boolean

OOMキルを無効にするかどうか。

PidsLimit

integer

PIDの制限。

Ulimits

Array of objects

ulimitの設定。

CpuCount

integer

CPUの数。

CpuPercent

integer

CPUのパーセンテージ。

IOMaximumIOps

integer

最大I/O操作数。

IOMaximumBandwidth

integer

最大バンド幅。

MaskedPaths

Array of strings

マスクされたパスのリスト。

ReadonlyPaths

Array of strings

読み取り専用のパスのリスト。

object

グラフドライバーのデータ。

object

グラフドライバーのデータ。

LowerDir	string LowerDirのパス。
MergedDir	string MergedDirのパス。
UpperDir	string UpperDirのパス。
WorkDir	string WorkDirのパス。

Name

string

グラフドライバーの名前。

Array of objects

マウントのリスト。

Array

Type

string

マウントタイプ（例：bind、volume、tmpfs）。

Source

string

マウントのソースパス。

Destination

string

マウントの宛先パス。

Mode

string

マウントモード（例：ro、rw）。

RW

boolean

マウントが読み書き可能かどうかを示します。

Propagation

string

マウントの伝播モード。

object

コンテナの設定。

Hostname

string

コンテナのホスト名。

Domainname

string

コンテナのドメイン名。

User

string

コンテナのユーザー名。

AttachStdin

boolean

標準入力をアタッチするかどうか。

AttachStdout

boolean

標準出力をアタッチするかどうか。

AttachStderr

boolean

標準エラーをアタッチするかどうか。

object

公開ポートの設定。

3306/tcp

object

TCPポート3306の設定。

Tty

boolean

TTYを使用するかどうか。

OpenStdin

boolean

標準入力を開くかどうか。

StdinOnce

boolean

標準入力を一度だけ開くかどうか。

Env

Array of strings

環境変数のリスト。

Cmd

Array of strings

コンテナのコマンド。

Image

string

コンテナのイメージ。

object

ボリュームの設定。

/etc/mysql/conf.d/my.cnf	object my.cnfの設定。
/var/lib/mysql	object MySQLのデータディレクトリの設定。

WorkingDir

string

コンテナの作業ディレクトリ。

Entrypoint

Array of strings

コンテナのエントリーポイント。

OnBuild

Array of strings

ONBUILDイベントのリスト。

object

コンテナのラベル。

com.docker.compose.config-hash	string Docker Composeの設定ハッシュ。
com.docker.compose.container-number	string Docker Composeのコンテナ番号。
com.docker.compose.depends_on	string 依存する他のサービス。
com.docker.compose.image	string コンテナのイメージのSHA256ハッシュ。
com.docker.compose.oneoff	string 一回限りのタスクかどうか。
com.docker.compose.project	string Docker Composeプロジェクトの名前。
com.docker.compose.project.config_files	string Docker Composeの設定ファイルのリスト。
com.docker.compose.project.working_dir	string Docker Composeの作業ディレクトリ。
com.docker.compose.service	string Docker Composeのサービス名。
com.docker.compose.version	string Docker Composeのバージョン。
org.opencontainers.image.authors	string イメージの作成者。
org.opencontainers.image.base.name	string ベースイメージの名前。
org.opencontainers.image.description	string イメージの説明。
org.opencontainers.image.documentation	string イメージのドキュメンテーションURL。
org.opencontainers.image.licenses	string イメージのライセンス。
org.opencontainers.image.ref.name	string イメージのリファレンス名。
org.opencontainers.image.source	string イメージのソースURL。
org.opencontainers.image.title	string イメージのタイトル。
org.opencontainers.image.url	string イメージのURL。
org.opencontainers.image.vendor	string イメージのベンダー。
org.opencontainers.image.version	string イメージのバージョン。

object

ネットワークの設定。

Bridge

string

ブリッジネットワークの名前。

SandboxID

string

サンドボックスID。

HairpinMode

boolean

ヘアピンモード。

LinkLocalIPv6Address

string

リンクローカルIPv6アドレス。

LinkLocalIPv6PrefixLen

integer

リンクローカルIPv6プレフィックス長。

object

ポートの設定。

3306/tcp

Array of objects

TCPポート3306の設定。

SandboxKey

string

サンドボックスキー。

SecondaryIPAddresses

Array of strings

2次IPアドレスのリスト。

SecondaryIPv6Addresses

Array of strings

2次IPv6アドレスのリスト。

EndpointID

string

エンドポイントID。

Gateway

string

ゲートウェイ。

GlobalIPv6Address

string

グローバルIPv6アドレス。

GlobalIPv6PrefixLen

integer

グローバルIPv6プレフィックス長。

IPAddress

string

IPアドレス。

IPPrefixLen

integer

IPプレフィックス長。

IPv6Gateway

string

IPv6ゲートウェイ。

MacAddress

string

MACアドレス。

object

ネットワークの設定。

object

mediaharborfrontend_defaultネットワークの設定。

IPAMConfig	object IPAM設定。
Links	Array of strings リンクのリスト。
Aliases	Array of strings エイリアスのリスト。
NetworkID	string ネットワークID。
EndpointID	string エンドポイントID。
Gateway	string ゲートウェイ。
IPAddress	string IPアドレス。
IPPrefixLen	integer IPプレフィックス長。
IPv6Gateway	string IPv6ゲートウェイ。
GlobalIPv6Address	string グローバルIPv6アドレス。
GlobalIPv6PrefixLen	integer グローバルIPv6プレフィックス長。
MacAddress	string MACアドレス。
DriverOpts	object ドライバーオプション。

Response samples

200

Content type

application/json

[{"Id": "fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35",
"Created": "2023-10-17T08:00:22.511511709Z",
"Path": "docker-entrypoint.sh",
"Args": ["mariadbd"
],
"State": {"Status": "running",
"Running": true,
"Paused": false,
"Restarting": false,
"OOMKilled": false,
"Dead": false,
"Pid": 1496904,
"ExitCode": 0,
"Error": "",
"StartedAt": "2023-10-17T08:00:23.128832275Z",
"FinishedAt": "0001-01-01T00:00:00Z"
},
"Image": "sha256:871a9153c1842e3b480cb1be691c64151bc96a5de2cc8039470d31e32ff0a177",
"ResolvConfPath": "/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/resolv.conf",
"HostnamePath": "/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/hostname",
"HostsPath": "/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/hosts",
"LogPath": "/home/docker/containers/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35/fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35-json.log",
"Name": "/db",
"RestartCount": 0,
"Driver": "overlay2",
"Platform": "linux",
"MountLabel": "",
"ProcessLabel": "",
"AppArmorProfile": "",
"ExecIDs": null,
"HostConfig": {"Binds": ["/var/samba/public/MediaHarborFrontend/DB/data:/var/lib/mysql:rw",
"/var/samba/public/MediaHarborFrontend/conf/DB/my.cnf:/etc/mysql/conf.d/my.cnf:rw"
],
"ContainerIDFile": "",
"LogConfig": {"Type": "json-file",
"Config": {"max-file": "3",
"max-size": "1M"
}
},
"NetworkMode": "mediaharborfrontend_default",
"PortBindings": {"3306/tcp": [{"HostIp": "",
"HostPort": "3306"
}
]
},
"RestartPolicy": {"Name": "always",
"MaximumRetryCount": 0
},
"AutoRemove": false,
"VolumeDriver": "",
"VolumesFrom": null,
"ConsoleSize": [0,
0
],
"CapAdd": null,
"CapDrop": null,
"CgroupnsMode": "host",
"Dns": null,
"DnsOptions": null,
"DnsSearch": null,
"ExtraHosts": [ ],
"GroupAdd": null,
"IpcMode": "private",
"Cgroup": "",
"Links": null,
"OomScoreAdj": 0,
"PidMode": "",
"Privileged": false,
"PublishAllPorts": false,
"ReadonlyRootfs": false,
"SecurityOpt": null,
"UTSMode": "",
"UsernsMode": "",
"ShmSize": 67108864,
"Runtime": "runc",
"Isolation": "",
"CpuShares": 0,
"Memory": 0,
"NanoCpus": 0,
"CgroupParent": "",
"BlkioWeight": 0,
"BlkioWeightDevice": null,
"BlkioDeviceReadBps": null,
"BlkioDeviceWriteBps": null,
"BlkioDeviceReadIOps": null,
"BlkioDeviceWriteIOps": null,
"CpuPeriod": 0,
"CpuQuota": 0,
"CpuRealtimePeriod": 0,
"CpuRealtimeRuntime": 0,
"CpusetCpus": "",
"CpusetMems": "",
"Devices": null,
"DeviceCgroupRules": null,
"DeviceRequests": null,
"MemoryReservation": 0,
"MemorySwap": 0,
"MemorySwappiness": null,
"OomKillDisable": false,
"PidsLimit": null,
"Ulimits": null,
"CpuCount": 0,
"CpuPercent": 0,
"IOMaximumIOps": 0,
"IOMaximumBandwidth": 0,
"MaskedPaths": ["/proc/asound",
"/proc/acpi",
"/proc/kcore",
"/proc/keys",
"/proc/latency_stats",
"/proc/timer_list",
"/proc/timer_stats",
"/proc/sched_debug",
"/proc/scsi",
"/sys/firmware"
],
"ReadonlyPaths": ["/proc/bus",
"/proc/fs",
"/proc/irq",
"/proc/sys",
"/proc/sysrq-trigger"
]
},
"GraphDriver": {"Data": {"LowerDir": "/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c-init/diff:/home/docker/overlay2/180ea9e2448689419cb3ffa2b4fb48c18676d0fa4529982a8bf04f1193fe3f96/diff:/home/docker/overlay2/de5921af205703308a71cda4b33225a81f5de21002310ac80f962c031c9e84fb/diff:/home/docker/overlay2/8e6f007f5af6742863aff11a0c4f69a2cb963fbf932f0e2a3b9411c48bec9c85/diff:/home/docker/overlay2/b72fb5eb7e785933c03c6f9329948778b89dd663d2dff2c766b53ae97da606ec/diff:/home/docker/overlay2/feff8433af2fee0f948b69308832c49fea9f6612dc08717b410a1bfee6004667/diff:/home/docker/overlay2/93bb59e59c6a58b8844bee5c5b9c130cb5f7502707553a84a0b0ff848c4bfddf/diff:/home/docker/overlay2/1515191def9e1afb6d97623752cd731c448b6f3a9f21585d89c6775f6f6a7892/diff:/home/docker/overlay2/17ee2e88fef4ec08a2268963f63f9f975a839b0afb5d9bef184146113481a73e/diff",
"MergedDir": "/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c/merged",
"UpperDir": "/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c/diff",
"WorkDir": "/home/docker/overlay2/42049b9ec79ebac120e47656d64f5cec23aca29e692c39c769e4b8f89f25560c/work"
},
"Name": "overlay2"
},
"Mounts": [{"Type": "bind",
"Source": "/var/samba/public/MediaHarborFrontend/DB/data",
"Destination": "/var/lib/mysql",
"Mode": "rw",
"RW": true,
"Propagation": "rprivate",
"Config": {"Hostname": "fd8b7d18b8fe",
"Domainname": "",
"User": "",
"AttachStdin": false,
"AttachStdout": true,
"AttachStderr": true,
"ExposedPorts": {"3306/tcp": { }
},
"Tty": false,
"OpenStdin": false,
"StdinOnce": false,
"Env": ["MARIADB_ROOT_PASSWORD_HASH=*7932903C4D7035C6CB4F5FE4CD267A9F1D7F39C9",
"MARIADB_DATABASE=mediaharbor",
"MARIADB_USER=mediaharbor",
"MARIADB_PASSWORD_HASH=*98862F42AC6125B3B646E116DD3DB4FB5252A6AA",
"MARIADB_HOST=%",
"TZ=\"Asia/Tokyo\"",
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
"GOSU_VERSION=1.14",
"LANG=C.UTF-8",
"MARIADB_VERSION=1:11.1.2+maria~ubu2204"
],
"Cmd": ["mariadbd"
],
"Image": "mariadb:11",
"Volumes": {"/etc/mysql/conf.d/my.cnf": { },
"/var/lib/mysql": { }
},
"WorkingDir": "",
"Entrypoint": ["docker-entrypoint.sh"
],
"OnBuild": null,
"Labels": {"com.docker.compose.config-hash": "1d7fbc5756c5ff6a0460c6c22e93a597044096b5f2da23ff1c9fe672e371e30b",
"com.docker.compose.container-number": "1",
"com.docker.compose.depends_on": "",
"com.docker.compose.image": "sha256:871a9153c1842e3b480cb1be691c64151bc96a5de2cc8039470d31e32ff0a177",
"com.docker.compose.oneoff": "False",
"com.docker.compose.project": "mediaharborfrontend",
"com.docker.compose.project.config_files": "/var/samba/public/MediaHarborFrontend/docker-compose.yml",
"com.docker.compose.project.working_dir": "/var/samba/public/MediaHarborFrontend",
"com.docker.compose.service": "db",
"com.docker.compose.version": "2.12.2",
"org.opencontainers.image.authors": "MariaDB Community",
"org.opencontainers.image.base.name": "docker.io/library/ubuntu:jammy",
"org.opencontainers.image.description": "MariaDB Database for relational SQL",
"org.opencontainers.image.documentation": "https://hub.docker.com/_/mariadb/",
"org.opencontainers.image.licenses": "GPL-2.0",
"org.opencontainers.image.ref.name": "ubuntu",
"org.opencontainers.image.source": "https://github.com/MariaDB/mariadb-docker",
"org.opencontainers.image.title": "MariaDB Database",
"org.opencontainers.image.url": "https://github.com/MariaDB/mariadb-docker",
"org.opencontainers.image.vendor": "MariaDB Community",
"org.opencontainers.image.version": "11.1.2"
}
},
"NetworkSettings": {"Bridge": "",
"SandboxID": "dab8c333826eef62a5c6887206697b0bd40208350b58724a55cbeaf55c161a75",
"HairpinMode": false,
"LinkLocalIPv6Address": "",
"LinkLocalIPv6PrefixLen": 0,
"Ports": {"3306/tcp": [{"HostIp": "0.0.0.0",
"HostPort": "3306"
},
{"HostIp": "::",
"HostPort": "3306"
}
]
},
"SandboxKey": "/var/run/docker/netns/dab8c333826e",
"SecondaryIPAddresses": null,
"SecondaryIPv6Addresses": null,
"EndpointID": "",
"Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"IPAddress": "",
"IPPrefixLen": 0,
"IPv6Gateway": "",
"MacAddress": "",
"Networks": {"mediaharborfrontend_default": {"IPAMConfig": null,
"Links": null,
"Aliases": ["db",
"db",
"fd8b7d18b8fe"
],
"NetworkID": "e3f1da74b58bb32ba05a58306eb342c8f161025e13d117a5628b196b7a450d00",
"EndpointID": "3d39b3eeee4be7872fb3847766022d8110e37d00a45895c356a8c520314a8c95",
"Gateway": "172.31.0.1",
"IPAddress": "172.31.0.4",
"IPPrefixLen": 16,
"IPv6Gateway": "",
"GlobalIPv6Address": "",
"GlobalIPv6PrefixLen": 0,
"MacAddress": "02:42:ac:1f:00:04",
"DriverOpts": null
}
}
}
}
]
}
]

コンテナログを取得

query Parameters

id

required

string <string>

Example: id=fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35

コンテナID

Responses

Response Schema: text/plain

Array

string <string>

ログ

コンテナログをダウンロード

query Parameters

id

required

string <string>

Example: id=fd8b7d18b8fe98e243faa5d7912e65af5969393629a0387c9bd52a9b80e36b35

コンテナID

Responses

Response Schema: text/plain

string <binary>

ログ

Log

監視ログを取得

指定したタイプの監視ログを取得
指定が無い場合は全て取得

query Parameters

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

※未指定時は全て

level

Array of integers

Example: level=0&level=1&level=2

ログレベル
複数指定可能で指定した値のレベルのログが取得される
※未指定時は0~6のログが取得

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

qty

string

Example: qty=100

取得件数
※未指定時は100件

offset

string

取得開始位置
続きを取る時にオフセットを指定する。
指定したオフセット値から取得される。
※未指定時は0から取得

from

date

Example: from=2019-08-24T14:15:22Z

取得開始日時
※未指定時は全て

to

date

Example: to=2019-08-24T14:15:22Z

取得終了日時
※未指定時は全て

query

string

Example: query=freeze

ソース名、メッセージでキーワード検索
※未指定時は全て

order

string

Example: order=asc

取得方向
asc=昇順
desc=降順
※未指定時はdesc

Responses

Response Schema: application/json

total

integer <int64>

全ログ数

Array of objects

ログ一覧

Array

id

integer <int64>

ID

date

string <date-time>

監視日時

source_id

string <uuid>

ソースID

log_id

string^[0-9a-fA-F]{8}$

ログID

object

ソース情報

name	string ソース名
protocol_type_id	integer プロトコルタイプID(1=srt, 2=file, 3=rtp, 4=hls, 5=streamlink, 6=colorbar, 7=browser, 8=zixi, 9=rist, 10=ndi, 11=st2110, 12=rtmp, 13=aes67)

object

詳細情報

type

string

Enum: "SYS" "MON" "VA" "SCTE35" "TS"

ログタイプ

ログタイプ	値	ログIDの上4桁
システム	SYS	0000～000F
監視全般	MON	0010～001F
画音監視	VA	0020～002F
SCTE35監視	SCTE35	0030～003F
TS監視	TS	0040～004F

level

integer

ログレベル

値	レベル	説明
0	DEBUG	デバッグ用
1	EMERG	システムが使用不可能
2	ALERT	直ちに対応が必要
3	CRIT	システムの部分的な障害
4	ERR	運用上のエラー
5	WARNING	警告メッセージ
6	NOTICE	動作には問題無いけど注意が必要
7	INFO	情報メッセージ

message

string

ログメッセージ

message_en

string

ログメッセージ(英語)

jsondata

string

JSONデータ

Response samples

200

Content type

application/json

{"total": 0,
"logs": [{"id": 0,
"date": "2019-08-24T14:15:22Z",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"log_id": "00200201",
"source": {"name": "string",
"protocol_type_id": 1
},
"details": {"type": "VA",
"level": 3,
"message": "フリーズを検出しました",
"message_en": "Freeze detected"
},
"jsondata": "{\"sid\": 1,\"last_updated_ms\": 1710856298571,\"last_updated_date\": \"2024/03/19 13:51:38\",\"video\": {\"freeze\": {\"is_occuring\": true,\"last_updated_ms\": 1710856298168,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"black\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"img_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"action_trigger\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"audio\": {\"silent\": {\"is_occuring\": false,\"last_updated_ms\": 1710856298569,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"port\": \"50001\"}"
}
]
}

監視ログを登録

監視ログを登録する。

Request Body schema: application/json

date	string <date-time> ログ日時 ※未指定の場合は現在日時が入る
source_id	string <uuid> ソースID
log_id required	string^[0-9a-fA-F]{8}$ ログID
jsondata	string JSONデータ

Responses

Request samples

Payload

Content type

application/json

{"date": "2019-08-24T14:15:22Z",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"log_id": "00200201",
"jsondata": "{\"sid\": 1,\"last_updated_ms\": 1710856298571,\"last_updated_date\": \"2024/03/19 13:51:38\",\"video\": {\"freeze\": {\"is_occuring\": true,\"last_updated_ms\": 1710856298168,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"black\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"img_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"},\"action_trigger\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"audio\": {\"silent\": {\"is_occuring\": false,\"last_updated_ms\": 1710856298569,\"last_updated_date\": \"2024/03/19 13:51:38\"},\"time_mask\": {\"is_occuring\": false,\"last_updated_ms\": 1710855881382,\"last_updated_date\": \"2024/03/19 13:44:41\"}},\"port\": \"50001\"}"
}