콘텐츠로 이동

목록 조회



GET /api/v1/log_backup_cfg/list

개요

현재 워크스페이스의 데이터 전송 규칙과 작업 상태를 페이지 단위로 나열합니다.

호출 전 및 사용 단계

삭제되지 않은 모든 규칙(비활성화 및 deleting 상태의 레코드 포함)을 반환하며, 최종 수정/생성 시간 내림차순으로 정렬한 후 id 내림차순으로 정렬합니다. 대상, 유형, 형식, 아카이브 클래스 및 규칙 이름으로 필터링할 수 있습니다. OpenAPI 목록에는 Front 전용 accessCfg 요약이 포함되지 않으므로 연결 정보는 상세 조회 API를 사용하십시오. Iceberg 형식은 제외됩니다.

목록은 readPermissionSet에 따라 규칙 구성을 필터링하지 않으며, 이 권한은 주로 데이터 조회 작업 시 검증됩니다. duration은 워크스페이스 backup_log 보존 기간을 표시하며, 외부 버킷 수명 주기나 각 규칙의 개별 기간이 아닙니다. taskStatusCode/taskErrorCode는 백그라운드 데이터 전송 작업에서 제공되며, 저장 성공이 작업의 성공적 실행을 의미하지는 않습니다.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 유형 필수 설명
dataType commaArray 선택적 정확한 유형 필터이며, 과거의 빈 dataType을 자동으로 logging으로 간주하여 필터에 포함하지 않습니다.
null 허용: False
$commaArrayIn: ['lineage', 'metric', 'llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am']
예시: logging
가져오기 또는 입력 방법: 실제 규칙 데이터 카테고리에 따라 필터링하며, 여러 값은 쉼표로 구분합니다.
pageIndex integer 선택 사항, 기본값 1, 최소 1입니다.
null 허용: False
$minValue: 1
예시: 1
가져오기 또는 입력 방법: 1부터 시작하며, 최상위 pageInfo에 따라 계속 조회합니다.
pageSize integer 선택 사항, 기본값 10, 최대 100입니다.
null 허용: False
$maxValue: 100
$minValue: 1
예시: 10
가져오기 또는 입력 방법: 페이지당 1~100 범위에서 선택합니다.
search string 선택 사항이며 name 포함 일치로 필터링하고, 대상 버킷 또는 UUID로 검색하지 않습니다. 앞뒤 공백 제거를 보장하지 않습니다.
빈 문자열 허용: True
null 허용: False
예시: production
가져오기 또는 입력 방법: 규칙 이름 키워드입니다.
storageClass commaArray 선택 사항이며 여러 항목을 쉼표로 구분합니다. 통일된 고정 열거형이 아닙니다.
빈 문자열 허용: True
null 허용: False
예시: STANDARD
가져오기 또는 입력 방법: 실제 규칙 또는 대상 공급업체의 아카이브 코드에서 값을 가져옵니다.
storageFormat commaArray 선택 사항이며 Iceberg는 공개 목록에 없습니다. Kafka/LogBamboo는 형식이 비어 있을 수 있으며, 값을 입력하지 않으면 표시될 수 있습니다.
null 허용: False
$commaArrayIn: ['json', 'parquet']
예시: json,parquet
가져오기 또는 입력 방법: 공개 파일 형식이며, 여러 값은 쉼표로 구분합니다.
storeType commaArray 선택 사항이며, 생략하면 삭제되지 않은 모든 규칙을 조회합니다. Iceberg는 항상 제외되며, 과거 TiDB는 대상 기준 필터링이 없을 때 나타날 수 있습니다.
null 허용: False
$commaArrayIn: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris', 'logbamboo']
예시: s3,kafka
가져오기 또는 입력 방법: 이 페이지에 공개된 대상 유형 중에서 선택하며, 여러 값은 영문 쉼표로 구분합니다.

파라미터 추가 설명

데이터 설명.*

  • 요청 파라미터 설명
