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

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VOD Stationは、チャンネルで発生したイベントを照会するための APIを提供します。

リクエスト

GET https://vodstation.apigw.ntruss.com/api/v2/channels/{channelId}/events

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
pageNo	No	Integer		- リクエストするページ番号総ページ番号は total/pageSizeNo
pageSizeNo	No	Integer		ページごとのイベント数

チャンネルのイベントをページに分けて照会する

例: 発生したイベントが30個であれば、ページごとに10個ずつ表示されるようにイベントリストを照会

GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=1&pageSizeNo=10
-> 計30個のイベントをページごとに10個単位でリクエストし、最初のページをリクエスト

GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=2&pageSizeNo=10
-> 計30個のイベントをページごとに10個単位でリクエストし、2番目のページをリクエスト

GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events?pageNo=3&pageSizeNo=10
-> 計30個のイベントをページごとに10個単位でリクエストし、3番目のページをリクエスト

リクエストヘッダ

ヘッダ名	説明
x-ncp-region_code	NAVERクラウドプラットフォームの region code `x-ncp_region_code:{Region Code}`
x-ncp-apigw-timestamp	1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	NAVERクラウドプラットフォームポータルで発行された Access Key ID値 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`

レスポンス

フィールド名	タイプ	説明	備考
content[]	Array	VOD Station OPEN APIレスポンスオブジェクト
content[].time	String	イベントの発生時間
content[].actionType	Object	イベントの動作タイプ	CREATE, START, STOP, DELETE
content[].requestType	Integer	actionを誘発したリクエストタイプ	MC(Console), API(OPENAPI), MCC(Media Connect Center)
content[].resultCode	String	actionの成否	SUCCESS, FAILED
content[].messageCode	String	イベントのメッセージコード
content[].message	Array	イベントの詳細メッセージ
total	Integer	チャンネルで発生したイベントの総数
error	Object	エラーレスポンスコードとメッセージ
error.errorCode	String	エラーレスポンスコード
error.message	String	エラーレスポンスメッセージ
error.details	String	error messageの詳細説明。api gatewayエラー発生時のレスポンス。

例

リクエスト例

GET https://vodstation.apigw.ntruss.com/api/v2/channels/vs-20191227055342-vDVWH5l/events

GET /api/v2/channels/vs-20191227055342-vDVWH5l/events
HOST: vodstation.apigw.ntruss.com
x-ncp-region_code:KR
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": [
    {
      "time": 1577426040,
      "actionType": "CREATE",
      "requestType": "API",
      "resultCode": "SUCCESS",
      "messageCode": "CHANNEL_READY",
      "message": "api-guide ready"
    },
    {
      "time": 1577426022,
      "actionType": "CREATE",
      "requestType": "API",
      "resultCode": "SUCCESS",
      "messageCode": "CHANNEL_CREATING",
      "message": "api-guide creating"
    }
  ],
  "total": 2
}

この記事は役に立ちましたか?

What's Next

プロトコルリストの照会

リクエスト
レスポンス
例

タグ

VOD Station