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

    チャンネルリストの照会

    • PDF

    Article Summary

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

    リクエスト

    GET https://vodstation.apigw.ntruss.com/api/v2/channels
    

    リクエストパラメータ

    パラメータ名必須有無タイプ制限事項説明
    pageNoNoIntegerリクエストするページ番号
    総ページ番号は total/pageSizeNo
    pageSizeNoNoIntegerページごとのチャンネル数

    作成したチャンネルをページごとに分けて照会する

    • 例) 作成したチャンネルが30個の場合、ページごとに10個ずつ表示されるようにチャンネルリストを照会
    GET https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=1&pageSizeNo=10
    -> 計30個のチャンネルをページごとに10個単位でリクエストし、最初のページをリクエスト
    
    GET https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=2&pageSizeNo=10
    -> 計30個のチャンネルをページごとに10個単位でリクエストし、2番目のページをリクエスト
    
    GET https://vodstation.apigw.ntruss.com/api/v2/channels?pageNo=3&pageSizeNo=10
    -> 計30個のチャンネルをページごとに10個単位でリクエストし、3番目のページをリクエスト
    

    リクエストヘッダ

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

    レスポンス

    フィールド名タイプ説明備考
    content[]ArrayVOD Station OPEN APIレスポンスオブジェクトの配列
    content[].idString作成されたチャンネルの ID
    content[].nameObjectチャンネル名
    content[].channelStatusIntegerチャンネルの現在の状態CREATING, READY, STOPPING, STOPPED, TERMINATING, TERMINATED, FORCE_STOPPING, FORCE_STOPPED, FORCETERMINATING, FORCETERMINATED
    content[].storageBucketNameStringチャンネルに連携された Object Storageバケット名
    content[].encryptedBucketNameStringチャンネルと連携された Object Storageバケットの暗号化された名前で、再生 URL作成時に使用
    content[].segmentDurationIntegerチャンネルの segment再生の長さ(単位: 秒)
    content[].segmentDurationOptionStringチャンネルの segment keyframeのソートオプション
    content[].accessPrivateFilesBooleanバケット内の非公開ファイルに対する VOD Stationからのアクセス制限の設定
    content[].protocolList[]Array(String)チャンネルのストリーミングプロトコルリスト
    content[].createTimeIntegerチャンネルの作成開始時間
    content[].readyTimeIntegerチャンネルの作成完了時間
    content[].cdnCreatedTimeIntegerチャンネルと連携して自動作成された CDNの作成時間
    content[].playUrlStringCDNを通じた再生 URL Template
    content[].cdnStatusStringチャンネルと連携された CDNの状態。自動作成しない場合、NOT_FOUNDで表示
    content[].cdnDomainString自動作成された CDN+のドメイン
    content[].cdnServiceNameString自動作成された CDN+のサービス名
    content[].cdnObject自動作成された Global Edge情報
    content[].cdn.cdnTypeString自動作成された CDNタイプ
    content[].cdn.cdnDomainString自動作成された Global Edgeのドメイン
    content[].cdn.cdnServiceNameString自動作成された Global Edgeのサービス名
    content[].cdn.profileIdString自動作成された Global Edgeのプロファイル ID
    content[].cdn.regionTypeString自動作成された Global Edgeのサービスエリア
    content[].cdn.cdnInstanceNoInteger自動作成された Global Edgeのインスタンス情報
    content[].storageBucketStatusStringチャンネルに連携された Object Storageバケットの状態
    content[].originPathString作成したチャンネルのソースパスに別途の CDNを作成する際に参照
    content[].encryptionList[]Arrayチャンネルのメディアセキュリティ設定
    content[].encryptionList[].protocolStringメディアセキュリティ対象プロトコル
    content[].encryptionList[].mediaEncryptionTypeCodeIntegerメディアセキュリティ設定の暗号化タイプ
    1: AES-128
    2: Sample-AES
    3: CENC
    content[].encryptionList[].drmTypeCodeIntengerメディアセキュリティ設定の DRMタイプ
    21: FairPlay
    22: Widevine/PlayReady
    content[].encryptionList[].drmTypeNameStringメディアセキュリティ設定の DRMタイプ名
    content[].encryptionList[].drmContentIdStringVOD Stationでパッケージングする時にリクエストする Content ID
    content[].encryptionList[].systemIdListArray(String)VOD Stationでパッケージングする時にリクエストする DRM System ID
    content[].encryptionList[].drmKeyUrlStringVOD Stationでパッケージングする時にリクエストする DRM CPIX API URL
    content[].drmObjectVOD Stationを活用した DRM Encryption設定
    content[].drm.siteIdStringOne Click Multi DRMサービスで作成した site id
    content[].drm.contentIdStringDRM Encryptionを適用するコンテンツの固有 ID
    DRMパッケージのために使用し、最低3文字以上の英数字または 「-」(ハイフン)、「_」(アンダースコア)を含む最大100文字まで入力可能です。
    totalIntegerチャンネルの総数
    errorObjectエラーレスポンスコードとメッセージ
    error.errorCodeIntegerエラーレスポンスコード
    error.messageStringエラーレスポンスメッセージ
    error.detailsStringerror messageの詳細説明
    api gatewayエラー発生時のレスポンス

    リクエスト例

    GET https://vodstation.apigw.ntruss.com/api/v2/channels
    
    GET /api/v2/channels
    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": [
        {
          "id": "vs-20201112113327-Icwk9YO",
          "name": "api-guide-drm",
          "channelStatus": "RUNNING",
          "storageBucketName": "vodstation-bucket",
          "encryptedBucketName": "zz0G2Esbn14HUBlaiZSVkg__",
          "segmentDuration": 5,
          "segmentDurationOption": "BASIC",
          "accessPrivateFiles": true,
          "protocolList": [
            "HLS",
            "DASH"
          ],
          "createTime": 1605148407,
          "cdnCreatedTime": 1605148407,
          "playUrl": "https://example.edge.navercorp.com/[protocol]/[Object Storage Bucket(encryption name)]/[path]/[video filename]/[manifest]",
          "cdnStatus": "RUNNING",
          "cdnDomain": "example.cdn.ntruss.com",
          "cdnServiceName": "vscdn-Icwk9YO",
          "storageBucketStatus": "RUNNING",
          "cdn": {
            "cdnType": "GLOBAL_EDGE",
            "cdnDomain": "example.edge.navercorp.com",
            "cdnServiceName": "edge-vs-20230628185044-4HOrw8z",
            "profileId": 681,
            "regionType": "KOREA",
            "cdnInstanceNo": 1000
          },
          "originPath": "vs-k1.video.media.ntruss.com/132/vs-20230628185044-4HOrw8z",
          "drm": {
            "siteId": "ABCD",
            "contentId": "abc-2344-dfd"
          },
          "encryptList": [
            {
              "protocol": "DASH",
              "mediaEncryptTypeCode": 3,
              "mediaEncryptionTypeName": "AES-128",
              "drmTypeCode": 22,
              "drmTypeName": "Widevine/PlayReady",
              "drmContentId": "openapi",
              "systemIdList": [
                "9A04F079-9840-4286-AB92-E65BE0885F95",
                "EDEF8BA9-79D6-4ACE-A3C8-27DCD51D21ED"
              ],
              "drmKeyUrl": "https://kms.example.com/cpix/token"
            },
            {
              "protocol": "HLS",
              "mediaEncryptTypeCode": 1,
              "mediaEncryptionTypeName": "AES-128"
            }
          ]
        }
      ],
      "total": 1
    }
    

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

    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.