콘텐츠로 이동

워크스페이스 리소스 작업 상태 조회



GET /api/v1/workspace/resource/query_action_status

개요

워크스페이스 리소스 가져오기/내보내기 작업 상태 조회

Query 요청 매개변수

매개변수명 유형 필수 설명
taskId string Y 작업 ID
예시: task_xxx
비어 있음 허용: False

매개변수 추가 설명

1. API 용도

워크스페이스 리소스 가져오기 또는 내보내기 작업의 실행 상태를 조회합니다.

반환 구조는 프론트엔드 API와 동일하며, 다음에 사용됩니다: - 내보내기 작업 결과 조회 - 가져오기 작업 결과 조회 - 오류 코드 및 실패 정보 조회


2. 일반적인 상태 값

상태 값 설명
start 작업이 생성되었으나 아직 실행되지 않음
running 작업 실행 중
ok 작업 실행 성공
error 작업 실행 실패
cancel 작업이 취소됨

3. 일반적인 반환 필드 설명

필드명 설명
status 현재 작업 상태
action 작업 유형, 일반적으로 import 또는 export
message 추가 설명
errorCode 실패 시 오류 코드
import_info 가져오기/내보내기 통계 및 실패 정보
name_list 특정 작업에 포함된 리소스 이름 목록

4. 내보내기 작업 조회 설명

내보내기 작업이 성공하면 상태는 일반적으로 ok이며, 반환 결과에서 내보내기 파일 관련 정보를 확인할 수 있습니다.

내보내기 과정에서 일부 객체가 실패한 경우 다음을 확인할 수 있습니다:

import_info.exportFailedInfo

5. 가져오기 작업 조회 설명

가져오기 작업이 성공하면 일반적으로 import_info에서 다음을 확인할 수 있습니다:

  • successCount
  • failCount

일부 리소스의 상세 실패 원인은 errorCode 또는 가져오기 작업 내부 오류 통계에 표시됩니다.


6. 폴링 권장 사항

2~5초 간격으로 폴링하여 상태가 다음 중 하나가 될 때까지 확인하는 것을 권장합니다: - ok - error - cancel

요청 예시

curl 'https://openapi.guance.com/api/v1/workspace/resource/query_action_status?taskId=task_xxx' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

응답

{
    "code": 200,
    "content": {
        "status": "ok",
        "action": "import",
        "message": "",
        "errorCode": "",
        "import_info": {
            "failCount": 0,
            "successCount": 12
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

문서 평가

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