同時配信プラットフォームリストの照会

Classic/VPC環境で利用できます。

同時配信チャンネルに設定されたプラットフォームリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v2/re-stream/channels/{channelId}/platforms

リクエストヘッダ

Live Station APIで共通して使用されるヘッダの詳細は、Live Stationのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`channelId`	String	Required	チャンネル ID チャンネルリストの照会を参照

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/re-stream/channels/ls-20250819******-Ik1QU/platforms' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`content`	Array	-	同時配信プラットフォームリスト: content

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`targetName`	String	-	同時配信プラットフォーム名
`rtmpUrl`	String	-	同時配信プラットフォーム RTMP URL
`id`	String	-	RTMP認証 ID 認証情報設定時に表示
`password`	String	-	RTMP認証のパスワード認証情報設定時に表示先頭文字を除く文字列はマスキング処理
`streamKey`	String	-	ストリームキー
`connectStatus`	String	-	同時配信の状態 `CONNECTING` \| `PUBLISHING` \| `READY` \| `FAIL` `CONNECTING`: 接続試行中 `PUBLISHING`: 同時配信(Re-Stream)中 `READY`: 接続待ち `FAIL`: 同時配信(Re-Stream)失敗
`platId`	Integer	-	同時配信プラットフォーム ID
`bytesPerSecond`	Integer	-	1秒当たりの転送量(Byte)
`totalRetryCount`	Integer	-	累計再アクセス試行数
`bytesTotalTrans`	Integer	-	累計転送量(Byte)
`totalPlaySecond`	Integer	-	累計配信時間(秒)

レスポンスステータスコード

Live Station APIで共通して使用されるレスポンスステータスコードの詳細は、Live Stationのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "content": [
        {
            "targetName": "YOUTUBE",
            "rtmpUrl": "rtmp://rtmp-test.youtube.com",
            "id": "user000",
            "password": "d*****",
            "streamKey": "****-****-****-****-****",
            "connectStatus": "PUBLISHING",
            "platId": 3699,
            "bytesPerSecond": 1100832,
            "totalRetryCount": 0,
            "bytesTotalTrans": 85222049,
            "totalPlaySecond": 0
        },
        {
            "targetName": "PRISM",
            "rtmpUrl": "rtmp://abc.prism.com",
            "id": "user001",
            "password": "d*****",
            "streamKey": "****-****-****-****-****",
            "connectStatus": "PUBLISHING",
            "platId": 3700,
            "bytesPerSecond": 1100832,
            "totalRetryCount": 0,
            "bytesTotalTrans": 85222049,
            "totalPlaySecond": 0
        }
    ]
}