チャンネル情報の照会
- 印刷する
- PDF
チャンネル情報の照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Live Stationはチャンネルの詳細情報照会用の APIを提供します。
リクエスト
GET https://livestation.apigw.ntruss.com/api/v2/channels/{channelId}
リクエストヘッダ
ヘッダ名 | 必須の有無 | 説明 |
---|---|---|
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 IDx-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 | String | ||
qualitySetId | Integer | ||
qualitySetName | String | ||
outputProtocol | String | ||
channelStatus | String | CREATING、READY、PUBLISH、DELETED、BLOCK、FORCE_BLOCK、FORCE_DELETED | |
isRecording | Boolean | ||
useDvr | Boolean | ||
immediateOnAir | Boolean | true、false | |
timemachineMin | Integer | 単位: Minute | |
uploadPath | String | AUTO_UPLOADオプションの場合の録画ファイルのアップロードパス | |
snapshot | Object | ||
snapshotId | Integer | ||
record | Object | ||
record.format | String | MP4、HLS、ALL | |
record.type | String | NO_RECORD、AUTO_UPLOAD、MANUAL_UPLOAD | |
record.bucketName | String | ||
record.filePath | String | ||
record.accessControl | String | PRIVATE、PUBLIC_READ | |
cdn | Object | ||
cdn.cdnType | String | GLOBAL_CDN、GLOBAL_EDGE | |
cdn.instanceNo | String | NO_CDNの場合は0 | |
cdn.profileId | Integer | Global Edgeのプロファイル ID | NO_CDNの場合は0 |
cdn.statusName | String | CDNの状態 | RUNNING、PUBLISHING、STOPPING、STOPPED、CREATING、CHANGING、CDN_NOT_FOUND |
cdn.serviceName | String | CDN Service Name | NO_CDNの場合は"" |
cdn.cdnDomain | String | CDN Domain | NO_CDNの場合は"" |
publishUrl | String | ||
globalPublishUrl | String | 海外配信サポートのための URL | |
streamKey | String | ||
recentPublishStartTime | Integer | ||
createdTime | Integer | ||
alertOn | Boolean | ||
alertOptions | Object | ||
alertOptions.alertChangeStatus | Boolean | ||
alertOptions.alertVodUploadFail | Boolean | ||
alertOptions.alertReStreamFail | Boolean | ||
totalPublishSeconds | Integer | ||
envType | String | DEV、STAGE、REAL | |
callbackEndpoint | String | ||
backupStreamKey | String | 配信冗長化のためのバックアップストリームキー | |
isStreamFailOver | Boolean | 配信冗長化設定の適用有無 | true、false |
origin | Object | CDN連携のための Live Stationソース情報 | |
origin.originDomain | String | CDN連携のための Live Stationソースドメイン | |
origin.originPath | String | CDN連携のための Live Stationソースの詳細パス | |
drmEnabledYn | Boolean | DRM Encryption設定の適用有無 | |
drm | Object | Live Stationを利用した DRM Encryption設定 | |
drm.siteId | String | One Click Multi DRMサービスで作成した site id | |
drm.contentId | String | DRM Encryption適用対象コンテンツの固有 ID DRMパッケージングに使用され、英数字、記号の「-」(ハイフン)、「_」(アンダースコア)のみ使用して3~100文字以内で入力できます。 |
例
リクエスト例
GET /api/v2/channels/ls-20200323114720-bMoDF
HOST: livestation.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
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-20200323114720-bMoDF",
"channelName": "mychannel",
"instanceNo": 1163899,
"qualitySetId": 6,
"qualitySetName": "360p-set",
"outputProtocol": "HLS, DASH",
"channelStatus": "READY",
"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",
"publishUrl": "rtmp://live-station-rtmp-url",
"globalPublishUrl": "rtmp://live-station-global-rtmp-url",
"streamKey": "jjiantco4psakuwd5526u2glcxrqaar4",
"totalPublishSeconds": 0,
"createdTime": 1584931640000,
"recentPublishStartTime": 0,
"alertOn": false,
"alertOptions": {
"alertChangeStatus": false,
"alertVodUploadFail": false,
"alertReStreamFail": false
},
"callbackEndpoint": "https://my-callback-endpoint",
"envType": "REAL",
"origin": {
"originDomain": "ls-k1.video.media.ntruss.com",
"originPath": "1"
},
"backupStreamKey": "lbuy4dcrxk2ctxs8uqxanpy833p08vvz?backup=true",
"isStreamFailOver": true
}
}
この記事は役に立ちましたか?