파라미터 이름 type 설명
search string 규칙 이름 검색
storeType commaArray 규칙 저장 유형 필터링, 여러 값은 영문 쉼표로 구분
dataType commaArray 데이터 유형, 여러 값은 영문 쉼표로 구분
storageFormat commaArray 저장 형식, 여러 값은 영문 쉼표로 구분
storageClass commaArray 아카이브 유형, 여러 값은 영문 쉼표로 구분
pageIndex string 페이지 번호
pageSize string 페이지당 반환 수

요청 예시

curl --get 'https://openapi.guance.com/api/v1/log_backup_cfg/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode dataType=logging \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=10

응답

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

필드 유형 설명
content.data array<object> 이 페이지의 규칙 배열이며, 결과가 없으면 []입니다.
content.data[].id integer 또는 null 레코드 번호입니다. 생성 스냅샷은 제출 전에 생성되어 null일 수 있으며, 호출 시에는 uuid를 사용합니다.
content.data[].uuid string lgbp_규칙 UUID입니다.
content.data[].workspaceUUID string 소속 워크스페이스입니다.
content.data[].name string 규칙 이름이며, 생성 후 이 공개 수정 API에서는 이름을 변경할 수 없습니다.
content.data[].conditions string extend.filters에서 생성된 조건이며, 추가 필터가 없으면 빈 문자열 또는 {}입니다.
content.data[].syncExtensionField boolean 확장 필드 동기화 여부입니다.
content.data[].externalResourceAccessCfgUUID string 액세스 구성 식별자이며 자격 증명은 아닙니다.
content.data[].storeType string 저장된 대상 유형이며, 과거 TiDB는 읽을 수 있지만 현재 OpenAPI에서는 생성할 수 없습니다.
content.data[].storageClass string 대상 아카이브 클래스입니다.
content.data[].storageFormat string json/parquet이며 Kafka 또는 LogBamboo는 비어 있을 수 있습니다. Iceberg는 이 공개 목록/상세에서 제외됩니다.
content.data[].dataType string 규칙에 고정된 데이터 카테고리이며, 과거 빈 값은 logging으로 처리됩니다.
content.data[].taskStatusCode integer 백그라운드 데이터 전송 작업이 보고한 상태이며, 생성 시 일반적으로 -1이고 현재 HTTP 상태가 아닙니다.
content.data[].taskErrorCode string 백그라운드 데이터 전송 오류 코드이며, 빈 문자열은 현재 오류 기록이 없음을 의미합니다. 저장 성공이 작업 성공을 보장하지 않습니다.
content.data[].openPermissionSet boolean 데이터 읽기 사용자 지정 권한 스위치입니다.
content.data[].readPermissionSet array<string> 저장된 읽기 주체입니다.
content.data[].readPermissionSet[] string 개별 역할/멤버/팀 식별자입니다.
content.data[].deleteStatus string 삭제 처리 상태이며, deleting은 내장 스토리지 규칙이 비동기 삭제 중임을 의미하고, 과거 값은 비어 있거나 completed일 수 있습니다.
content.data[].status integer 0 사용, 2 사용 안 함, 3 삭제입니다.
content.data[].creator string 생성 주체입니다.
content.data[].updator string 수정 주체이며 초기에는 비어 있을 수 있습니다.
content.data[].createAt integer 생성 Unix 초입니다.
content.data[].updateAt integer 수정 Unix 초이며, 수정되지 않은 경우 -1입니다.
content.data[].deleteAt integer 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다.
content.data[].extend object 저장된 범위/조건 구성입니다. 선택 사항이며 생성 시 일반적으로 {}입니다. 수정 시 전체 교체로 전달되며, 기존 인덱스 선택에는 별도의 상속 규칙이 있으므로 사용 설명을 참조하십시오. 생략하면 유지됩니다. 생성 시 null을 전달하면 이후 extend.get에서 500이 발생할 수 있습니다. 수정 시 명시적 null은 {}로 전체 교체되지만, 신규 버전 인덱스 선택의 별도 상속 규칙은 여전히 유지됩니다.
content.data[].extend.filters array 저장된 범위/조건 구성: 실제 필터 조건 배열입니다. []는 추가 필드 조건이 없음을 의미하며 전체 클래스를 전송할 수 있습니다. match/not match 및 그 정규화 별칭은 거부되며, 로그 인덱스 advancedFilter 구조를 여기에 혼합하지 않습니다.
content.data[].extend.filters[] json 저장된 범위/조건 구성: 전체 name/condition/operation/value 사용을 권장하며, query_task.search 구조가 아닙니다.
content.data[].extend.filters[].name string 저장된 범위/조건 구성: 실제 필드 키입니다.
content.data[].extend.filters[].condition string 저장된 범위/조건 구성: and/or는 이전 조건과의 관계이며 첫 항목에서는 무시됩니다.
content.data[].extend.filters[].operation string 저장된 범위/조건 구성: 일반적으로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. match/contain 계열은 지원되지 않습니다.
content.data[].extend.filters[].value array 저장된 범위/조건 구성: 일치 값이며, 동등/비교는 첫 항목을 사용하고 집합 연산은 여러 항목을 사용합니다.
content.data[].extend.filters[].value[] JSON 저장된 범위/조건 구성: 단일 문자열/숫자이며 실제 유형을 유지합니다.
content.data[].extend.indexs array 저장된 범위/조건 구성: 로그 원시 직접 쓰기 인덱스 이름 배열입니다. 신규 버전의 []는 해당 클래스 전체를 의미하고, 비어 있지 않으면 지정을 의미합니다. 구버전 프로토콜에서 regularLogIndexNames가 없을 때 동작이 다르므로 사용법을 참조하십시오. UUID 배열이 아닙니다.
content.data[].extend.indexs[] string 저장된 범위/조건 구성: 실제 이름이며 trim 후 중복 제거됩니다. 신규 버전에서 추가 선택은 현재 사용 가능한 카탈로그에 있어야 합니다.
content.data[].extend.regularLogIndexNames array 또는 null 저장된 범위/조건 구성: 로그에만 해당하는 신규 버전 일반 인덱스 선택입니다. []는 일반 클래스 전체, 비어 있지 않으면 지정을 의미하며, null을 indexs 배열과 함께 전달하면 직접 쓰기만 의미합니다. 수정 시 이 키만 null로 전달하면 인덱스 제한이 제거됩니다. 이 키가 없으면 구버전 프로토콜이거나 수정 시 유지를 의미하므로 사용 설명을 참조하십시오.
content.data[].extend.regularLogIndexNames[] string 저장된 범위/조건 구성: 현재 선택 가능한 단일 일반 인덱스 이름이며, 복제 시에는 원본 A가 유효해야 합니다. UUID가 아닙니다.
content.data[].creatorInfo object 연결된 주체 요약이며, 일치 항목이 없으면 {}입니다.
content.data[].creatorInfo.uuid string 주체 UUID이며, 생략될 수 있습니다.
content.data[].creatorInfo.status integer 계정 상태이며, 생략될 수 있습니다.
content.data[].creatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태이며, 생략될 수 있습니다.
content.data[].creatorInfo.name string 표시 이름입니다.
content.data[].creatorInfo.username string 로그인 이름입니다.
content.data[].creatorInfo.email string 이메일 또는 시스템 ID입니다.
content.data[].creatorInfo.mobile string 휴대폰 번호이며, 비어 있을 수 있습니다.
content.data[].creatorInfo.countryCode string 국가/지역 코드이며, 생략될 수 있습니다.
content.data[].creatorInfo.iconUrl string 프로필 이미지 URL이며, 생략될 수 있습니다.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임이며, 생략될 수 있습니다.
content.data[].updatorInfo object 연결된 주체 요약이며, 일치 항목이 없으면 {}입니다.
content.data[].updatorInfo.uuid string 주체 UUID이며, 생략될 수 있습니다.
content.data[].updatorInfo.status integer 계정 상태이며, 생략될 수 있습니다.
content.data[].updatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태이며, 생략될 수 있습니다.
content.data[].updatorInfo.name string 표시 이름입니다.
content.data[].updatorInfo.username string 로그인 이름입니다.
content.data[].updatorInfo.email string 이메일 또는 시스템 ID입니다.
content.data[].updatorInfo.mobile string 휴대폰 번호이며, 비어 있을 수 있습니다.
content.data[].updatorInfo.countryCode string 국가/지역 코드이며, 생략될 수 있습니다.
content.data[].updatorInfo.iconUrl string 프로필 이미지 URL이며, 생략될 수 있습니다.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임이며, 생략될 수 있습니다.
content.data[].readPermissionSetInfo object 읽기 주체가 비어 있지 않으면 식별자→요약 매핑을 제공하고, 해석 가능한 식별자가 없으면 {}이며, 빈 배열이면 생략될 수 있습니다.
content.data[].readPermissionSetInfo.주체 object 멤버 요약 또는 역할/팀 name/status 요약이며, 이 주체가 여전히 유효함을 보장하지 않습니다.
content.data[].readPermissionSetInfo.주체.name string 역할/팀/멤버 표시 이름입니다.
content.data[].readPermissionSetInfo.주체.status integer 주체 상태이며, 생략될 수 있습니다.
content.data[].allow_operation boolean 또는 null 공유 권한 엔진의 작업 표시이며, 작업 주체가 구성되지 않은 경우 null일 수 있고, API 권한 검증을 대체하지 않습니다.
content.data[].readPermissionSetInfo.주체.uuid string 주체 UUID이며, 생략될 수 있습니다.
content.data[].readPermissionSetInfo.주체.wsAccountStatus integer 워크스페이스 멤버 상태이며, 생략될 수 있습니다.
content.data[].readPermissionSetInfo.주체.username string 로그인 이름입니다.
content.data[].readPermissionSetInfo.주체.email string 이메일 또는 시스템 ID입니다.
content.data[].readPermissionSetInfo.주체.mobile string 휴대폰 번호이며, 비어 있을 수 있습니다.
content.data[].readPermissionSetInfo.주체.countryCode string 국가/지역 코드이며, 생략될 수 있습니다.
content.data[].readPermissionSetInfo.주체.iconUrl string 프로필 이미지 URL이며, 생략될 수 있습니다.
content.data[].readPermissionSetInfo.주체.acntWsNickname string 워크스페이스 닉네임이며, 생략될 수 있습니다.
content.data[].duration string 또는 null 워크스페이스 backup_log 보존 기간이며, 구성되지 않았을 수 있습니다.
content.declaration object 워크스페이스 공통 선언입니다.
pageInfo.pageIndex integer 현재 페이지입니다.
pageInfo.pageSize integer 페이지당 항목 수입니다.
pageInfo.count integer 이 페이지의 항목 수입니다.
pageInfo.totalCount integer 필터 조건에 맞는 전체 수입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 100,
        "uuid": "lgbp_example",
        "workspaceUUID": "wksp_example",
        "name": "production_archive",
        "conditions": "",
        "extend": {
          "filters": [],
          "regularLogIndexNames": [
            "default"
          ]
        },
        "syncExtensionField": false,
        "externalResourceAccessCfgUUID": "erac_example",
        "storeType": "s3",
        "storageFormat": "json",
        "storageClass": "STANDARD",
        "dataType": "logging",
        "taskStatusCode": -1,
        "taskErrorCode": "",
        "openPermissionSet": false,
        "readPermissionSet": [],
        "deleteStatus": "",
        "status": 0,
        "creator": "wsak_example",
        "updator": "wsak_example",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "duration": "180d",
        "creatorInfo": {},
        "updatorInfo": {},
        "allow_operation": null
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표와 예시를 확인하십시오.
500 ft.InternalServerError 구성, ID 정보, 캐시 또는 응답 형식 읽기 실패 내부 오류 조회 파라미터를 확인하고, 계속 실패하면 traceId를 제공하십시오.

문서 평가

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