콘텐츠로 이동

조회



GET /api/v1/log_backup_cfg/{cfg_uuid}/get

개요

단일 데이터 전송 규칙의 구성, 마스킹된 연결 및 ID 요약을 조회합니다.

호출 전 및 사용 단계

목록에서 cfg_uuid를 선택하면 삭제되지 않았고 deleting 상태가 아닌 규칙을 반환하며, Iceberg는 존재하지 않는 것으로 처리합니다. 상세 정보에는 대상 연결의 비밀 정보가 아닌 구성이 표시됩니다. 최상위 SK/비밀번호/서비스 계정 JSON은 반환하지 않으며, LogBamboo 중첩 Token은 구성된 경우 마스크만 적용되고, 기존 TiDB DSN도 마스크만 적용됩니다. 전체 상세 정보를 그대로 다시 전송하여 수정하지 말고, 이 페이지에 공개된 Body 필드를 사용하며 자격 증명 상속 규칙에 따라 구성하십시오.

이 엔드포인트에서 규칙 구성을 조회할 수 있다고 해서 전송된 데이터를 읽을 권한이 있다는 의미는 아니며, 실제 쿼리 작업에서는 대상과 readPermissionSet을 추가로 검증합니다.

경로 파라미터

파라미터 이름 유형 필수 설명
cfg_uuid string Y 이 워크스페이스에서 삭제되지 않았고 deleting 상태가 아닌 규칙 UUID이며, name이 아닙니다.
예: lgbp_example
조회 또는 입력 방법: 데이터 전송 규칙 목록의 content.data[].uuid에서 가져옵니다.

요청 헤더

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

파라미터 추가 설명

응답 본문 구조 설명

파라미터 이름 type 설명
accessCfg dict 서드파티 스토리지 구성 정보
name string 데이터 전송 규칙 이름
uuid string 데이터 전송 규칙의 고유 uuid
status string 데이터 전송 규칙 상태, 0: 활성화됨, 2: 비활성화됨
dataType string 데이터 유형
conditions string dql 형식의 필터 조건
storeType string 스토리지 유형
externalResourceAccessCfgUUID string 외부 리소스 액세스 구성 UUID
workspaceUUID string 데이터 전송 규칙이 속한 워크스페이스 UUID

요청 예시

