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

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

개요¶

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

매개변수 추가 설명¶

1. API 용도

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

이 API는 비동기 작업 API입니다. 호출에 성공하면 taskId만 반환되며, 압축 파일 내용은 즉시 반환되지 않습니다.

호출 흐름은 다음과 같이 진행하는 것을 권장합니다.

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

2. 요청 설명

요청 본문을 전달하지 않으면 기본적으로 DF-API-KEY가 속한 워크스페이스의 전체 리소스를 내보냅니다.

SLO 리소스 패키지를 내보내려면 POST /api/v1/slo/export/task/create를 호출하세요. 현재 API는 워크스페이스 전체 리소스 내보내기에만 사용됩니다.

3. 반환 설명

성공 반환 예시:

{
  "taskId": "task_xxx"
}

설명:

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

4. 현재 리소스 경계 설명

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

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

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

특정 리소스의 개별 객체 내보내기가 실패해도 전체 내보내기 작업은 중단되지 않습니다. 작업 상태 API의 import_info.exportInfo.resourceFailureInfo는 리소스 유형, 리소스 UUID, 리소스 이름, 안정적인 실패 원인, 영향받은 SLO를 포함한 중복 제거된 리소스 수준 실패 상세 정보를 반환합니다. 리소스 구성, 권한 구성원, 예외 스택, 민감한 필드는 반환되지 않습니다. 이전 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"
}