채널 목록 조회
- 인쇄
- PDF
채널 목록 조회
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
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 | 네이버 클라우드 플랫폼 포털에서 발급받은 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
}
이 문서가 도움이 되었습니까?