워크스페이스 리소스 내보내기¶

POST /api/v1/workspace/resource/export/task/create

개요¶

워크스페이스 리소스 내보내기 작업을 시작합니다.

매개변수 추가 설명¶

1. 인터페이스 용도

현재 워크스페이스의 리소스 내보내기 작업을 시작합니다.

이 인터페이스는 비동기 작업 인터페이스이며, 호출 성공 시 taskId만 반환되고 압축 파일 내용이 즉시 반환되지 않습니다.

호출流程은 다음과 같습니다.

1. 현재 인터페이스를 호출하여 taskId를 획득합니다.
2. GET /api/v1/workspace/resource/query_action_status를 호출하여 작업 상태를 폴링합니다.
3. 상태가 ok로 변경되면 상태 인터페이스 반환 결과에서 내보내기 파일 정보를 획득합니다.

2. 요청 설명

현재 인터페이스는 요청 본문이 필요 없으며, 기본적으로 DF-API-KEY가 속한 워크스페이스의 데이터를 내보냅니다.

3. 반환 설명

성공 반환 예시:

{
  "taskId": "task_xxx"
}

설명:

• 작업 생성에 성공하면 taskId가 반환됩니다.
• 이후 내보내기 실행 실패, 일부 리소스 내보내기 실패 등은 작업 상태 인터페이스를 통해 확인해야 합니다.

4. 현재 리소스 경계 설명

현재 워크스페이스 리소스 가져오기 및 내보내기에는 다음과 같은 경계가 있습니다.

1. 환경 변수에 scope=rum이 포함되지 않습니다.
2. 로그 인덱스에 외부 인덱스와 default가 포함되지 않습니다.
3. 필드 관리는 워크스페이스 사용자 정의 필드만 처리합니다.
4. 데이터 액세스는 현재 워크스페이스 가져오기 및 내보내기를 지원하지 않습니다.

5. 내보내기 결과 추가 설명

특정 리소스 내의 개별 객체 내보내기가 실패하더라도 전체 내보내기 작업이 중단되지 않습니다. 관련 실패 세부 정보는 작업 상태 인터페이스가 반환하는 import_info.exportFailedInfo에 기록됩니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/workspace/resource/export/task/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "taskId": "task_xxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}