서문
ㅏGET에 요청https://api.bcovlive.io/v1/jobs라이브 API의 엔드포인트를 사용하면 생성한 라이브 작업 목록을 얻을 수 있습니다. 유사하게, GET요청하다https://api.bcovlive.io/v1/jobs/{job_id}/vods라이브 작업에 대한 VOD 작업 목록을 가져옵니다. 이러한 요청의 전체 세부 정보는 API 참조에서 확인할 수있습니다. 이 항목에서는 개요와 몇 가지 추가 세부 정보를 제공합니다. 별도로 명시하지 않는 한, 아래 설명 된 매개 변수는 이러한 두 요청 모두에 적용됩니다.
쪽수 매기기
결과 페이지 매김은start_token및page_size쿼리 매개 변수를 통해 처리됩니다. 페이지 크기는 각 요청에 대해 반환 할 결과 수를 나타내며 1에서 1000 사이의 숫자로 설정할 수 있습니다.
각 응답에는 추가 결과가 있는 경우next_token필드가 포함됩니다. start_token를next_token값으로 설정하면 다음 결과 페이지가 반환됩니다.
정렬
결과는 다음을 사용하여 정렬할 수 있습니다. sort설정할 수 있는 매개변수created_at (기본값) 또는modified_at . sort_dir매개 변수를asc (기본값) 또는 로 설정하여 정렬 방향을 설정할 수도desc있습니다.
검색 필터
검색 필터 매개 변수를 추가하여 결과를 제한 할 수 있습니다. 모든 검색 필터는 선택 사항입니다. 여러 필터는AND조건으로 취급됩니다. 즉, Vod 작업이 결과에 포함되려면 모든 조건을 충족해야 합니다.
다음 형식을 사용하여 단일 필터에 여러 값을 지정할 수 있습니다.
{filter}=[value1,value2]
이 방법으로 지정한 필터 값은OR조건으로 처리되며, 값이 하나라도 일치하면 작업이 반환됩니다.
비교 연산자는 콜론으로 구분 된 필터 값 앞에 포함될 수 있습니다.
{filter}={op}:{value}
연산자는 다음과 같습니다. gt (보다 큰), ge (크거나 같음), lt (보다 작음), le (작거나 같음). 예를 들어, 2018년 1월 1일 이후에 생성된 vod 작업을 검색하려면:
created_at=gt:1514764800000
필터 유형은 값에서 유추됩니다. 숫자 또는 부울을 문자열로 처리해야하는 경우 작은 따옴표로 묶을 수 있습니다.
{filter}=’1234’
| 필터 이름 | 유형 | 설명 / 값 |
|---|---|---|
user_id |
문자열, 문자열 배열 | 사용자 ID |
created_at |
정수 | Unix 작업 생성 시간 (밀리 초) |
modified_at |
정수 | 작업의 마지막 상태 변경의 Unix 시간 (밀리 초) |
static |
부울 | 정적 엔드 포인트가 있습니다 (목록 작업 요청 전용). |
state |
문자열, 문자열 배열 | 하나 이상의 작업 상태 (목록 작업 요청에만 해당) |
jvod_state |
문자열, 문자열 배열 | 하나 이상의 VOD 작업 상태 (목록 vod 작업 요청에만 해당) |
jvod_type |
문자열, 문자열 배열 | 하나 이상의 VOD 작업 유형 (목록 vod 작업 요청에만 해당) |
label |
문자열, 문자열 배열 | 하나 이상의 VOD 작업 레이블 (목록 vod 작업 요청에만 해당) |
sep_state |
문자열, 문자열 배열 | 하나 이상의 정적 엔드 포인트 상태 (목록 작업 요청에만 해당) |
ssai_state |
문자열, 문자열 배열 | 하나 이상의 SSAI 상태 (목록 작업 요청에만 해당) |
region |
문자열, 문자열 배열 | 하나 이상의 지역 (목록 작업 요청에만 해당) |
account_id |
끈 | 특정 계정을 검색하거나 '*'를 지정하여 모든 계정을 검색합니다. 기본값은 계정 API 키가 속한 것입니다. |
{other_job_fields} |
필드 유형에서 유추 | 다른 작업 필드는 내부 이름과 값을 지정하여 필터링 할 수 있습니다. |
예
다음은 라이브 작업을 얻기위한 몇 가지 샘플 요청입니다.
- 완료된 상태에서 실시간 작업을 가져와 가장 최근에 생성 된 작업을 먼저 표시합니다.
https://api.bcovlive.io/v1/jobs?state=finished&sort=created_at&sort_dir=desc- 현재 활성화 된 SEP 라이브 작업 가져 오기
https://api.bcovlive.io/v1/jobs?static=true&sep_state=ready- 2018-10-01 이후에 생성 된 라이브 일자리 받기
https://api.bcovlive.io/v1/jobs?created_at=gt:1538428165517