업로드된 파트 목록 조회¶
POST /api/v1/rum_sourcemap/part_list
개요¶
업로드 세션에 현재 저장된 파트 번호를 조회합니다.
호출 전 준비 및 사용 단계¶
현재 Key에는 rum.rumCfgManage 권한이 필요합니다. 현재 Key가 속한 워크스페이스로만 제한됩니다. appId는 RUM 애플리케이션 요약 목록의 content[].appId에서 가져오며, SDK/오류 기록의 app_id와 일치해야 하고 데이터베이스 내부 UUID로 대체할 수 없습니다. SourceMap은 애플리케이션, 환경 env, 버전 version으로 정확하게 식별되며, 대소문자/공백은 식별자 자체에 속하므로 수집 기록과 완전히 일치해야 합니다. env/version을 생략하거나 빈 문자열로 지정하면 빈 환경/빈 버전을 의미하며, 전체를 와일드카드로 매칭하는 것이 아닙니다. 현재 관리형 수명 주기에서는 각 항목이 최대 256자여야 합니다.
절차는 SourceMap 파트 업로드 관련 인터페이스 사용 설명을 참고하고, 파트 업로드 작업 문서도 참고할 수 있습니다. 초기화 → 원본 ZIP 전체 파트 업로드 → 파트 목록 확인 → 병합 → 버전 상태 및 파일 트리 조회 순으로 진행합니다. 초기화/병합 성공이 ZIP이 검증되었거나 파싱 가능하다는 것을 의미하지는 않으며, processing/failed/blocked 등의 상태는 계속 확인해야 합니다.
POST JSON으로 원본 uploadId를 전달하면 정수 번호 오름차순 배열을 반환하며, 파트가 없으면 []입니다. 호출자는 반드시 자신의 파트 목록으로 개수, 인덱스, 각 파트의 원본 내용을 확인한 후 병합해야 하며, 이 인터페이스는 파트 크기, 다이제스트, 전체 파트 수, 업로드 진행률(%)을 제공하지 않습니다.
이 엔드포인트는 업로드 캐시와 애플리케이션 소유권을 검증하지만, 모든 조회를 "대상이 여전히 쓰기 가능한 상태"로 해석하지는 않습니다. 이미 병합이 시작된 경우에도 캐시/임시 파트가 존재할 수 있습니다. 반환된 번호로는 아직 게시되지 않았음, 병합 성공, ZIP 무결성을 증명할 수 없습니다. 읽기 전용 캐시가 만료되었거나 작업이 덮어쓰기된 경우 406을 반환하고, 다른 워크스페이스의 애플리케이션은 읽을 수 없어 NotFoundRumSet을 반환합니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>확인 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받습니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| uploadId | string | Y | 필수 업로드 세션 ID로, 직접 조합하거나 taskId로 대체하지 마십시오. 동일 워크스페이스에서 관리 권한이 있는 Key는 계속 사용할 수 있으며, 생성한 Key 기준으로 격리되지 않습니다. 세션 기본 유효 시간은 3600초이고 파트 업로드 시 자동 갱신되지 않습니다. 만료되었거나 새 세션으로 덮어쓰기된 경우 확인 후 다시 초기화해야 합니다. null 허용: False 예시: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb확인 또는 입력 방법: 파트 업로드 초기화 성공 응답의 content.uploadId를 그대로 저장합니다. |
파라미터 추가 설명¶
절차는 SourceMap 파트 업로드 관련 인터페이스 사용 설명을 참고하고, 파트 업로드 작업 문서도 참고할 수 있습니다. 초기화 → 원본 ZIP 전체 파트 업로드 → 파트 목록 확인 → 병합 → 버전 상태 및 파일 트리 조회 순으로 진행합니다. 초기화/병합 성공이 ZIP이 검증되었거나 파싱 가능하다는 것을 의미하지는 않으며, processing/failed/blocked 등의 상태는 계속 확인해야 합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/rum_sourcemap/part_list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"uploadId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.uploadId | string | 세션 ID입니다. |
| content.chunkIndexs | array<integer> |
저장된 번호의 오름차순 목록이며, 필드 철자는 chunkIndexs입니다. |
| content.chunkIndexs[] | integer | 저장된 파트 번호 하나입니다. |
| content.declaration | object | 현재 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"uploadId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"chunkIndexs": [
0,
1,
2
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고합니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 타입, 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아닙니다 | 일부 json 파일 형식 오류 | uploadId 객체를 제출합니다. |
| 404 | ft.NotFoundRumSet | 애플리케이션이 현재 워크스페이스에 없거나 삭제되었거나 존재하지 않습니다 | 지정한 RUM 설정을 찾을 수 없습니다 | RUM 애플리케이션 요약 목록을 새로고침하고 현재 워크스페이스의 실제 appId를 사용합니다. |
| 406 | ft.InvalidUploadId | 세션 캐시가 없거나 만료되었거나 ID가 이후 세션으로 교체되었습니다 | 유효하지 않은 UploadId 값이거나 작업이 덮어쓰기되었습니다 | 원본 uploadId와 업로드된 파트를 확인하고, 이전 세션과 게시 상태를 확인한 후 다시 초기화하며 무작정 덮어쓰지 않습니다. |
| 500 | ft.InternalServerError | 데이터베이스, 파일 읽기/스냅샷, 이전 구성 또는 처리되지 않은 파싱 예외 | 내부 오류 | traceId와 애플리케이션/env/version을 보관하고, 먼저 버전 상태와 파일을 확인한 뒤 실제 오류에 따라 처리합니다. 조회는 백오프 재시도를 적용할 수 있습니다. |