チャンネルリストの照会

印刷する
共有
PDF

記事の要約

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

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

Live Stationで作成したすべての Re-Streamチャンネルのリストを照会する APIです。

リクエスト

GET https://livestation.apigw.ntruss.com/api/v2/re-stream/channels?pageNo={pageNo}&pageSizeNo={pageSizeNo}

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
pageNo	No	Integer	制約なし	照会するページインデックス
pageSizeNo	No	Integer	1 ~ 100	- リストの照会時に含まれるチャンネル数例) 作成されたチャンネルが60個の時、pageSize=1、pageSizeNo 30の場合、ページごとに30個ずつチャンネルリストを照会

リクエストヘッダ

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

レスポンス

フィールド名	タイプ	説明	備考
channelId	String
channelName	String
instanceNo	Integer
channelStatus	String	CREATING, READY, PUBLISH, DELETED, BLOCK, FORCE_BLOCK, FORCE_DELETED
createdTime	Integer
publishUrl	String
globalPublishUrl	String		海外配信対応のための URL
streamKey	String
planType	String	STANDARD, PROFESSIONAL
platformCount	Integer
totalPublishSeconds	Integer
recentPublishStartTime	Integer
alertOn	Boolean		if alertOn == true, alertOptions should be set
alertOptions	Object
alertOptions.alertChangeStatus	Boolean
alertOptions.alertVodUploadFail	Boolean
alertOptions.alertReStreamFail	Boolean
isPublishing	Boolean
envType	String	DEV, STAGE, REAL
callbackEndpoint	String

例

リクエスト例

GET /api/v2/re-stream/channels?pageNo=1&pageSizeNo=5
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1621247953566
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Mon, 17 May 2021 10:39:13 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

{
  "content": [
    {
      "channelId": "ls-20210303183939-FPl57",
      "channelName": "mychannel1",
      "instanceNo": 1636923,
      "channelStatus": "READY",
      "streamKey": "sghkubvlihljzs1hcpnr9afcn8vyfx0j",
      "publishUrl": "rtmp://live-station-rtmp-url",
      "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
      "planType": "STANDARD",
      "createdTime": 1614764380000,
      "platformCount": 1,
      "totalPublishSeconds": 0,
      "alertOn": false,
      "isPublishing": false,
      "alertOptions": {
        "alertChangeStatus": false,
        "alertVodUploadFail": false,
        "alertReStreamFail": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "STAGE"
    },
    {
      "channelId": "ls-20210303182116-Xfv8C",
      "channelName": "mychannel2",
      "instanceNo": 1636821,
      "channelStatus": "READY",
      "streamKey": "kiwybf3fehttq31qks2anafc965oogyf",
      "publishUrl": "rtmp://live-station-rtmp-url",
      "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
      "planType": "STANDARD",
      "createdTime": 1614763276000,
      "platformCount": 2,
      "totalPublishSeconds": 0,
      "alertOn": false,
      "isPublishing": false,
      "alertOptions": {
        "alertChangeStatus": false,
        "alertVodUploadFail": false,
        "alertReStreamFail": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "REAL"
    },
    {
      "channelId": "ls-20210302104436-GtJw5",
      "channelName": "mychannnel3",
      "instanceNo": 1632553,
      "channelStatus": "READY",
      "streamKey": "bnvcvgyxyc1asu77fihv6ae7wz3j897c",
      "publishUrl": "rtmp://live-station-rtmp-url",
      "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
      "planType": "STANDARD",
      "createdTime": 1614649476000,
      "platformCount": 1,
      "totalPublishSeconds": 0,
      "alertOn": false,
      "isPublishing": false,
      "alertOptions": {
        "alertChangeStatus": false,
        "alertVodUploadFail": false,
        "alertReStreamFail": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "REAL"
    },
    {
      "channelId": "ls-20210302104256-gk927",
      "channelName": "mychannel4",
      "instanceNo": 1632552,
      "channelStatus": "READY",
      "streamKey": "ejn5jpuc3g2yvq1thn3z9ae7vp093ndg",
      "publishUrl": "rtmp://live-station-rtmp-url",
      "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
      "planType": "STANDARD",
      "createdTime": 1614649376000,
      "platformCount": 1,
      "totalPublishSeconds": 0,
      "alertOn": false,
      "isPublishing": false,
      "alertOptions": {
        "alertChangeStatus": false,
        "alertVodUploadFail": false,
        "alertReStreamFail": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "REAL"
    },
    {
      "channelId": "ls-20210225185132-FxGSn",
      "channelName": "mychannel5",
      "instanceNo": 1627140,
      "channelStatus": "READY",
      "streamKey": "7xtotpxpkjnyhmjbe7k7jaa952q6lmhl",
      "publishUrl": "rtmp://live-station-rtmp-url",
      "globalPublishUrl": "rtmp://live-station-rtmp-global-url",
      "planType": "STANDARD",
      "createdTime": 1614246692000,
      "platformCount": 1,
      "totalPublishSeconds": 0,
      "alertOn": false,
      "isPublishing": false,
      "alertOptions": {
        "alertChangeStatus": false,
        "alertVodUploadFail": false,
        "alertReStreamFail": false
      },
      "callbackEndpoint": "https://my-callback-endpoint",
      "envType": "REAL"
    }
  ],
  "total": 26
}

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

What's Next

ターゲットプラットフォームリストおよびステータス照会

リクエスト
レスポンス
例

タグ

Live Station