チャンネルリストの照会
    • PDF

    チャンネルリストの照会

    • PDF

    記事の要約

    Live Stationは、チャンネルリストを照会するための APIを提供します。

    リクエスト

    GET https://livestation.apigw.ntruss.com/api/v2/channels?pageNo={pageNo}&pageSizeNo={pageSizeNo}&channelStatus={channelStatus}&id={channelId}&channelName={channelName}
    

    リクエストパラメータ

    パラメータ名必須の有無タイプ制限事項説明
    pageNoNoInteger制限なし照会対象のページインデックス
    pageSizeNoNoInteger1~100リスト照会時に含まれるチャンネル数
    例) 作成されたチャンネルが60個の場合、pageSizeNo 30であれば、ページごとに30個ずつチャンネルリストを照会
    channelStatusNoStringREADY、PUBLISHING、BLOCK照会対象チャンネルの状態
    idNoString制限なし照会対象のチャンネル ID
    channelNameNoString制限なし照会対象のチャンネル名

    リクエストヘッダ

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

    レスポンス

    フィールド名タイプ説明備考
    channelIdString
    channelNameString
    instanceNoString
    qualitySetIdInteger
    qualitySetNameString
    outputProtocolString
    channelStatusStringCREATING、READY、PUBLISH、DELETED、BLOCK、FORCE_BLOCK、FORCE_DELETED
    isRecordingBoolean
    useDvrBoolean
    immediateOnAirBooleantrue、false
    timemachineMinInteger単位: Minute
    cdnObject
    cdn.cdnTypeStringGLOBAL_CDN、GLOBAL_EDGE
    cdn.instanceNoStringNO_CDNの場合は0
    cdn.profileIdIntegerGlobal Edgeのプロファイル IDNO_CDNの場合は0
    cdn.statusNameStringCDNの状態RUNNING、PUBLISHING、STOPPING、STOPPED、CREATING、CHANGING、CDN_NOT_FOUND
    cdn.serviceNameStringCDN Service NameNO_CDNの場合は""
    cdn.cdnDomainStringCDN DomainNO_CDNの場合は""
    snapshotObject
    snapshotIdInteger
    recordObject
    record.formatStringMP4、HLS、ALL
    record.typeStringNO_RECORD、AUTO_UPLOAD、MANUAL_UPLOAD
    record.bucketNameString
    record.filePathString
    record.accessControlStringPRIVATE、PUBLIC_READ
    uploadPathStringAUTO_UPLOADオプションの場合の録画ファイルのアップロードパス
    publishUrlString
    globalPublishUrlString海外配信サポートのための URL
    streamKeyString
    recentPublishStartTimeInteger
    createdTimeInteger
    alertOnBoolean
    alertOptionsObject
    alertOptions.alertChangeStatusBoolean
    alertOptions.alertVodUploadFailBoolean
    alertOptions.alertReStreamFailBoolean
    totalPublishSecondsInteger
    envTypeStringDEV、STAGE、REAL
    callbackEndpointString
    backupStreamKeyString配信冗長化のためのバックアップストリームキー
    isStreamFailOverBoolean配信冗長化設定の適用有無true、false
    originObjectCDN連携のための Live Stationソース情報
    origin.originDomainStringCDN連携のための Live Stationソースドメイン
    origin.originPathStringCDN連携のための Live Stationソースの詳細パス
    drmEnabledYnBooleanDRM Encryption設定の適用有無
    drmObjectLive Stationを利用した DRM Encryption設定
    drm.siteIdStringOne Click Multi DRMサービスで作成した site id
    drm.contentIdStringDRM Encryption適用対象コンテンツの固有 ID
    DRMパッケージングに使用され、英数字、記号の「-」(ハイフン)、「_」(アンダースコア)のみ使用して3~100文字以内で入力できます。

    リクエスト例

    GET /api/v2/channels?pageNo=1&pageSizeNo=10
    HOST: livestation.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-timestamp:1621242480854
    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: Fri, 26 Sep 2021 09:53:32 GMT
    Content-Type: application/json;charset=utf-8
    Connection: keep-alive
    Access-Control-Allow-Origin: *
    x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
    
    {
      "content": [
        {
          "channelId": "ls-20210406135408-FNGOA",
          "channelName": "mychannel1",
          "instanceNo": 1675706,
          "qualitySetId": 1,
          "qualitySetName": "passthrough",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "PUBLISHING",
          "isRecording": false,
          "useDVR": true,
          "immediateOnAir": false,
          "timemachineMin": 360,
          "cdn": {
            "instanceNo": "1163900",
            "serviceName": "edge-ls-20230914204831-1BRHO",
            "statusName": "RUNNING",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "hls",
            "filePath": "/livestation",
            "format": "MP4",
            "accessControl": "PRIVATE"
          },
          "drm": {
            "contentId": "my-first-drm",
            "siteId": "drm-20231120182420-dPTGn"
          },
          "drmEnabledYn": true,
          "uploadPath": "/hls/livestation",
          "streamKey": "smnagylbpycrhxvjuzfx6b83v5zbg0w1",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 34193,
          "createdTime": 1617684849000,
          "alertOn": false,
          "recentPublishStartTime": 1621238492000,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "STAGE"
        },
        {
          "channelId": "ls-20210302103926-4QyAE",
          "channelName": "mychannel2",
          "instanceNo": 1632544,
          "qualitySetId": 6,
          "qualitySetName": "360p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": true,
          "useDVR": true,
          "immediateOnAir": true,
          "timemachineMin": 360,
          "cdn": {
            "instanceNo": "1527496",
            "serviceName": "cdn-ls-20201112153428-E5ZLH",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "83j2v3v32gsc2c1bez7e3ae7t0uckix2",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 3559,
          "createdTime": 1614649167000,
          "alertOn": false,
          "recentPublishStartTime": 1617612443000,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "STAGE"
        },
        {
          "channelId": "ls-20210226182505-7mkQg",
          "channelName": "mychannel3",
          "instanceNo": 1629316,
          "qualitySetId": 6,
          "qualitySetName": "360p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": true,
          "useDVR": true,
          "immediateOnAir": true,
          "timemachineMin": 360,
          "cdn": {
            "instanceNo": "1527496",
            "serviceName": "cdn-ls-20201112153428-E5ZLH",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "hls",
            "filePath": "/livestation",
            "format": "MP4",
            "accessControl": "PRIVATE"
          },
          "uploadPath": "/hls/livestation",
          "streamKey": "ui1b9ysclvel3r1osasulab37d6584zo",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 0,
          "createdTime": 1614331505000,
          "alertOn": false,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20210225184529-ab0p0",
          "channelName": "mychannel4",
          "instanceNo": 1627067,
          "qualitySetId": 6,
          "qualitySetName": "360p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": false,
          "useDVR": true,
          "immediateOnAir": true,
          "timemachineMin": 360,
          "cdn": {
            "instanceNo": "1527496",
            "serviceName": "cdn-ls-20201112153428-E5ZLH",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "AUTO_UPLOAD",
            "bucketName": "mp4",
            "filePath": "/livestation/mp4",
            "format": "MP4",
            "accessControl": "PRIVATE"
          },
          "uploadPath": "/mp4/livestation/mp4",
          "streamKey": "x1ikvfjje2sfalltav9c8aa90g6bdwt7",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 15217,
          "createdTime": 1614246330000,
          "alertOn": false,
          "recentPublishStartTime": 1617844568000,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20210224095620-Jx775",
          "channelName": "mychannel5",
          "instanceNo": 1623674,
          "qualitySetId": 2,
          "qualitySetName": "audio-only",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": true,
          "useDVR": true,
          "immediateOnAir": true,
          "timemachineMin": 360,
          "cdn": {
            "instanceNo": "1536104",
            "serviceName": "vscdn-DmcAKhX",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "ywgtjsp153zy4d1vzod84a934r54cdk7",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 0,
          "createdTime": 1614128181000,
          "alertOn": false,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20210202105451-xVxAe",
          "channelName": "mychannel6",
          "instanceNo": 1593170,
          "qualitySetId": 4,
          "qualitySetName": "720p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": false,
          "useDVR": true,
          "immediateOnAir": true,
          "timemachineMin": 360,
          "cdn": {
            "instanceNo": "1217836",
            "serviceName": "cdn-ls-20200604210934-JUlYB",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "fwocwhvo00xtuo1h6okvl9qelkh9c32d",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 1615,
          "createdTime": 1612230891000,
          "alertOn": false,
          "recentPublishStartTime": 1613442172000,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20210114185131-kmrbH",
          "channelName": "mychannel7",
          "instanceNo": 1574189,
          "qualitySetId": 6,
          "qualitySetName": "360p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": false,
          "useDVR": false,
          "immediateOnAir": false,
          "timemachineMin": 0,
          "cdn": {
            "instanceNo": "1158537",
            "serviceName": "lsv2-cdn-lsv2-20200317170245-23p42",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "wwbsun5iwjvm2u12v732f9aiu6jnu4xb",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 512,
          "createdTime": 1610617891000,
          "alertOn": false,
          "recentPublishStartTime": 1610619881000,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20210114184055-uasYt",
          "channelName": "mychannel8",
          "instanceNo": 1574169,
          "qualitySetId": 6,
          "qualitySetName": "360p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": false,
          "useDVR": false,
          "immediateOnAir": false,
          "timemachineMin": 0,
          "cdn": {
            "instanceNo": "1217836",
            "serviceName": "cdn-ls-20200604210934-JUlYB",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "kvkqgxh613syvu1d8q5399aim2gsuql5",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 813,
          "createdTime": 1610617256000,
          "alertOn": false,
          "recentPublishStartTime": 1611279629000,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20201207133505-L691k",
          "channelName": "mychannel9",
          "instanceNo": 1542347,
          "qualitySetId": 5,
          "qualitySetName": "480p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": false,
          "useDVR": false,
          "immediateOnAir": false,
          "timemachineMin": 0,
          "cdn": {
            "instanceNo": "1542348",
            "serviceName": "gcdn-ls-20201207133505-L691k",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "lcu0qwwkdj5lupdmmsz5w8e0b7dgrq0h",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 7795,
          "createdTime": 1607315706000,
          "alertOn": true,
          "recentPublishStartTime": 1607660432000,
          "alertOptions": {
            "alertChangeStatus": true,
            "alertVodUploadFail": false,
            "alertReStreamFail": false,
            "reStreamFailThreshold": 2
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        },
        {
          "channelId": "ls-20201207133353-wutob",
          "channelName": "mychannel10",
          "instanceNo": 1542345,
          "qualitySetId": 5,
          "qualitySetName": "480p-set",
          "outputProtocol": "HLS, DASH",
          "channelStatus": "READY",
          "isRecording": false,
          "useDVR": false,
          "immediateOnAir": false,
          "timemachineMin": 0,
          "cdn": {
            "instanceNo": "1542346",
            "serviceName": "gcdn-ls-20201207133353-wutob",
            "statusName": "running",
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "mycdn.edge.naverncp.com",
            "profileId": 299,
            "regionType": "KOREA"
          },
          "record": {
            "type": "MANUAL_UPLOAD",
            "accessControl": "PRIVATE"
          },
          "streamKey": "5fn9ro9v6h9rgo7v6bdjn8e0a9yq84zw",
          "publishUrl": "rtmp://live-station-rtmp-url",
          "globalPublishUrl": "rtmp://live-station-global-rtmp-url",
          "totalPublishSeconds": 0,
          "createdTime": 1607315633000,
          "alertOn": false,
          "alertOptions": {
            "alertChangeStatus": false,
            "alertVodUploadFail": false,
            "alertReStreamFail": false
          },
          "callbackEndpoint": "https://my-callback-endpoint",
          "envType": "REAL"
        }
      ],
      "total": 60
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.