curl --get 'https://openapi.guance.com/api/v1/log_backup_cfg/lgbp_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content.id integer 또는 null 레코드 번호이며, 생성 스냅샷은 제출 전에 생성되어 null일 수 있습니다. 호출에는 uuid를 사용합니다.
content.uuid string lgbp_규칙UUID.
content.workspaceUUID string 소속 워크스페이스.
content.name string 규칙 이름. 생성 후에는 이 공개 수정 API에서 이름을 변경할 수 없습니다.
content.conditions string extend.filters에서 생성된 조건. 추가 필터가 없으면 빈 문자열 또는 {}입니다.
content.syncExtensionField boolean 확장 필드 동기화 여부.
content.externalResourceAccessCfgUUID string 액세스 구성 식별자이며 자격 증명이 아닙니다.
content.storeType string 저장된 대상 유형. 기존 TiDB는 읽을 수 있을 수 있지만 현재 OpenAPI에서는 생성할 수 없습니다.
content.storageClass string 대상 아카이브 클래스.
content.storageFormat string json/parquet. Kafka 또는 LogBamboo에서는 비어 있을 수 있으며, Iceberg는 이 공개 목록/상세에서 제외됩니다.
content.dataType string 규칙에 고정된 데이터 카테고리. 기존 빈 값은 logging으로 처리됩니다.
content.taskStatusCode integer 백그라운드 데이터 전송 작업이 보고하는 상태. 생성 시 일반적으로 -1이며 현재 HTTP 상태가 아닙니다.
content.taskErrorCode string 백그라운드 데이터 전송 오류 코드. 빈 문자열은 현재 오류 기록이 없음을 의미하며, 저장 성공이 작업 성공을 보장하지 않습니다.
content.openPermissionSet boolean 데이터 읽기 사용자 지정 권한 스위치.
content.readPermissionSet array<string> 저장된 읽기 주체.
content.readPermissionSet[] string 개별 역할/멤버/팀 식별자.
content.deleteStatus string 삭제 처리 상태. deleting는 내장 스토리지 규칙이 비동기 삭제 중임을 의미하며, 기존 값은 비어 있거나 completed일 수 있습니다.
content.status integer 0 활성화, 2 비활성화, 3 삭제.
content.creator string 생성자 ID.
content.updator string 수정자 ID. 초기에는 비어 있을 수 있습니다.
content.createAt integer 생성 Unix 초.
content.updateAt integer 수정 Unix 초. 수정되지 않은 경우 -1.
content.deleteAt integer 삭제 Unix 초. 삭제되지 않은 경우 -1.
content.extend object 저장된 범위/조건 구성: 선택 사항이며 생성 시 일반적으로 {}입니다. 수정 시 전달하면 전체가 교체되며, 기존 인덱스 선택에는 별도의 상속 규칙이 있습니다(사용 설명 참조). 생략하면 유지됩니다. 생성 시 null을 전달하면 이후 extend.get에서 500이 발생할 수 있습니다. 수정 시 명시적 null은 {}로 전체 교체되며, 새 버전 인덱스 선택의 별도 상속 규칙은 여전히 유지됩니다.
content.extend.filters array 저장된 범위/조건 구성: 실제 필터 조건 배열입니다. []는 추가 필드 조건이 없음을 의미하며 전체 카테고리가 전송될 수 있습니다. match/not match 및 그 정규화 별칭은 거부되며, 로그 인덱스의 advancedFilter 구조를 여기에 혼합하지 않습니다.
content.extend.filters[] json 저장된 범위/조건 구성: 전체 name/condition/operation/value 사용을 권장하며, query_task.search 구조가 아닙니다.
content.extend.filters[].name string 저장된 범위/조건 구성: 실제 필드 키.
content.extend.filters[].condition string 저장된 범위/조건 구성: and/or로 이전 조건과의 관계를 나타내며, 첫 항목은 무시됩니다.
content.extend.filters[].operation string 저장된 범위/조건 구성: 일반적으로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용하며, match/contain 계열은 지원하지 않습니다.
content.extend.filters[].value array 저장된 범위/조건 구성: 일치 값. 동등/비교 연산은 첫 항목을 사용하고, 집합 연산은 여러 항목을 사용합니다.
content.extend.filters[].value[] JSON 저장된 범위/조건 구성: 단일 문자열/숫자 값이며 실제 유형을 유지합니다.
content.extend.indexs array 저장된 범위/조건 구성: 로그 네이티브 직접 쓰기 인덱스 이름 배열입니다. 새 버전에서 []는 해당 카테고리 전체를, 비어 있지 않은 값은 지정을 의미합니다. 구버전 프로토콜에서 regularLogIndexNames가 없으면 동작이 다릅니다(사용법 참조). UUID 배열이 아닙니다.
content.extend.indexs[] string 저장된 범위/조건 구성: 실제 이름이며 trim 후 중복 제거됩니다. 새 버전에서 새로 추가하는 선택은 현재 사용 가능한 카탈로그에 있어야 합니다.
content.extend.regularLogIndexNames array 또는 null 저장된 범위/조건 구성: 로그에만 적용되는 새 버전 일반 인덱스 선택입니다. []는 일반 카테고리 전체, 비어 있지 않은 값은 지정을 의미하며, null을 indexs 배열과 함께 전달하면 직접 쓰기만 수행함을 나타냅니다. 수정 시 이 키만 null로 전달하면 인덱스 제한이 해제됩니다. 키가 없으면 구버전 프로토콜이거나 수정 시 유지됨을 의미합니다(사용 설명 참조).
content.extend.regularLogIndexNames[] string 저장된 범위/조건 구성: 현재 선택 가능한 단일 일반 인덱스 이름이며, 클론 포함 시 소스 A가 유효해야 합니다. UUID가 아닙니다.
content.creatorInfo object 연결된 ID 요약. 일치하는 항목이 없으면 {}입니다.
content.creatorInfo.uuid string ID UUID. 생략할 수 있습니다.
content.creatorInfo.status integer 계정 상태. 생략할 수 있습니다.
content.creatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태. 생략할 수 있습니다.
content.creatorInfo.name string 표시 이름.
content.creatorInfo.username string 로그인 이름.
content.creatorInfo.email string 이메일 또는 시스템 ID 식별자.
content.creatorInfo.mobile string 휴대폰 번호. 비어 있을 수 있습니다.
content.creatorInfo.countryCode string 국가/지역 코드. 생략할 수 있습니다.
content.creatorInfo.iconUrl string 프로필 이미지 URL. 생략할 수 있습니다.
content.creatorInfo.acntWsNickname string 워크스페이스 닉네임. 생략할 수 있습니다.
content.updatorInfo object 연결된 ID 요약. 일치하는 항목이 없으면 {}입니다.
content.updatorInfo.uuid string ID UUID. 생략할 수 있습니다.
content.updatorInfo.status integer 계정 상태. 생략할 수 있습니다.
content.updatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태. 생략할 수 있습니다.
content.updatorInfo.name string 표시 이름.
content.updatorInfo.username string 로그인 이름.
content.updatorInfo.email string 이메일 또는 시스템 ID 식별자.
content.updatorInfo.mobile string 휴대폰 번호. 비어 있을 수 있습니다.
content.updatorInfo.countryCode string 국가/지역 코드. 생략할 수 있습니다.
content.updatorInfo.iconUrl string 프로필 이미지 URL. 생략할 수 있습니다.
content.updatorInfo.acntWsNickname string 워크스페이스 닉네임. 생략할 수 있습니다.
content.readPermissionSetInfo object 읽기 주체가 비어 있지 않을 때 식별자→요약 매핑을 제공합니다. 확인 가능한 식별자가 없으면 {}이며, 빈 배열일 때는 생략할 수 있습니다.
content.readPermissionSetInfo.主体 object 멤버 요약 또는 역할/팀 name/status 요약입니다. 이 주체가 여전히 유효함을 증명하지 않습니다.
content.readPermissionSetInfo.主体.name string 역할/팀/멤버 표시 이름.
content.readPermissionSetInfo.主体.status integer ID 상태. 생략할 수 있습니다.
content.allow_operation boolean 또는 null 공유 권한 엔진의 작업 표시입니다. 작업 주체가 구성되지 않으면 null일 수 있으며, API 권한 검증을 대체하지 않습니다.
content.readPermissionSetInfo.主体.uuid string ID UUID. 생략할 수 있습니다.
content.readPermissionSetInfo.主体.wsAccountStatus integer 워크스페이스 멤버 상태. 생략할 수 있습니다.
content.readPermissionSetInfo.主体.username string 로그인 이름.
content.readPermissionSetInfo.主体.email string 이메일 또는 시스템 ID 식별자.
content.readPermissionSetInfo.主体.mobile string 휴대폰 번호. 비어 있을 수 있습니다.
content.readPermissionSetInfo.主体.countryCode string 국가/지역 코드. 생략할 수 있습니다.
content.readPermissionSetInfo.主体.iconUrl string 프로필 이미지 URL. 생략할 수 있습니다.
content.readPermissionSetInfo.主体.acntWsNickname string 워크스페이스 닉네임. 생략할 수 있습니다.
content.accessCfg object 대상에 따라 존재하며 생략할 수 있습니다. 선택 사항이지만 외부 대상에서는 일반적으로 조건부 필수입니다. OpenAPI는 HTTPS를 통해 자격 증명 원문을 직접 제출하며 Front의 Web AES 래핑을 사용하지 않습니다. 수정 시 전체 객체를 생략하면 유지되고, 제공하면 전체를 교체하며, 지정된 민감한 값/파티션/대기만 상속할 수 있습니다.
content.accessCfg.provider string 대상에 따라 존재하며 생략할 수 있습니다. 객체 스토리지는 대상 공급자와 일치해야 하며, GCS는 google로 고정됩니다.
content.accessCfg.grantType string 대상에 따라 존재하며 생략할 수 있습니다. 기존의 비특수 대상을 수정할 때는 이전 grantType을 상속하며, 이 필드에 의존하여 권한 부여 모드를 전환하지 않습니다. 구체적인 권한 부여 조합은 먼저 콘솔에서 검증하십시오.
content.accessCfg.cloudAccountId string 대상에 따라 존재하며 생략할 수 있습니다. 역할/계정 권한 부여 시 대상 요구 사항에 따라 제공하며, DF-API-KEY가 아닙니다.
content.accessCfg.bucket string 대상에 따라 존재하며 생략할 수 있습니다. GCS에서 필수입니다. 객체 스토리지는 실제 액세스 가능한 버킷을 제공해야 하며, 사이트 플랫폼에서 예약한 전송 버킷을 사용할 수 없습니다.
content.accessCfg.externalId string 대상에 따라 존재하며 생략할 수 있습니다. 역할 권한 부여 시 입력해야 하며, s3/oss 역할 구성을 수정할 때 기존 externalId 요약이 유지될 수 있습니다.
content.accessCfg.role string 대상에 따라 존재하며 생략할 수 있습니다. 역할 권한 부여 ID 식별자입니다. 콘솔에서 요구하는 이름/식별자를 사용하며, 이 워크스페이스의 RBAC 역할이 아닙니다.
content.accessCfg.ak string 대상에 따라 존재하며 생략할 수 있습니다. 키 권한 부여 시 sk와 함께 사용합니다. 상세 정보에서 AK 식별자를 반환할 수 있지만 모든 비밀 값을 반환한다는 의미는 아닙니다.
content.accessCfg.topic string 대상에 따라 존재하며 생략할 수 있습니다. Kafka는 대상 전송 구성에 따라 입력합니다. 빈 값일 때 대상을 자동 생성할지 여부는 다운스트림에 따라 달라지며, 저장을 쓰기 가능의 증거로 간주하지 않습니다.
content.accessCfg.url string 대상에 따라 존재하며 생략할 수 있습니다. Kafka 연결 주소입니다. 네트워크/권한 부여와 프로토콜이 일치해야 합니다.
content.accessCfg.securityProtocol string 대상에 따라 존재하며 생략할 수 있습니다. Kafka 인증 프로토콜입니다. 두 sasl 모드에서는 username/password가 비어 있지 않아야 합니다.
content.accessCfg.ca string 대상에 따라 존재하며 생략할 수 있습니다. Kafka/Doris에서 대상에 따라 제공해야 합니다. 개인 키가 아니며 사용하지 않으면 생략합니다.
content.accessCfg.mechanism string 대상에 따라 존재하며 생략할 수 있습니다. Kafka SASL 메커니즘입니다. 클러스터 요구 사항에 따라 선택합니다.
content.accessCfg.username string 대상에 따라 존재하며 생략할 수 있습니다. Kafka SASL 및 Doris에서 조건부 필수입니다. 수정 시 사용자 이름이 자동으로 상속되지 않습니다.
content.accessCfg.endpoints string 대상에 따라 존재하며 생략할 수 있습니다. Doris에서 조건부 필수입니다. 자격 증명, 하위 경로, query 또는 fragment가 없어야 하며 포트가 유효해야 합니다.
content.accessCfg.database string 대상에 따라 존재하며 생략할 수 있습니다. Doris 데이터베이스 이름은 [A-Za-z_][A-Za-z0-9_]{0,63}과 일치해야 합니다.
content.accessCfg.table string 대상에 따라 존재하며 생략할 수 있습니다. Doris 테이블 이름은 [A-Za-z][A-Za-z0-9_]{0,63}과 일치해야 하며, 이후 생성/쓰기 동작은 대상 서비스에서 수행합니다.
content.accessCfg.replicationNum integer 대상에 따라 존재하며 생략할 수 있습니다. Doris에서만 제공할 수 있습니다. 음수가 아닌 정수이며, 생략하거나 0이면 클러스터 기본값을 사용하고 bool은 허용되지 않습니다.
content.accessCfg.region string 대상에 따라 존재하며 생략할 수 있습니다. 객체 스토리지에서는 명시적으로 제공해야 합니다. 현재 검증은 후속 기본값 보완 전에 비어 있지 않아야 하며, 선언 텍스트의 기본 사이트 리전에 의존하지 않습니다.
content.accessCfg.endpoint string 대상에 따라 존재하며 생략할 수 있습니다. s3/obs/oss/tos에서 ram을 구성할 때 실제 네트워크 요구 사항에 따라 제공합니다. Kafka broker 또는 LogBamboo 하위 객체의 endpoint가 아닙니다.
content.accessCfg.bucketPath string 대상에 따라 존재하며 생략할 수 있습니다. 선택 사항입니다. 빈 문자열은 버킷 루트 접두사입니다. 수정 시 전체 객체를 제공할 때 다시 채워야 합니다.
content.accessCfg.dataWaitSeconds integer 대상에 따라 존재하며 생략할 수 있습니다. 객체 스토리지에서만 적용됩니다. 신규 추가 시 기본값은 3600이며, 수정 시 생략하면 이전 유효 값을 상속하고 없으면 3600입니다. 객체가 아닌 대상에서는 이 키가 제거되며, bool 또는 기타 값은 허용되지 않습니다.
content.accessCfg.isEncrypt boolean 대상에 따라 존재하며 생략할 수 있습니다. 선택 사항이며 기본값은 암호화하지 않음입니다. 자격 증명 전송/저장 시 암호화 스위치가 아니며 키 관리 파라미터를 제공하지 않습니다.
content.accessCfg.partitionFields array 대상에 따라 존재하며 생략할 수 있습니다. 선택 사항입니다. 수정 시 생략하면 이전 값을 상속하고, 명시적 []는 규칙 수준 파티션을 비웁니다. Kafka가 아닌 대상에서 제공하면 406이 발생하며, 구성원은 비어 있지 않은 문자열이어야 합니다.
content.accessCfg.partitionFields[] string 대상에 따라 존재하며 생략할 수 있습니다. 단일 파티션 필드이며 파티션 번호가 아닙니다.
content.accessCfg.logbamboo json 대상에 따라 존재하며 생략할 수 있습니다. 이 대상에서는 이 하위 객체와 시스템 보완 필드만 허용됩니다. endpoint와 인덱스는 사전에 생성해야 하며, query에는 별도의 searchToken이 필요합니다.
content.accessCfg.logbamboo.endpoint string 대상에 따라 존재하며 생략할 수 있습니다. 사용자 비밀번호, 하위 경로, query/fragment/공백이 없어야 하며, 끝의 /는 정규화되어 제거됩니다.
content.accessCfg.logbamboo.index string 대상에 따라 존재하며 생략할 수 있습니다. 1..128자이며 영문자, 숫자, 점, 밑줄, 하이픈을 허용하고 . 또는 ..일 수 없습니다.
content.accessCfg.logbamboo.ingestToken string 구성된 경우 마스크 문자열만 표시되며 실제 Token은 반환하지 않습니다. 수정 시 이 필드의 생략/빈 값 규칙에 따라 처리합니다.
content.accessCfg.logbamboo.searchToken string 구성된 경우 마스크 문자열만 표시되며 실제 Token은 반환하지 않습니다. 수정 시 이 필드의 생략/빈 값 규칙에 따라 처리합니다.
content.accessCfg.logbamboo.ca string 대상에 따라 존재하며 생략할 수 있습니다. 로드 가능한 PEM CA여야 하며 PRIVATE KEY를 포함하지 않아야 합니다. 생략하면 빈 값으로 정규화되며, 전체 객체 업데이트 시 명시적으로 유지해야 합니다.
content.accessCfg.storeType string 기본 연결 대상 유형입니다. 플랫폼 내장 객체는 실제 공급자에 매핑될 수 있습니다.
content.accessCfg.storageFormat string 이전 호환 액세스 객체 형식 필드입니다.
content.accessCfg.storageClass string 이전 호환 아카이브 필드입니다.
content.accessCfg.dataType string 액세스 객체의 데이터 카테고리입니다.
content.accessCfg.storeLocation string 내장 객체 스토리지 연결 위치 표시입니다. 서비스에서 관리하며 클라이언트는 입력하지 않습니다.
content.accessCfg.tidb object 기존 TiDB 읽기 전용 호환 객체입니다. 이를 기반으로 현재 공개 Body에서 TiDB를 생성/수정할 수 없습니다.
content.accessCfg.tidb.dsn string 상세 정보에서 마스킹된 DSN을 제공할 수 있으며, 실제 비밀번호는 이 값을 통해 반환되지 않습니다.
content.accessCfg.tidb.table string 기존 대상 테이블.
content.accessCfg.tidb.role string 기존 역할 식별자.
content.oldAccessCfg object 또는 null s3/oss 등에서만 이전 역할 권한 부여의 externalId 요약을 반환할 수 있으며, 캐시가 없으면 null입니다.
content.oldAccessCfg.externalId string 기존 권한 부여 외부 ID. 비어 있을 수 있습니다.
content.declaration object 공통 선언.
{
  "code": 200,
  "content": {
    "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,
    "accessCfg": {
      "provider": "aws",
      "grantType": "ram",
      "region": "us-east-1",
      "bucket": "customer-archive-example",
      "ak": "<EXTERNAL-AK>",
      "dataWaitSeconds": 3600,
      "storeType": "s3",
      "dataType": "logging",
      "storageFormat": "json",
      "storageClass": "STANDARD"
    },
    "oldAccessCfg": null,
    "creatorInfo": {},
    "updatorInfo": {},
    "allow_operation": null,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하십시오.
404 ft.LogBackupCfgNoExists 규칙이 존재하지 않음/다른 워크스페이스/삭제됨/삭제 중이거나, 제외된 Iceberg임 지정된 데이터 전송 구성이 존재하지 않습니다 현재 공개 목록에서 유효한 UUID를 다시 선택하십시오.
404 ft.ObjectNotExists 규칙과 연결된 연결 구성이 존재하지 않음 지정된 객체가 존재하지 않습니다 관리자가 리소스 수명 주기를 확인하십시오.
500 ft.InternalServerError 구성, ID 정보, 캐시 또는 응답 형식 지정 읽기에 실패함 내부 오류 쿼리 파라미터를 확인하고, 계속 실패하면 traceId를 제공하십시오.

문서 평가

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