Queues

Provider, Media Router, Transcoder, Publisher 구간에 존재하는 Packet/Frame 타입의 큐의 상태를 모니터링 할 수 있는 API를 제공합니다.

Queues 상태 조회

Request

GET /v2/internals/queues

Header

Authorization: Basic {credentials}

# Authorization
    Credentials for HTTP Basic Authentication created with <AccessToken>

Responses

200 Ok

The request has succeeded

Header

Content-Type: application/json

Body

{
    "message": "OK",
    "response": [
        {
            "avgWaitingTime": 13,
            "drop": 0,
            "id": 100,
            "inputPerSecond": 154,
            "outputPerSecond": 153,
            "peak": 15,
            "size": 1,
            "threshold": 1000,
            "type": "std::shared_ptr<MediaRouteStream>",
            "urn": "mngq:v=#default#app:p=imr:n=aw_0"
        },
        {
            "avgWaitingTime": 31,
            "drop": 0,
            "id": 101,
            "inputPerSecond": 472,
            "outputPerSecond": 472,
            "peak": 74,
            "size": 1,
            "threshold": 1000,
            "type": "std::shared_ptr<MediaRouteStream>",
            "urn": "mngq:v=#default#app:p=omr:n=aw_0"
        },
        {
            "avgWaitingTime": 3,
            "drop": 0,
            "id": 102,
            "inputPerSecond": 467,
            "outputPerSecond": 467,
            "peak": 43,
            "size": 1,
            "threshold": 500,
            "type": "std::shared_ptr<pub::ApplicationWorker::StreamData>",
            "urn": "mngq:v=#default#app:p=pub:n=aw-webrtc0"
        },
        {
            "avgWaitingTime": 4,
            "drop": 0,
            "id": 103,
            "inputPerSecond": 476,
            "outputPerSecond": 476,
            "peak": 44,
            "size": 1,
            "threshold": 500,
            "type": "std::shared_ptr<pub::ApplicationWorker::StreamData>",
            "urn": "mngq:v=#default#app:p=pub:n=aw-llhls0"
        },
        {
            "avgWaitingTime": 3,
            "drop": 0,
            "id": 104,
            "inputPerSecond": 467,
            "outputPerSecond": 467,
            "peak": 43,
            "size": 1,
            "threshold": 500,
            "type": "std::shared_ptr<pub::ApplicationWorker::StreamData>",
            "urn": "mngq:v=#default#app:p=pub:n=aw-ovt0"
        },
        ...
    ]
}

401 Unauthorized

Authentication required

Header

WWW-Authenticate: Basic realm=”OvenMediaEngine”

Body

{
    "message": "[HTTP] Authorization header is required to call API (401)",
    "statusCode": 401
}

Element

Element	Description
avgWaitingTime	평균 대기 시간입니다.
drop	드롭된 메시지의 수입니다.
id	고유 식별자입니다.
inputPerSecond	초당 입력 메시지의 수입니다.
outputPerSecond	초당 출력 메시지의 수입니다.
peak	도달했던 최대 메시지 수입니다.
size	현재 메시지의 수입니다.
threshold	메시지 수의 제한 임계값입니다.
type	데이터의 유형(타입)입니다.
urn	URN(Uniform Resource Name) 형식의 명명 규칙입니다.

큐 리소스 네이밍 (URN) 규격

[URN Pattern]
	- mngq:v={VhostName}#{AppName}[s=/{StreamName}]:p={PART}:r={ROLE}
[PART]
	- pvd: provider
	- imr: mediarouter(inbound)
	- trs: transcoder
	- omr: mediarouter(outbound)
	- pub: publisher
[ROLE]
	- filter_{video|audio}
	- encoder_{codec_name}_{trackid}
	- decoder_{codec_name}_{trackid}
	- appworker_[{protocol}]_{id}
	- stremworker_[{protocol}]_{id}
	
<Examples>
	- mngq:v=#default#app:s=stream:p=trs:r=decoer_h264_0
	- mngq:v=#default#app:s=stream:p=trs:r=filter_video
	- mngq:v=#default#app:s=stream:p=trs:r=filter_audio
	- mngq:v=#default#app:s=stream:p=trs:r=encoder_opus_0
	- mngq:v=#default#app:s=stream:p=trs:r=encoder_h264_1
	- mngq:v=#default#app:p=imr:r=indicator
	- mngq:v=#default#app:p=omr:r=appworker