생성¶
POST /api/v1/snapshots/create
개요¶
페이지 스냅샷을 저장하거나 동일 이름의 스냅샷을 강제로 재생성합니다.
호출 전 및 사용 단계¶
현재 Key에는 snapshot.create 권한이 필요합니다. 저장되는 것은 페이지 및 쿼리 구성이며 전체 텔레메트리를 물리적으로 복사하는 것이 아닙니다. 데이터 보존 기간, 쿼리 서비스 및 저장된 권한 범위는 이후 조회에 계속 영향을 줍니다. 생성 시 기본값은 워크스페이스 내 공개(isPublic=1)이며(인터넷 공유 아님), 공개 생성은 isPublic/isHidden/accountUUID/rules를 받지 않습니다.
같은 워크스페이스에 동일한 type 및 name의 활성 레코드가 있으면 isForce=false는 이름 중복 오류를 반환하고, true는 동일 UUID에서 객체 전체의 content를 덮어쓰며 현재 호출 Key에서 쿼리/마스킹 권한을 다시 수집하고 accountUUID와 생성 시간을 변경합니다. 원래 생성자의 더 큰 권한을 이어받지 않습니다. 원본 filterType은 강제 덮어쓰기로 업데이트되지 않으며, 원본 creator가 여전히 주체일 수 있습니다. 해당 스냅샷을 가리키는 기존 공유의 후속 쿼리는 업데이트된 서버 측 범위를 읽게 되며, 강제 재생성은 공유의 쿼리 가능 범위를 변경할 수 있으므로 기존 사용자를 먼저 확인해야 합니다.
content.routeQuery의 워크스페이스, 쿼리 또는 직접 입력한 권한 필드는 인가를 구성하지 않습니다. range를 안전하게 구성할 수 없으면 403으로 재생성을 요구합니다. 상대 시간 15m는 특정 15분을 동결하는 것과 동일하지 않으며, 고정 창이 필요하면 페이지에서 지원하는 절대 밀리초 범위를 사용합니다. 주체가 먼저 제출된 후 대시보드 요약이 추가될 수 있습니다. 500은 저장되지 않았음을 증명하지 않으므로 먼저 type/name 목록으로 확인하여 의도치 않은 덮어쓰기를 피해야 합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| content.routeName | string | 콘솔 라우트 식별자(예: 로그 탐색기 Log, 히트맵 RumHeatMap)이며 최상위 type과 호환성을 유지합니다. 예: Log가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeParams | json | 해당 페이지 경로 파라미터 객체입니다. 예: {"source": "all"}가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeParams.source | string | 로그 탐색기에서는 보통 all을 사용하며, 구체적인 값은 소스 페이지에서 결정됩니다. 예: all가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeParams.사용자 정의 키 | any | 페이지 경로 동적 파라미터이며, 현재 콘솔 페이지에서 생성된 구성을 기준으로 합니다. 예: value가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery | json | 해당 페이지 Query 상태이며 반드시 객체여야 합니다. 임의의 클라이언트 쿼리 값은 서버 측에서 이미 캡처한 권한을 확장하지 않습니다. 예: {"w": "wksp_example", "time": "1785423600000,1785427200000", "query": "service:payment", "cols": "time,message,service", "viewType": "view", "index": "default", "snapshotName": "支付服务日志"}가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.w | string | 페이지 워크스페이스 식별자이며 보통 현재 워크스페이스입니다. 이를 통해 API Key 범위를 변경할 수 없습니다. 예: wksp_example가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.workspaceUUID | string | 페이지에 필요한 쿼리 워크스페이스 목록이며 쉼표로 구분됩니다. 실제 크로스 워크스페이스 권한 및 스냅샷 저장 범위의 제한을 계속 받습니다. 예: wksp_example가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.time | string | 페이지 시간 범위이며, 예: 15m 또는 시작 밀리초,종료 밀리초 문자열입니다. 상대 시간은 데이터를 물리적으로 동결하는 것이 아닙니다. 예: 1785423600000,1785427200000가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.query | string | 페이지 검색 쿼리 문자열이며, 로그 탐색기 예시는 service:payment입니다. 스냅샷 API가 실행하는 DQL이 아닙니다. 예: service:payment가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.cols | string | 표시 필드 이름을 쉼표로 구분합니다(예: time,message,service). 예: time,message,service가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.viewType | string | 로그 탐색기에서 흔히 view는 목록, analyze는 분석이며 현재 페이지의 실제 프로토콜을 따릅니다. 예: view가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.index | string | 로그 인덱스 이름을 쉼표로 구분하며 로그 인덱스 구성에서 가져옵니다. 읽기 권한을 변경하지 않습니다. 예: default가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.snapshotName | string | 페이지에 표시되는 스냅샷 이름이며 최상위 name과 일치시키는 것이 좋습니다. 예: 支付服务日志가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.dashboard_id | string | 대시보드 스냅샷에 대응하는 dsbd_ UUID로 가시성 요약에 사용됩니다. 먼저 현재 워크스페이스에서 권한이 부여된 리소스를 확인하세요. 예: dsbd_example가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.app_id | string | RUM 히트맵의 공개 appId로 애플리케이션 요약을 추가하는 데 사용됩니다. 예: payment_web가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.routeQuery.사용자 정의 키 | any | 페이지 필터/레이아웃 등의 동적 상태이며, 백엔드는 주로 저장만 하고 렌더링 가능성은 검증하지 않습니다. 예: value가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content.사용자 정의 키 | any | 해당 페이지의 기타 저장 상태이며, 클라이언트가 서버 측 권한을 주입할 수 있음을 의미하지 않습니다. 예: value가져오기 또는 입력 방법: 해당 소스 페이지 또는 기존 스냅샷 content에서 가져옵니다. 워크스페이스/리소스 ID는 먼저 현재 액세스 권한을 확인해야 합니다. |
|
| content | json | Y | 필수 JSON 객체로, 내보낸 데이터가 아니라 페이지 구성/쿼리 조건을 저장합니다. 객체의 동적 하위 필드는 완전히 검증되지 않습니다. routeQuery/routeParams는 객체여야 하며, 잘못된 형식은 저장 후 읽기/공유 시 500을 초래할 수 있습니다. 기존 동일 이름 스냅샷의 content 전체를 덮어쓰며, 클라이언트 content/meta의 roles/rules/deniedNamespaces는 서버 측 권한을 확장하지 않습니다. null 허용: False 예: {"routeName": "Log", "routeParams": {"source": "all"}, "routeQuery": {"w": "wksp_example", "time": "1785423600000,1785427200000", "query": "service:payment", "cols": "time,message,service", "viewType": "view", "index": "default", "snapshotName": "支付服务日志"}}가져오기 또는 입력 방법: 현재 콘솔의 해당 페이지에서 라우트/필터 상태를 가져오거나 기존 스냅샷 content를 템플릿으로 구성합니다. |
| filterType | string | 선택적 문자열이며 생성 시 생략하면 빈 값이고 엔터티 64자입니다. 기존 동일 이름 및 동일 type 객체를 강제 덮어쓸 때 이 필드는 무시되고 이전 값이 유지됩니다. null 허용: False 예: 가져오기 또는 입력 방법: 소스 페이지의 스냅샷 필터 분류에서 가져오며 생략할 수 있습니다. |
|
| isForce | boolean | 선택적 부울이며 생략하면 false입니다. 같은 워크스페이스에서 동일 type 및 name에 false를 사용하면 400을 반환합니다. true는 원래 uuid를 재사용하여 content, accountUUID, 쿼리 권한 범위, isPublic을 덮어쓰고 createAt/updateAt을 갱신하지만, 원래 name/type/filterType/creator는 유지합니다. 다른 사람이 생성한 동일 이름 구성을 덮어쓸 수 있으므로 호출자는 대상과 공유 영향을 먼저 확인해야 합니다. null 허용: False 예: false가져오기 또는 입력 방법: 동일 이름 및 동일 type 스냅샷을 재생성하려는 것이 확인된 경우에만 true로 설정하고, 먼저 기존 content와 범위를 백업하세요. |
|
| name | string | Y | 필수 문자열이며, 현재 선언에서는 비어 있지 않음/최대 길이를 강제하지 않습니다. 엔터티 128자이며 1–128자를 권장합니다. 같은 워크스페이스의 동일 type 및 동일 name이 덮어쓰기 검사와 일치하며, 전체 워크스페이스의 모든 type에 걸쳐 통합적으로 고유한 것은 아닙니다. null 허용: False 예: 支付服务日志가져오기 또는 입력 방법: 호출자가 식별 가능한 이름을 선택하며, 동일 유형의 기존 스냅샷에서 이름 중복을 확인할 수 있습니다. |
| type | string | Y | 필수 문자열이며, 저장 측에 고정된 열거형은 없지만 프런트엔드가 해당 페이지 유형을 지원해야만 열 수 있습니다. 임의의 새 유형이 저장에 성공했다고 해서 렌더링 가능하다고 간주할 수 없습니다. null 허용: False 예: Log가져오기 또는 입력 방법: 소스 콘솔 페이지의 스냅샷 구성 또는 기존 동일 페이지 스냅샷의 type에서 가져옵니다. 로그 탐색기에서는 보통 Log를 사용합니다. |
파라미터 추가 설명¶
스냅샷은 페이지 구성과 서버 측 쿼리 범위를 저장합니다. 인터넷 공유는 별도로 공유 구성을 생성해야 하며, snap_, share_, 최초 이동 code와 2단계 token은 서로 다른 식별자입니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/snapshots/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"支付服务日志","type":"Log","content":{"routeName":"Log","routeParams":{"source":"all"},"routeQuery":{"w":"wksp_example","time":"1785423600000,1785427200000","query":"service:payment","cols":"time,message,service","viewType":"view","index":"default","snapshotName":"支付服务日志"}},"isForce":false}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | object | 저장된 스냅샷 엔터티 및 선택적 연관 요약입니다. |
| content.id | integer 또는 null | 데이터베이스 행 ID이며 경로 위치 지정에는 사용되지 않습니다. 제출 전 스냅샷에서는 null일 수 있습니다. |
| content.uuid | string | 스냅샷 UUID이며 snap_ 접두사가 붙습니다. |
| content.status | integer | 리소스 상태이며 일반적으로 0이고, 소프트 삭제된 3은 쿼리에서 제외됩니다. |
| content.creator | string | 최초 생성 주체 UUID입니다. 강제 덮어쓰기가 항상 creator를 변경하지는 않으며, 현재 권한 보유자는 accountUUID에서 확인합니다. |
| content.updator | string | 최근 덮어쓰기/삭제를 수행한 주체입니다. |
| content.createAt | number | Unix 초 단위 생성/재생성 시간입니다. 강제 덮어쓰기는 time.time()을 사용하므로 응답에 소수가 포함될 수 있습니다. |
| content.updateAt | integer | Unix 초 단위 업데이트 시간이며, 업데이트되지 않은 경우 -1일 수 있습니다. |
| content.deleteAt | integer | Unix 초 단위 삭제 시간이며, 삭제되지 않은 경우 일반적으로 -1입니다. |
| content.workspaceUUID | string | 현재 Key가 속한 워크스페이스입니다. |
| content.name | string | 스냅샷 이름이며 동일 워크스페이스 및 동일 type에서 고유하게 매칭됩니다. |
| content.type | string | 페이지 스냅샷 종류(예: Log)이며 저장 측에 공개된 열거형 검증이 없습니다. |
| content.filterType | string | 저장된 필터 분류이며 생성 시 생략하면 빈 값입니다. 동일 이름을 강제 덮어쓸 때 이 필드는 업데이트되지 않습니다. |
| content.isPublic | integer | 1은 워크스페이스 내 공개 표시, 0은 비공개입니다. 인터넷 공개 공유가 아닙니다. 이 공개 생성은 기본값이 1로 고정되며 isPublic 파라미터를 받지 않습니다. |
| content.isHidden | integer | 숨김 플래그이며 0이면 이 목록에 표시될 수 있고, 숨겨진 보고서 스냅샷은 나열되지 않습니다. |
| content.accountUUID | string | 생성/최근 강제 덮어쓰기 시 권한을 수집한 주체 UUID입니다. creator와 다를 수 있습니다. |
| content.content | object | 저장된 페이지/쿼리 구성이며 실제 텔레메트리 데이터의 복사본이 아닙니다. 동적 필드는 해당 페이지 프로토콜에 따라 해석됩니다. |
| content.content.routeName | string | 콘솔 라우트 식별자(예: 로그 탐색기 Log, 히트맵 RumHeatMap)이며 최상위 type과 호환성을 유지합니다. |
| content.content.routeParams | object | 해당 페이지 경로 파라미터 객체입니다. |
| content.content.routeParams.source | string | 로그 탐색기에서는 보통 all을 사용하며, 구체적인 값은 소스 페이지에서 결정됩니다. |
| content.content.routeParams.기타 키 | JSON | 페이지 경로 동적 파라미터이며, 현재 콘솔 페이지에서 생성된 구성을 기준으로 합니다. |
| content.content.routeQuery | object | 해당 페이지 Query 상태이며 반드시 객체여야 합니다. 임의의 클라이언트 쿼리 값은 서버 측에서 이미 캡처한 권한을 확장하지 않습니다. |
| content.content.routeQuery.w | string | 페이지 워크스페이스 식별자이며 보통 현재 워크스페이스입니다. 이를 통해 API Key 범위를 변경할 수 없습니다. |
| content.content.routeQuery.workspaceUUID | string | 페이지에 필요한 쿼리 워크스페이스 목록이며 쉼표로 구분됩니다. 실제 크로스 워크스페이스 권한 및 스냅샷 저장 범위의 제한을 계속 받습니다. |
| content.content.routeQuery.time | string | 페이지 시간 범위이며, 예: 15m 또는 시작 밀리초,종료 밀리초 문자열입니다. 상대 시간은 데이터를 물리적으로 동결하는 것이 아닙니다. |
| content.content.routeQuery.query | string | 페이지 검색 쿼리 문자열이며, 로그 탐색기 예시는 service:payment입니다. 스냅샷 API가 실행하는 DQL이 아닙니다. |
| content.content.routeQuery.cols | string | 표시 필드 이름을 쉼표로 구분합니다(예: time,message,service). |
| content.content.routeQuery.viewType | string | 로그 탐색기에서 흔히 view는 목록, analyze는 분석이며 현재 페이지의 실제 프로토콜을 따릅니다. |
| content.content.routeQuery.index | string | 로그 인덱스 이름을 쉼표로 구분하며 로그 인덱스 구성에서 가져옵니다. 읽기 권한을 변경하지 않습니다. |
| content.content.routeQuery.snapshotName | string | 페이지에 표시되는 스냅샷 이름이며 최상위 name과 일치시키는 것이 좋습니다. |
| content.content.routeQuery.dashboard_id | string | 대시보드 스냅샷에 대응하는 dsbd_ UUID로 가시성 요약에 사용됩니다. 먼저 현재 워크스페이스에서 권한이 부여된 리소스를 확인하세요. |
| content.content.routeQuery.app_id | string | RUM 히트맵의 공개 appId로 애플리케이션 요약을 추가하는 데 사용됩니다. |
| content.content.routeQuery.status | integer | 목록 type=RumHeatMap일 때 현재 RUM 구성 상태가 추가될 수 있으며, 과거에 삭제된 경우에도 나타날 수 있습니다. |
| content.content.routeQuery.jsonContent | object | RUM 히트맵 목록에서만 추가될 수 있는 애플리케이션 jsonContent입니다. |
| content.content.routeQuery.jsonContent.name | string | 애플리케이션 이름입니다. |
| content.content.routeQuery.jsonContent.type | string | 애플리케이션 플랫폼 유형입니다. |
| content.content.routeQuery.jsonContent.extend | object | 선택적 애플리케이션 확장입니다. |
| content.content.routeQuery.jsonContent.extend.사용자 정의 키 | JSON | 애플리케이션에 저장된 확장 값입니다. |
| content.content.routeQuery.기타 키 | JSON | 페이지 필터/레이아웃 등의 동적 상태이며, 백엔드는 주로 저장만 하고 렌더링 가능성은 검증하지 않습니다. |
| content.content.기타 키 | JSON | 해당 페이지의 기타 저장 상태이며, 클라이언트가 서버 측 권한을 주입할 수 있음을 의미하지 않습니다. |
| content.rules | object 또는 null | 서버 측에서 수집한 쿼리 권한/마스킹 스냅샷이며 읽기 전용입니다. 클라이언트는 권한을 얻기 위해 rules를 전달하거나 content에서 위조해서는 안 됩니다. 이전 형식은 다를 수 있습니다. |
| content.rules.eventScopeVersion | integer | 새 권한 이벤트 범위 버전 1입니다. 이전 스냅샷에는 이 키가 없을 수 있으며, 특정 쿼리는 재생성을 요구할 수 있습니다. |
| content.rules.ruleContextVersion | integer | 새 형식은 2이며, 이전 형식은 1이거나 누락될 수 있습니다. |
| content.rules.roles | array<string> |
저장 시 실제 호출 주체의 역할 식별자입니다. 작성 가능한 역할 선택이 아닙니다. |
| content.rules.roles[] | string | 서버가 확인한 단일 역할 ID입니다. |
| content.rules.deniedNamespaces | array<string> |
쿼리 금지 범위입니다. 예: logging/rum/tracing/metric/lineage/keyevent이며, 실제로는 사이트에서 알려진 namespace를 기준으로 합니다. |
| content.rules.deniedNamespaces[] | string | 단일 금지 데이터 범위입니다. |
| content.rules.rules | object | namespace→캡처된 데이터 액세스 규칙 배열입니다. |
| content.rules.rules.네임스페이스 | array<object> |
해당 범위의 규칙이며, 빈 배열이 쿼리 권한을 대신할 수 없습니다. |
| content.rules.rules.네임스페이스[].rule_uuid | string | 원본 액세스 규칙 UUID입니다. |
| content.rules.rules.네임스페이스[].region_code | string | 규칙이 위치한 사이트 식별자입니다. |
| content.rules.rules.네임스페이스[].rule_info | object | 액세스 조건 내용이며 데이터 범위에 따라 해석됩니다. |
| content.rules.rules.네임스페이스[].rule_info.sources | array<string> |
lineage/keyevent 등 범위의 허용 소스이며 원본 규칙 프로토콜을 따릅니다. |
| content.rules.rules.네임스페이스[].rule_info.sources[] | string | 단일 원본 규칙 소스이며 클라이언트의 새 권한이 아닙니다. |
| content.rules.rules.네임스페이스[].rule_info.rule | string | 원본 규칙 필터 표현식입니다. |
| content.rules.rules.네임스페이스[].rule_info.기타 키 | JSON | 해당 범위 원본 데이터 규칙의 기타 필드입니다. |
| content.rules.rules.네임스페이스[].rule_mask_info | object | 원본 데이터 액세스 규칙에 포함될 수 있는 마스킹 정보입니다. |
| content.rules.rules.네임스페이스[].rule_mask_info.maskFields | string | 쉼표로 구분된 필드입니다. |
| content.rules.rules.네임스페이스[].rule_mask_info.reExprs | array<object> |
정규식 구성입니다. |
| content.rules.rules.네임스페이스[].rule_mask_info.reExprs[].reExpr | string | 마스킹 정규식입니다. |
| content.rules.rules.네임스페이스[].기타 키 | JSON | 원본 액세스 규칙의 예약 필드이며, 이 인터페이스에서 새로 실행되는 파라미터가 아닙니다. |
| content.rules.sensitiveDataMaskRules | object | namespace→민감 필드 규칙 배열입니다(이전 빈 객체 호환). |
| content.rules.sensitiveDataMaskRules.네임스페이스 | array 또는 object | 새 형식에서 비어 있지 않으면 규칙 객체 배열이어야 하며, 빈 객체는 규칙 없음과 호환됩니다. |
| content.rules.sensitiveDataMaskRules.네임스페이스[].fields | array<string> |
원본 민감 필드 목록입니다. |
| content.rules.sensitiveDataMaskRules.네임스페이스[].fields[] | string | 필드 이름입니다. |
| content.rules.sensitiveDataMaskRules.네임스페이스[].reExpr | string 또는 null | 원본 민감 데이터 마스킹 정규식입니다. |
| content.rules.sensitiveDataMaskRules.네임스페이스[].기타 키 | JSON | 원본 규칙의 기타 필드입니다. |
| content.dashboardIsPublic | integer 또는 boolean | 선택적 연관 대시보드 가시성 힌트이며, 연관 대시보드가 있을 때만 추가될 수 있습니다. 스냅샷 공유 권한과 동일하지 않습니다. |
| content.declaration | object 또는 null | 현재 워크스페이스의 공개 선언입니다. |
{
"code": 200,
"content": {
"id": null,
"uuid": "snap_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支付服务日志",
"type": "Log",
"filterType": "",
"isPublic": 1,
"isHidden": 0,
"accountUUID": "wsak_example",
"content": {
"routeName": "Log",
"routeParams": {
"source": "all"
},
"routeQuery": {
"w": "wksp_example",
"time": "1785423600000,1785427200000",
"query": "service:payment",
"cols": "time,message,service",
"viewType": "view",
"index": "default",
"snapshotName": "支付服务日志"
}
},
"rules": {
"eventScopeVersion": 1,
"ruleContextVersion": 2,
"roles": [
"wsAdmin"
],
"rules": {},
"sensitiveDataMaskRules": {},
"deniedNamespaces": []
},
"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 파일 형식 오류 | content 객체가 포함된 스냅샷 파라미터를 제출합니다. |
| 400 | ft.SnapshotRepeatNames | 워크스페이스 내 동일 type 및 동일 name이 있고 isForce가 켜지지 않음 | 스냅샷 이름 중복 | 먼저 대상을 조회하고 덮어쓰기 영향을 확인한 후에만 명시적으로 isForce=true로 설정합니다. |
| 403 | ft.SnapshotQueryScopeUnavailable | 현재 서버 측 권한/규칙 컨텍스트를 안전하게 캡처하거나 검증할 수 없음 | 공유 액세스 범위가 불완전하거나 이 쿼리가 허용되지 않습니다. 공유자가 재생성해야 합니다. | 관리자는 현재 Key의 쿼리 권한/규칙을 확인하고, 대상 범위에 대한 유효한 주체로 재생성해야 하며, content에 권한을 주입하여 우회할 수 없습니다. |
| 401 | ft.WKSPNotExistOrReleased | 생성 시 현재 활성 워크스페이스를 읽지 못함 | 워크스페이스가 존재하지 않거나 이미 해제됨 | Key 워크스페이스가 여전히 활성 상태인지 확인합니다. |
| 500 | ft.InternalServerError | 스냅샷/권한 규칙 읽기 및 쓰기, 저장 후 연관 대시보드 요약 또는 컨텍스트 제출 등에서 처리되지 않은 예외 | 내부 오류 | 먼저 type/name으로 스냅샷을 읽어 저장된 content/권한 범위를 확인하고, 무분별한 isForce 덮어쓰기를 피하며 traceId를 보존하여 추적에 활용합니다. |