콘텐츠로 이동

목록 조회



GET /api/v1/snapshots/list

개요

현재 Key에서 볼 수 있는 페이지 스냅샷을 페이지 단위로 읽습니다.

호출 전 및 사용 단계

현재 Key에는 routine.defaultAccess가 필요하며 현재 Key 워크스페이스만 대상으로 합니다. 공개 API는 교차 워크스페이스/filterType/needPaging/정렬 파라미터를 허용하지 않습니다. isHidden=0이고 삭제되지 않았으며 isPublic=1이거나 비공개 생성자가 현재 Key 주체와 동일한 스냅샷만 나열합니다. 현재 Key 생성자가 현재 호출 주체가 아니면 해당 생성자의 비공개 스냅샷을 자동으로 상속하지 않습니다. id 기준 내림차순이며 기본 pageSize=100이고 예시의 10은 기본값이 아닙니다.

content는 data/declaration/workspaceVersionType 객체를 유지하며 pageInfo는 응답 최상위에 있습니다. type=RumHeatMap이면 RUM 상태/jsonContent가 추가되며, 다른 유형에는 dashboardIsPublic이 추가될 수 있습니다. 표시 요약은 추가 액세스 권한이 아니며, 과거에 삭제된 앱에도 요약이 있을 수 있습니다. 조회는 설정과 저장된 범위만 반환하고 스냅샷 내 쿼리를 실행하지 않으며 공유 설정/공유 코드도 반환하지 않습니다. 이전 규칙 형식은 이후의 모든 namespace를 조회할 수 있다는 의미가 아니며, 공유 액세스 시 재생성이 요구될 수 있습니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터명 유형 필수 설명
pageIndex integer 선택 사항, >=1, 기본값 1, 클라이언트는 정수 문자열을 사용합니다.
null 허용: False
$minValue: 1
예시: 1
획득 또는 입력 방법: 최상위 pageInfo에 따라 페이지를 나눕니다.
pageSize integer 선택 사항, 1–100, 기본값 100, 이전 예시의 10을 기본값으로 오해하지 마십시오.
null 허용: False
$maxValue: 100
$minValue: 1
예시: 100
획득 또는 입력 방법: 읽기량에 따라 페이지 크기를 제어합니다.
search string 선택 사항, 앞뒤 공백을 제거한 SQL LIKE 퍼지 매칭이며 %/_는 와일드카드 의미를 유지합니다.
null 허용: False
예시: 支付
획득 또는 입력 방법: 호출자가 이름으로 검색합니다.
type string 선택 사항인 정확한 필터링 문자열, 앞뒤 공백 제거, 생략/빈 값이면 필터링하지 않음, 통일된 공개 열거형은 없습니다.
null 허용: False
예시: Log
획득 또는 입력 방법: 해당 페이지 또는 기존 스냅샷 type에서 가져옵니다(예: Log/RumHeatMap).

파라미터 추가 설명

스냅샷은 페이지 구성과 서버 측 쿼리 범위를 저장합니다. 인터넷 공유는 별도로 공유 구성을 생성해야 하며, snap_, share_, 첫 번째 홉 code와 두 번째 세그먼트 token은 서로 다른 식별자입니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/snapshots/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode type=Log \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=100

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여 줍니다.

