チャンネル情報の照会

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VOD Stationは、チャンネルの詳細情報を照会するための APIを提供します。

リクエスト

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

リクエストヘッダ

ヘッダ名	説明
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	Object	VOD Station OPEN APIレスポンスオブジェクト
content.id	String	作成されたチャンネルの ID
content.name	Object	チャンネル名
content.channelStatus	Integer	チャンネルの現在の状態	CREATING, READY, STOPPING, STOPPED, TERMINATING, TERMINATED, FORCE_STOPPING, FORCE_STOPPED, FORCETERMINATING, FORCETERMINATED
content.storageBucketName	String	チャンネルに連携された Object Storageバケット名
content.encryptedBucketName	String	チャンネルと連携された Object Storageバケットの暗号化された名前で、再生 URL作成時に使用
content.segmentDuration	Integer	チャンネルの segment再生の長さ(単位: 秒)
content.segmentDurationOption	String	チャンネルの segment keyframeのソートオプション
content.accessPrivateFiles	Boolean	バケット内の非公開ファイルに対する VOD Stationからのアクセス制限の設定
content.protocolList[]	Array(String)	チャンネルのストリーミングプロトコルリスト
content.createTime	Integer	チャンネルの作成開始時間
content.readyTime	Integer	チャンネルの作成完了時間
content.cdnCreatedTime	Integer	チャンネルと連携して自動作成された CDNの作成時間
content.playUrl	String	CDNを通じた再生 URL Template
content.cdnStatus	String	チャンネルと連携された CDNの状態。自動作成しない場合、なしと表示
content.cdnDomain	String	自動作成された CDN+のドメイン
content.cdnServiceName	String	自動作成された CDN+のサービス名
content.cdn	Object	自動作成された Global Edge情報
content.cdn.cdnType	String	自動作成された CDNタイプ
content.cdn.cdnDomain	String	自動作成された Global Edgeのドメイン
content.cdn.cdnServiceName	String	自動作成された Global Edgeのサービス名
content.cdn.profileId	String	自動作成された Global Edgeのプロファイル ID
content.cdn.regionType	String	自動作成された Global Edgeのサービスエリア
content.cdn.cdnInstanceNo	Integer	自動作成された Global Edgeのインスタンス情報
content.storageBucketStatus	String	チャンネルに連携された Object Storageバケットの状態
content.originPath	String	作成したチャンネルのソースパスに別途の CDNを作成する際に参照
content.encryptionList[]	Array	チャンネルのメディアセキュリティ設定
content.encryptionList[].protocol	String	メディアセキュリティ対象プロトコル
content.encryptionList[].mediaEncryptionTypeCode	Integer	メディアセキュリティ設定の暗号化タイプ 1: AES-128 2: Sample-AES 3: CENC
content.encryptionList[].drmTypeCode	Intenger	メディアセキュリティ設定の DRMタイプ 21: FairPlay 22: Widevine/PlayReady
content.encryptionList[].drmTypeName	String	メディアセキュリティ設定の DRMタイプ名
content.encryptionList[].drmContentId	String	VOD Stationでパッケージングする時にリクエストする Content ID
content.encryptionList[].systemIdList	Array(String)	VOD Stationでパッケージングする時にリクエストする DRM System ID
content.encryptionList[].drmKeyUrl	String	VOD Stationでパッケージングする時にリクエストする DRM CPIX API URL
content.drm	Object	VOD Stationを活用した DRM Encryption設定
content.drm.siteId	String	One Click Multi DRMサービスで作成した site id
content.drm.contentId	String	DRM Encryptionを適用するコンテンツの固有 ID DRMパッケージのために使用し、最低3文字以上の英数字または「-」(ハイフン)、「_」(アンダースコア)を含む最大100文字まで入力可能
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-20201112113327-Icwk9YO

GET /api/v2/channels/vs-20191227055342-vDVWH5l
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/edge-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",
        "drmSystemId": [
          "9A04F079-9840-4286-AB92-E65BE0885F95",
          "EDEF8BA9-79D6-4ACE-A3C8-27DCD51D21ED"
        ],
        "drmKeyUrl": "https://kms.example.com/cpix/token"
      },
      {
        "protocol": "HLS",
        "mediaEncryptTypeCode": 1,
        "mediaEncryptionTypeName": "AES-128"
      }
    ]
  }
}

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

What's Next

チャンネルリストの照会

リクエスト
レスポンス
例

タグ

VOD Station