VPC 환경에서 이용 가능합니다.
대기 중 또는 진행 중인 미디어 에셋 분석을 취소합니다. 취소 시 중간 산출물은 모두 삭제됩니다.
참고
- 대기 중(
WAIT_ANALYZE) 또는 진행 중(ANALYZING) 상태에서만 취소할 수 있습니다. 그 외 상태에서 요청 시409에러가 반환됩니다. - 진행 중인 분석 작업의 중단은 취소(
/index/cancel)로 처리하며, 완료된 인덱스의 삭제는 인덱스 삭제로 처리합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /api/v1/workspaces/{workspace_name}/projects/{project_id}/assets/{asset_id}/index/cancel |
요청 헤더
Media Intelligence API에서 공통으로 사용하는 헤더에 대한 정보는 Media Intelligence 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
workspace_name |
String | Required | 워크스페이스 이름 |
project_id |
String | Required | 프로젝트 ID
|
asset_id |
String | Required | 미디어 에셋 ID
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/projects/1234/assets/5678/index/cancel' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
code |
String | - | API 처리 결과 코드 |
message |
String | - | API 처리 결과 메시지 |
응답 상태 코드
Media Intelligence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media Intelligence 응답 상태 코드를 참조해 주십시오.
| 에러 코드 | 메시지 | 설명 |
|---|---|---|
| 409 | Cannot cancel analysis in the current state | 대기 중 또는 진행 중이 아닌 분석에 대한 취소 요청 |
응답 예시
응답 예시는 다음과 같습니다.
{
"code": "0",
"message": "success"
}