필드 유형 설명
content object 페이지 콘텐츠 객체입니다.
content.data array<object> 이 페이지에서 볼 수 있는 스냅샷이며 일치하는 항목이 없으면 []입니다.
content.data[].id integer 또는 null 데이터베이스 행 ID이며 경로 위치 지정에 사용되지 않습니다. 제출 전 스냅샷은 null일 수 있습니다.
content.data[].uuid string 스냅샷 UUID, snap_ 접두사입니다.
content.data[].status integer 리소스 상태, 일반적으로 0이며 소프트 삭제 3은 쿼리에서 제외됩니다.
content.data[].creator string 최초 생성 주체 UUID입니다. 강제 덮어쓰기가 creator를 반드시 변경하지는 않으며, 현재 권한 보유자는 accountUUID를 봅니다.
content.data[].updator string 최근 덮어쓰기/삭제 업데이트 주체입니다.
content.data[].createAt number Unix 초 단위 생성/재생성 시간입니다. 강제 덮어쓰기에 time.time()을 사용하면 응답에 소수점이 포함될 수 있습니다.
content.data[].updateAt integer Unix 초 단위 업데이트 시간이며 업데이트되지 않은 경우 -1일 수 있습니다.
content.data[].deleteAt integer Unix 초 단위 삭제 시간이며 삭제되지 않은 경우 일반적으로 -1입니다.
content.data[].workspaceUUID string 현재 Key가 속한 워크스페이스입니다.
content.data[].name string 스냅샷 이름이며 동일 워크스페이스 및 동일 type에서 고유하게 일치합니다.
content.data[].type string 페이지 스냅샷 종류, Log 등이며 저장 측에서 공개 열거형으로 검증하지 않습니다.
content.data[].filterType string 저장된 필터 분류입니다. 생성 시 생략하면 비어 있으며, 동일 이름을 강제 덮어쓸 때 이 필드는 업데이트되지 않습니다.
content.data[].isPublic integer 1은 워크스페이스 내 공개 표시, 0은 비공개입니다. 인터넷 공개 공유가 아닙니다. 이 공개 생성은 기본값 1로 고정되며 isPublic 파라미터를 받지 않습니다.
content.data[].isHidden integer 숨김 표시이며 0이면 이 목록에 나열될 수 있고, 숨겨진 보고서 스냅샷은 나열되지 않습니다.
content.data[].accountUUID string 생성/최근 강제 덮어쓰기 시 권한을 수집한 주체 UUID이며 creator와 다를 수 있습니다.
content.data[].content object 저장된 페이지/쿼리 구성이며 실제 텔레메트리 데이터의 복사본이 아닙니다. 동적 필드는 해당 페이지 프로토콜에 따라 해석합니다.
content.data[].content.routeName string 콘솔 라우트 식별자, 예: 로그 탐색기 Log, 히트맵 RumHeatMap. 최상위 type과 호환성을 유지합니다.
content.data[].content.routeParams object 해당 페이지 경로 파라미터 객체입니다.
content.data[].content.routeParams.source string 로그 탐색기에서 일반적으로 all을 사용하며 구체적인 값은 소스 페이지에서 결정됩니다.
content.data[].content.routeParams.기타 키 JSON 페이지 경로 동적 파라미터이며 현재 콘솔 페이지에서 생성된 구성이 기준입니다.
content.data[].content.routeQuery object 해당 페이지 Query 상태이며 반드시 객체여야 합니다. 임의의 클라이언트 쿼리 값이 서버에서 이미 캡처한 권한을 확장하지 않습니다.
content.data[].content.routeQuery.w string 페이지 워크스페이스 식별자, 일반적으로 현재 워크스페이스이며 이를 통해 API Key 범위를 변경할 수 없습니다.
content.data[].content.routeQuery.workspaceUUID string 페이지에 필요한 쿼리 워크스페이스 목록, 쉼표로 구분되며 실제 교차 워크스페이스 권한 및 스냅샷 저장 범위의 제한을 계속 받습니다.
content.data[].content.routeQuery.time string 페이지 시간 범위, 예: 15m 또는 시작 밀리초,종료 밀리초 문자열입니다. 상대 시간은 물리적으로 고정된 데이터가 아닙니다.
content.data[].content.routeQuery.query string 페이지 검색 쿼리 문자열, 로그 탐색기 예시 service:payment. 스냅샷 API가 실행하는 DQL이 아닙니다.
content.data[].content.routeQuery.cols string 표시 필드 이름 쉼표 구분, 예: time,message,service.
content.data[].content.routeQuery.viewType string 로그 탐색기에서 흔히 view 목록/analyze 분석이며 현재 페이지의 실제 프로토콜을 따릅니다.
content.data[].content.routeQuery.index string 로그 인덱스 이름 쉼표 구분, 로그 인덱스 구성에서 가져오며 읽기 권한을 변경하지 않습니다.
content.data[].content.routeQuery.snapshotName string 페이지에 표시되는 스냅샷 이름이며 최상위 name과 일치시키는 것이 좋습니다.
content.data[].content.routeQuery.dashboard_id string 대시보드 스냅샷에 대응하는 dsbd_ UUID, 표시 가능성 요약에 사용됩니다. 먼저 현재 워크스페이스의 권한 리소스를 확인하십시오.
content.data[].content.routeQuery.app_id string RUM 히트맵의 공개 appId, 앱 요약 추가에 사용됩니다.
content.data[].content.routeQuery.status integer 목록 type=RumHeatMap일 때 현재 RUM 구성 상태가 추가될 수 있으며 과거에 삭제된 경우에도 나타날 수 있습니다.
content.data[].content.routeQuery.jsonContent object RUM 히트맵 목록에서만 추가될 수 있는 앱 jsonContent입니다.
content.data[].content.routeQuery.jsonContent.name string 앱 이름입니다.
content.data[].content.routeQuery.jsonContent.type string 앱 플랫폼 유형입니다.
content.data[].content.routeQuery.jsonContent.extend object 선택적 앱 확장입니다.
content.data[].content.routeQuery.jsonContent.extend.사용자 정의 키 JSON 앱에 저장된 확장 값입니다.
content.data[].content.routeQuery.기타 키 JSON 페이지 필터/레이아웃 등 동적 상태이며 백엔드는 주로 저장만 하고 렌더링 가능 여부를 검증하지 않습니다.
content.data[].content.기타 키 JSON 해당 페이지의 기타 저장 상태이며 클라이언트가 서버 권한을 주입할 수 있음을 의미하지 않습니다.
content.data[].rules object 또는 null 서버에서 수집한 쿼리 권한/마스킹 스냅샷, 읽기 전용입니다. 클라이언트는 rules를 전달하거나 content에서 위조하여 권한을 얻을 수 없습니다. 이전 형식은 다를 수 있습니다.
content.data[].rules.eventScopeVersion integer 새 권한 이벤트 범위 버전 1, 이전 스냅샷에는 이 키가 없을 수 있으며 특정 쿼리에서 재생성이 요구될 수 있습니다.
content.data[].rules.ruleContextVersion integer 새 형식 2, 이전 형식은 1이거나 누락될 수 있습니다.
content.data[].rules.roles array<string> 저장 시 실제 호출 주체의 역할 식별자이며 쓰기 가능한 역할 선택이 아닙니다.
content.data[].rules.roles[] string 서버에서 확인한 단일 역할 ID입니다.
content.data[].rules.deniedNamespaces array<string> 쿼리 금지 범위, 예: logging/rum/tracing/metric/lineage/keyevent, 실제로는 사이트에서 알려진 namespace를 기준으로 합니다.
content.data[].rules.deniedNamespaces[] string 단일 금지 데이터 범위입니다.
content.data[].rules.rules object namespace→캡처된 데이터 액세스 규칙 배열입니다.
content.data[].rules.rules.네임스페이스 array<object> 해당 범위의 규칙이며 빈 배열은 쿼리 권한을 대신할 수 없습니다.
content.data[].rules.rules.네임스페이스[].rule_uuid string 원본 액세스 규칙 UUID입니다.
content.data[].rules.rules.네임스페이스[].region_code string 규칙이 위치한 사이트 식별자입니다.
content.data[].rules.rules.네임스페이스[].rule_info object 액세스 조건 내용이며 데이터 범위에 따라 해석합니다.
content.data[].rules.rules.네임스페이스[].rule_info.sources array<string> lineage/keyevent 등 범위의 허용 소스이며 원본 규칙 프로토콜을 따릅니다.
content.data[].rules.rules.네임스페이스[].rule_info.sources[] string 단일 원본 규칙 소스이며 클라이언트의 새 권한이 아닙니다.
content.data[].rules.rules.네임스페이스[].rule_info.rule string 원본 규칙 필터 표현식입니다.
content.data[].rules.rules.네임스페이스[].rule_info.기타 키 JSON 해당 범위 원본 데이터 규칙의 기타 필드입니다.
content.data[].rules.rules.네임스페이스[].rule_mask_info object 선택적 원본 데이터 액세스 규칙의 마스킹 정보입니다.
content.data[].rules.rules.네임스페이스[].rule_mask_info.maskFields string 쉼표로 구분된 필드입니다.
content.data[].rules.rules.네임스페이스[].rule_mask_info.reExprs array<object> 정규식 구성입니다.
content.data[].rules.rules.네임스페이스[].rule_mask_info.reExprs[].reExpr string 마스킹 정규식입니다.
content.data[].rules.rules.네임스페이스[].기타 키 JSON 원본 액세스 규칙의 보존 필드이며 이 인터페이스의 새 실행 파라미터가 아닙니다.
content.data[].rules.sensitiveDataMaskRules object namespace→민감 필드 규칙 배열(이전 빈 객체 호환).
content.data[].rules.sensitiveDataMaskRules.네임스페이스 array 또는 object 새 형식의 비어 있지 않은 값은 규칙 객체 배열이어야 하며, 빈 객체는 규칙 없음과 호환됩니다.
content.data[].rules.sensitiveDataMaskRules.네임스페이스[].fields array<string> 원본 민감 필드 목록입니다.
content.data[].rules.sensitiveDataMaskRules.네임스페이스[].fields[] string 필드 이름입니다.
content.data[].rules.sensitiveDataMaskRules.네임스페이스[].reExpr string 또는 null 원본 민감 데이터 마스킹 정규식입니다.
content.data[].rules.sensitiveDataMaskRules.네임스페이스[].기타 키 JSON 원본 규칙의 기타 필드입니다.
content.data[].dashboardIsPublic integer 또는 boolean 선택적 연관 대시보드 표시 가능성 힌트이며 연관 대시보드가 존재할 때만 추가될 수 있습니다. 스냅샷 공유 권한과 같지 않습니다.
content.workspaceVersionType string 현재 워크스페이스 제품 버전 유형, 실제 배포 값이며 이 필드만으로 공유 기능을 부여할 수 없습니다.
pageInfo object 페이지 메타 정보, OpenAPI에서는 최상위에 있으며 content는 객체를 유지합니다.
pageInfo.count integer 이 페이지의 실제 건수입니다.
pageInfo.totalCount integer 현재 표시 가능성 및 필터 조건을 충족하는 스냅샷 총수이며 공유 구성 또는 텔레메트리 레코드 수가 아닙니다.
pageInfo.pageIndex integer 페이지 번호, 1부터 시작합니다.
pageInfo.pageSize integer 이번 요청의 페이지당 수량입니다.
content.declaration object 또는 null 현재 워크스페이스 공통 선언, content 상위 객체에만 추가되며 data 항목에 재귀적으로 추가되지 않습니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 7,
        "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": []
        }
      }
    ],
    "workspaceVersionType": "pay",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "count": 1,
    "totalCount": 1,
    "pageIndex": 1,
    "pageSize": 100
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방식
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표 및 예시를 확인하십시오.
500 ft.InternalServerError 데이터베이스/현재 워크스페이스 상태, 이전 스냅샷 content 형상 또는 페이지 변환 등 처리되지 않은 예외 내부 오류 Query/이전 페이지 구성을 확인하고 traceId를 보관한 채 백오프하십시오. 모든 저장 객체가 현재 프런트엔드 버전에서 렌더링될 수 있는 것은 아닙니다.

문서 평가

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