チャンネルイベントの照会

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

チャンネルで発生したイベントを照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/channels/{channelId}/events

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSizeNo`	Integer	Optional	ページごとの項目数 1~N (デフォルト: 20)

リクエスト例

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

curl --location --request GET 'https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20250821095732-*******/events' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Array	-	チャンネルイベントリスト: content
`total`	Integer	-	レスポンス総数

`content`

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

フィールド	タイプ	必須の有無	説明
`time`	Integer	-	イベント発生日時(秒) Unix Timestamp形式
`actionType`	String	-	イベント動作タイプ `CREATE` \| `START` \| `STOP` \| `DELETE` `CREATE`: チャンネル作成 `START`: チャンネル開始 `STOP`: チャンネル停止 `DELETE`: チャンネル削除
`requestType`	String	-	イベント動作(action)リクエストタイプ `MC` \| `API` \| `MCC` `MC`: コンソール `API`: Open API `MCC`: Media Connect Center
`resultCode`	String	-	イベント動作(action)は成功したか `SUCCESS` \| `FAILED` `SUCCESS`: 成功 `FAILED`: 失敗
`messageCode`	String	-	イベントのメッセージコード
`message`	String	-	イベントの詳細メッセージ

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

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

レスポンス例

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

{
    "content": [
        {
            "time": 1755758700,
            "actionType": "START",
            "requestType": "API",
            "resultCode": "SUCCESS",
            "messageCode": "CHANNEL_START_TO_READY",
            "message": "ch-media-encrypt ready"
        },
        {
            "time": 1755758665,
            "actionType": "START",
            "requestType": "API",
            "resultCode": "SUCCESS",
            "messageCode": "CHANNEL_STOPPED_TO_STARTING",
            "message": "ch-media-encrypt starting"
        },
        {
            "time": 1755757440,
            "actionType": "STOP",
            "requestType": "MC",
            "resultCode": "SUCCESS",
            "messageCode": "CHANNEL_STOPPING_TO_STOPPED",
            "message": "ch-media-encrypt stopped"
        },
        {
            "time": 1755757435,
            "actionType": "STOP",
            "requestType": "MC",
            "resultCode": "SUCCESS",
            "messageCode": "CHANNEL_READY_TO_STOPPING",
            "message": "ch-media-encrypt stopping"
        },
        {
            "time": 1755737880,
            "actionType": "CREATE",
            "requestType": "API",
            "resultCode": "SUCCESS",
            "messageCode": "CHANNEL_READY",
            "message": "ch-media-encrypt ready"
        },
        {
            "time": 1755737852,
            "actionType": "CREATE",
            "requestType": "API",
            "resultCode": "SUCCESS",
            "messageCode": "CHANNEL_CREATING",
            "message": "ch-media-encrypt creating"
        }
    ],
    "total": 6
}