콘텐츠로 이동

QueryHub 비동기 쿼리 취소



POST /api/v1/df/async_query/delete

개요

동일한 API Key가 현재 워크스페이스에서 제출한 QueryHub 작업을 취소합니다. 이미 시작된 쿼리는 타임아웃 시점까지 계속 실행될 수 있으며, Studio는 지연된 결과를 폐기합니다.

호출 전 및 사용 단계

  1. 현재 API Key로 비동기 데이터 쿼리를 제출하고 QueryHub 데이터 소스를 선택합니다.
  2. 반환된 content.data[*].async_id에서 qhtask_로 시작하는 작업 식별자를 가져옵니다. 제출할 때와 동일한 Key 및 워크스페이스를 사용해야 합니다.
  3. 요청은 목록 순서대로 취소합니다. 중간에 특정 항목이 실패하더라도 이전에 취소된 작업은 롤백되지 않습니다. 확인이 필요하면 해당 작업을 각각 폴링합니다.

취소가 성공한 후에도 해당 작업에 대해 비동기 쿼리 엔드포인트를 계속 호출할 수 있습니다. POST JSON {"queries":[{"qtype":"queryhub","async_id":"qhtask_0123456789abcdef0123456789abcdef"}]}. 취소된 작업은 레코드 유효 기간 동안 query_status=failed, query_error.errorCode=QueryHubTaskCancelled, is_running=false, async_id=""를 보고합니다. 작업 레코드는 기본적으로 제출 시점부터 300초 동안 보존됩니다. 레코드 유효 기간 내에는 이미 취소된 작업을 다시 취소해도 성공합니다.

요청 헤더

파라미터 이름 타입 필수 설명
DF-API-KEY string Y OpenAPI 액세스 키
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 이 API 권한이 있는 Key를 생성하거나 획득합니다.

Body 요청 파라미터

파라미터 이름 타입 필수 설명
asyncIds array Y QueryHub 비동기 작업 ID 목록, 1~20개
null 허용: False
예시: ["qhtask_0123456789abcdef0123456789abcdef"]
획득 또는 입력 방법: QueryHub 비동기 쿼리 제출 응답의 content.data[*].async_id에서 그대로 복사합니다. 최대 20개이며 다른 엔진 작업 식별자는 입력하지 마십시오.

요청 예시

curl 'https://openapi.guance.com/api/v1/df/async_query/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"asyncIds":["qhtask_0123456789abcdef0123456789abcdef"]}'

응답

HTTP 200, application/json.

필드 타입 설명
content object 성공 시 {}. 백그라운드 실행기는 여전히 실행 중일 수 있으며, 지연된 결과는 호출자에게 전달되지 않습니다.
응답 헤더 타입 설명
Cache-Control string 성공 및 QueryHub 오류 응답은 모두 no-store입니다.
{
    "code": 200,
    "content": {},
    "errorCode": "",
    "success": true,
    "message": "",
    "traceId": "trace-example"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 필드 타입, 필수 여부 또는 제약 조건이 파라미터 표와 일치하지 않음 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. 필드, 타입 및 제약 조건을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류입니다. content의 reason, line, column을 확인한 후 수정합니다.
400 forethought.QueryHubInvalidFields 목록이 비어 있거나 20개를 초과하거나 QueryHub 작업 ID가 아님 메시지가 비어 있을 수 있습니다. 각 항목의 ID 접두사와 개수를 확인합니다.
400 forethought.QueryHubInvalidId qhtask_ 식별자에 허용되지 않는 문자가 포함되어 있거나 길이 초과 메시지가 비어 있을 수 있습니다. 작업 제출 응답에서 전체 async_id를 복사합니다.
403 forethought.QueryHubForbidden 자격 증명이 이 API에 적용되지 않거나 쿼리 권한이 없음 쿼리 권한이 없습니다. 호출 권한이 있는 OpenAPI Key를 사용합니다.
404 forethought.QueryHubTaskNotFound 작업이 만료되었거나 존재하지 않거나 현재 Key에 속하지 않음 쿼리 작업이 만료되었습니다. 다시 제출하십시오. 워크스페이스, Key 및 작업 상태를 확인합니다.
503 forethought.QueryHubUnavailable QueryHub를 현재 사용할 수 없거나 활성화되지 않음 쿼리 서비스 또는 데이터 소스를 일시적으로 사용할 수 없습니다. 서비스가 활성화되었는지 확인한 후 상태에 따라 재시도합니다.

문서 평가

이 페이지가 도움이 되었나요?