생성¶
POST /api/v1/log_backup_cfg/add
개요¶
데이터 전송 규칙을 생성합니다.
호출 전 및 사용 단계¶
먼저 대상과 데이터 카테고리를 결정하고 전체 연결 설정 및 범위를 준비합니다. 새 규칙은 기본적으로 활성화됩니다. 현재 공개 모듈에는 별도의 활성화/비활성화 API가 없으므로 일시 중지가 필요하면 콘솔에서 작업해야 합니다. 외부 대상 저장은 구조 및 일부 플랫폼 버킷 설정만 검증하며 쓰기 권한/도달 가능성이 완전히 검증되었음을 보장하지 않습니다. 생성 후에는 taskStatusCode/taskErrorCode와 실제 대상 데이터를 확인해야 합니다.
로그 범위의 신규 버전 예시: regularLogIndexNames=[]는 모든 일반 인덱스를 선택하고, ["default"]는 기본 인덱스만 선택합니다. indexs=[]와 regularLogIndexNames=null은 모든 네이티브 직접 쓰기 인덱스를 선택하며, 두 키가 모두 []이면 두 유형 전체를 선택합니다. 비어 있지 않은 직접 쓰기 배열에 일반 []를 더하면 합집합이 됩니다. 카탈로그는 선택 가능한 인덱스 API에서 이름을 가져오며, 클론은 소스 A가 유효할 때만 선택할 수 있습니다. regularLogIndexNames가 없는 이전 프로토콜은 기존 indexs 의미를 유지합니다. 키 누락/null은 인덱스 제한이 없고, []는 이전 실행 경로를 따르며 신규 버전의 빈 배열로 해석하지 않습니다.
LogBamboo는 독립 logbamboo 연결만 허용하며 storageClass/storageFormat은 반드시 생략하거나 비워야 합니다. 독립 searchToken이 없으면 쿼리할 수 없고 읽기 사용자 지정 주체가 비워집니다. Doris는 json으로 고정되며 아카이브 카테고리가 없습니다. 오브젝트 스토리지 대기는 dataWaitSeconds만 적용됩니다. 보존 기간은 워크스페이스 또는 외부 수명 주기로 제어되며, 신규 추가된 호환 duration은 단일 규칙 보존을 변경하지 않습니다.
설정과 자격 증명 저장, 이후 전송/캐시 알림은 단계별로 처리되며 성공이 이미 데이터가 기록되었음을 의미하지 않습니다. 알림 수정이 실패해도 이미 저장되었을 수 있으므로 먼저 현재 상태와 실제 전송 결과를 읽은 후 재시도합니다.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| readPermissionSet[*] | string | 단일 주체입니다. 역할 이름을 UUID로 사용할 수 없으며 실제 읽기 가능 결과를 확인해야 합니다. 예: wsAdmin가져오기 또는 입력 방법: 현재 워크스페이스의 역할 UUID를 가져옵니다. 공유 권한 엔진은 acnt_/group_ 주체도 인식합니다. |
|
| extend.filters | array | 실제 필터 조건 배열입니다. []는 추가 필드 조건이 없음을 의미하며 전체 유형을 전송할 수 있습니다. match/not match 및 정규화된 별칭은 거부되며 로그 인덱스 advancedFilter 구조를 여기에 혼합하지 않습니다.예: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]가져오기 또는 입력 방법: 해당 dataType의 실제 필드와 값을 가져오고 저장 전에 일치 범위를 확인합니다. |
|
| extend.filters[*] | json | 권장 형식은 전체 name/condition/operation/value입니다. query_task.search 구조가 아닙니다.예: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}가져오기 또는 입력 방법: 각 항목은 하나의 조건이며 복잡한 중첩은 기존 설정을 먼저 검증합니다. |
|
| extend.filters[*].name | string | 실제 필드 키입니다. 예: env가져오기 또는 입력 방법: 실제 원본 필드, 관계, 연산 및 값에 따라 입력합니다. |
|
| extend.filters[*].condition | string | and/or는 이전 조건과의 관계이며 첫 번째 항목에서는 무시됩니다. 예: and가져오기 또는 입력 방법: 실제 원본 필드, 관계, 연산 및 값에 따라 입력합니다. |
|
| extend.filters[*].operation | string | 주로 =, !=, in, not_in, >, >=, <, <=, regexp, not_regexp, wildcard, not_wildcard, exist, not_exist를 사용합니다. match/contain 유형은 지원하지 않습니다.예: =가져오기 또는 입력 방법: 실제 원본 필드, 관계, 연산 및 값에 따라 입력합니다. |
|
| extend.filters[*].value | array | 일치 값입니다. 등가/비교는 첫 번째 항목을 사용하고 집합 연산은 여러 항목을 사용합니다. 예: ["production"]가져오기 또는 입력 방법: 실제 원본 필드, 관계, 연산 및 값에 따라 입력합니다. |
|
| extend.filters[*].value[*] | JSON | 단일 문자열/숫자이며 실제 유형을 유지합니다. 예: production가져오기 또는 입력 방법: 원본 필드 값을 가져옵니다. |
|
| extend.indexs | array | 로그 네이티브 직접 쓰기 인덱스 이름 배열입니다. 신규 버전에서 []는 해당 유형 전체, 비어 있지 않으면 지정을 의미합니다. 이전 프로토콜에서 regularLogIndexNames가 없으면 동작이 다르므로 사용법을 참조하십시오. UUID 배열이 아닙니다.예: ["native_app_logs"]가져오기 또는 입력 방법: 선택 가능한 전송 인덱스의 content.items에서 type=native인 항목의 name을 가져오며 indexs 철자에 주의합니다. |
|
| extend.indexs[*] | string | 실제 이름이며 trim 후 중복 제거합니다. 신규 버전에서 추가 선택은 현재 사용 가능한 카탈로그에 있어야 합니다. 예: native_app_logs가져오기 또는 입력 방법: 선택 가능한 전송 인덱스에서 native 항목의 name을 가져옵니다. |
|
| extend.regularLogIndexNames | array 또는 null | 로그 전용 신규 버전 일반 인덱스 선택입니다. []는 모든 일반 유형, 비어 있지 않으면 지정을 의미하며 null을 indexs 배열과 함께 전달하면 직접 쓰기만 의미합니다. 수정 시 이 키만 null로 전달하면 인덱스 제한이 해제됩니다. 키가 없으면 이전 프로토콜 또는 수정 시 유지를 의미하므로 사용 설명을 참조하십시오.예: ["default"]가져오기 또는 입력 방법: 선택 가능한 전송 인덱스의 type=log에서 name을 가져옵니다(default, 일반 인덱스 및 조건을 충족하는 클론 포함). |
|
| extend.regularLogIndexNames[*] | string | 현재 선택 가능한 단일 일반 인덱스 이름입니다. 클론을 포함하는 경우 소스 A가 유효해야 하며 UUID가 아닙니다. 예: default가져오기 또는 입력 방법: 선택 가능한 전송 인덱스의 log 항목 이름을 가져옵니다. |
|
| accessCfg.serviceAccountJson.type | string | 자격 증명 유형입니다. 예: service_account가져오기 또는 입력 방법: 동일한 서비스 계정 JSON에서 원래 값을 유지합니다. |
|
| accessCfg.serviceAccountJson.project_id | string | GCP 프로젝트 ID입니다. 예: project-example가져오기 또는 입력 방법: 동일한 서비스 계정 JSON에서 원래 값을 유지합니다. |
|
| accessCfg.serviceAccountJson.private_key | string | 자격 증명 개인 키이며 원본 JSON의 전체 여러 줄 문자열을 사용합니다. 예: <PEM-PRIVATE-KEY>가져오기 또는 입력 방법: 동일한 서비스 계정 JSON에서 원래 값을 유지합니다. |
|
| accessCfg.serviceAccountJson.client_email | string | 서비스 계정 이메일 식별자입니다. 예: xxx@guance.com가져오기 또는 입력 방법: 동일한 서비스 계정 JSON에서 원래 값을 유지합니다. |
|
| accessCfg | json | 선택 사항이지만 외부 대상에서는 일반적으로 조건부로 필수입니다. OpenAPI는 HTTPS를 통해 자격 증명 원문을 직접 제출하며 Front의 Web AES 래핑을 사용하지 않습니다. 수정 시 전체 객체를 생략하면 유지됩니다. 제공하면 전체를 교체하며 지정된 민감 값/파티션/대기만 상속할 수 있습니다. null 허용: False 예: {"provider": "aws", "grantType": "ram", "region": "us-east-1", "bucket": "customer-archive-example", "ak": "<EXTERNAL-AK>", "sk": "<EXTERNAL-SK>"}가져오기 또는 입력 방법: 대상 스토리지 관리자로부터 전체 권한 부여 연결 객체를 받거나 콘솔에서 검증된 설정을 기반으로 구성합니다. |
|
| accessCfg.ak | string | 키 권한 부여 시 sk와 함께 사용합니다. 상세 정보에서 AK 식별자를 반환할 수 있지만 모든 비밀 값을 반환한다는 의미는 아닙니다.null 허용: False 예: <EXTERNAL-AK>가져오기 또는 입력 방법: 대상 액세스 키 ID입니다. |
|
| accessCfg.bucket | string | GCS 필수입니다. 오브젝트 스토리지는 실제 액세스 가능한 버킷을 제공해야 하며 사이트 플랫폼 예약 전송 버킷을 사용할 수 없습니다. null 허용: False 예: customer-archive-example가져오기 또는 입력 방법: 자체 오브젝트 스토리지 버킷 이름입니다. |
|
| accessCfg.bucketPath | string | 선택 사항이며 빈 문자열은 버킷 루트 접두사입니다. 수정 시 전체 객체를 제공하면 다시 채워야 합니다. 빈 문자열 허용: True null 허용: False 예: production/logs가져오기 또는 입력 방법: 자체 버킷 내 대상 접두사이며 자격 증명은 포함하지 않습니다. |
|
| accessCfg.ca | string | Kafka/Doris에서 대상 필요에 따라 제공하며 개인 키가 아닙니다. 사용하지 않으면 생략합니다. 빈 문자열 허용: True null 허용: False 예: <PEM-CA>가져오기 또는 입력 방법: 대상 TLS 검증에 사용하는 PEM CA 내용입니다. |
|
| accessCfg.cloudAccountId | string | 역할/계정 권한 부여 시 대상 요구 사항에 따라 제공하며 DF-API-KEY가 아닙니다. null 허용: False 예: cloud-account-example가져오기 또는 입력 방법: 클라우드 계정 관리에서 가져온 권한 부여 연결 ID를 그대로 사용합니다. |
|
| accessCfg.dataWaitSeconds | integer | 오브젝트 스토리지에만 적용됩니다. 신규 추가 시 기본값은 3600이며 수정 시 생략하면 이전 유효 값을 상속하고 그렇지 않으면 3600입니다. 오브젝트 대상이 아니면 이 키가 제거되며 bool 또는 다른 값은 유효하지 않습니다. null 허용: False 선택 가능한 값: [900, 1800, 3600] 예: 3600가져오기 또는 입력 방법: 오브젝트 스토리지에서 900/1800/3600초를 선택합니다. |
|
| accessCfg.database | string | Doris 데이터베이스 이름은 [A-Za-z_][A-Za-z0-9_]{0,63}과 일치해야 합니다.null 허용: False 예: archive_db가져오기 또는 입력 방법: 준비된 Doris 데이터베이스입니다. |
|
| accessCfg.endpoint | string | s3/obs/oss/tos에 ram을 구성할 때 실제 네트워크 필요에 따라 제공합니다. Kafka broker 또는 LogBamboo 하위 객체 endpoint가 아닙니다. null 허용: False 예: https://s3.example.com가져오기 또는 입력 방법: 오브젝트 스토리지 사용자 지정 서비스 액세스 엔드포인트입니다. |
|
| accessCfg.endpoints | string | Doris 조건부 필수입니다. 자격 증명, 하위 경로, query 또는 fragment가 없어야 하며 포트가 유효해야 합니다. null 허용: False 예: https://doris.example.com:8030가져오기 또는 입력 방법: Doris FE HTTP(S) 루트 주소이며 여러 개는 영문 쉼표로 구분합니다. |
|
| accessCfg.externalId | string | 역할 권한 부여 시 필요에 따라 입력합니다. s3/oss 역할 설정 수정 시 기존 externalId 요약이 유지될 수 있습니다. null 허용: False 예: external-id-example가져오기 또는 입력 방법: AWS 역할 신뢰 권한 부여 시 합의된 External ID입니다. |
|
| accessCfg.grantType | string | 기존 비특수 대상을 수정할 때는 이전 grantType을 상속하며 이 필드로 권한 부여 모드를 전환하지 않습니다. 구체적인 권한 부여 조합은 먼저 콘솔에서 검증하십시오.null 허용: False 선택 가능한 값: ['role', 'ram', 'account', 'serviceAccount'] 예: ram가져오기 또는 입력 방법: 대상 권한 부여 방식에 따라 ram 키, role 역할, account 사이트 계정 또는 GCS serviceAccount를 선택합니다. |
|
| accessCfg.isEncrypt | boolean | 선택 사항이며 기본값은 암호화하지 않음입니다. 자격 증명 전송/저장 시 암호화 스위치가 아니며 키 관리 파라미터를 제공하지 않습니다. null 허용: False 예: false가져오기 또는 입력 방법: 대상 전송 데이터 암호화 요구 사항에 따라 입력합니다. |
|
| accessCfg.logbamboo | json | 이 대상은 이 하위 객체 및 시스템 보충 필드만 허용합니다. 엔드포인트와 인덱스는 미리 생성해야 하며 query에는 독립 searchToken이 필요합니다.null 허용: False 예: {"endpoint": "https://archive.example.com", "index": "app_logs", "ingestToken": "<INGEST-TOKEN-AT-LEAST-16>"}가져오기 또는 입력 방법: storeType=logbamboo인 경우에만 독립 서비스 설정을 사용합니다. |
|
| accessCfg.logbamboo.ca | string | 로드 가능한 PEM CA여야 하며 PRIVATE KEY를 포함하지 않습니다. 생략하면 빈 값으로 정규화되며 전체 객체 업데이트 시 명시적으로 유지해야 합니다.빈 문자열 허용: True null 허용: False 예: <PEM-CA>가져오기 또는 입력 방법: 선택적 대상 CA 인증서입니다. |
|
| accessCfg.logbamboo.endpoint | string | 사용자 비밀번호, 하위 경로, query/fragment/공백이 없어야 하며 끝의 /는 정규화되어 제거됩니다.빈 문자열 허용: True null 허용: False 예: https://archive.example.com가져오기 또는 입력 방법: 대상 HTTP(S) 서비스 루트 주소입니다. |
|
| accessCfg.logbamboo.index | string | 1..128자이며 영문자, 숫자, 점, 밑줄, 짧은 줄표를 허용합니다. . 또는 ..일 수 없습니다.빈 문자열 허용: True null 허용: False 예: app_logs가져오기 또는 입력 방법: 이미 생성된 대상 인덱스입니다. |
|
| accessCfg.logbamboo.ingestToken | string | 최소 16개의 인쇄 가능한 비공백 ASCII 문자여야 하며 Bearer 접두사를 포함하지 않습니다. 수정 시 생략/빈 문자열 또는 마스킹된 값이면 이전 Token을 상속하며 신규 추가 시 반드시 유효해야 합니다.빈 문자열 허용: True null 허용: False 예: <INGEST-TOKEN-AT-LEAST-16>가져오기 또는 입력 방법: 서비스 관리자로부터 독립 쓰기 Token을 받습니다. |
|
| accessCfg.logbamboo.searchToken | string | 선택 사항이며 제공하지 않으면 쿼리를 실행할 수 없습니다. 수정 시 생략하면 상속되고 빈 문자열이면 제거됩니다. 제거 후 openPermissionSet 및 readPermissionSet은 비워지거나 닫힙니다.빈 문자열 허용: True null 허용: False 예: <SEARCH-TOKEN-AT-LEAST-16>가져오기 또는 입력 방법: 관리자로부터 독립 쿼리 Token을 받으며 ingestToken과 같을 수 없습니다. |
|
| accessCfg.mechanism | string | Kafka SASL 메커니즘으로 클러스터 요구 사항에 따라 선택합니다. 빈 문자열 허용: True null 허용: False 선택 가능한 값: ['plain', 'scram-sha-256', 'scram-sha-512'] 예: scram-sha-256가져오기 또는 입력 방법: plain/scram-sha-256/scram-sha-512. |
|
| accessCfg.partitionFields | array | 선택 사항이며 수정 시 생략하면 이전 값을 상속하고 명시적 []는 규칙 수준 파티션을 비웁니다. Kafka가 아닌 대상에 제공하면 406이 발생하며 구성원은 비어 있지 않은 문자열이어야 합니다.null 허용: False 예: ["app_id", "userid"]가져오기 또는 입력 방법: Kafka에서만 실제 전송 데이터 필드에서 파티션 키를 선택합니다. |
|
| accessCfg.partitionFields[*] | string | 단일 파티션 필드이며 파티션 번호가 아닙니다. null 허용: False $notEmptyString: True 예: app_id가져오기 또는 입력 방법: 실제 데이터 필드 이름입니다. |
|
| accessCfg.password | string | 비특수 대상 수정 시 생략/빈 값이면 이전 비밀번호 유지를 시도하며 비울 수 없습니다. 빈 문자열 허용: True null 허용: False 예: <EXTERNAL-PASSWORD>가져오기 또는 입력 방법: 대상 계정 비밀번호입니다. |
|
| accessCfg.provider | string | 오브젝트 스토리지는 대상 공급자와 일치해야 하며 GCS는 google로 고정됩니다.null 허용: False 선택 가능한 값: ['aliyun', 'aws', 'huawei', 'volcengine', 'google'] 예: aws가져오기 또는 입력 방법: 실제 클라우드 공급자 aliyun/aws/huawei/volcengine/google. |
|
| accessCfg.region | string | 오브젝트 스토리지는 명시적으로 제공해야 합니다. 현재 검증은 후속 기본값 보충 전에 비어 있지 않을 것을 요구하며 선언 문구의 기본 사이트 리전에 의존하지 않습니다. null 허용: False 예: us-east-1가져오기 또는 입력 방법: 대상 버킷이 위치한 리전이며 GCS는 실제 GCP 리전을 사용합니다. |
|
| accessCfg.replicationNum | integer | Doris에서만 제공할 수 있습니다. 음수가 아닌 정수이며 생략하거나 0이면 클러스터 기본값을 사용하고 bool은 유효하지 않습니다. null 허용: False $minValue: 0 예: 0가져오기 또는 입력 방법: Doris 새 테이블 복제본 수이며 클러스터 노드 용량에 따라 결정합니다. |
|
| accessCfg.role | string | 역할 권한 부여 신원 식별자이며 콘솔에서 요구하는 이름/식별자를 사용합니다. 현재 워크스페이스의 RBAC 역할이 아닙니다. null 허용: False 예: archive-role가져오기 또는 입력 방법: 대상 클라우드 계정 권한 부여 역할에서 가져옵니다. |
|
| accessCfg.securityProtocol | string | Kafka 인증 프로토콜입니다. 두 sasl 모드는 비어 있지 않은 username/password를 요구합니다.null 허용: False 선택 가능한 값: ['plaintext', 'sasl_plaintext', 'sasl_ssl'] 예: sasl_ssl가져오기 또는 입력 방법: plaintext/sasl_plaintext/sasl_ssl. |
|
| accessCfg.serviceAccountJson | json | GCS의 해당 권한 부여 조건에서만 필수이며 최소 type/project_id/private_key/client_email이 비어 있지 않아야 합니다. JSON 문자열을 전달할 수 없고 상세 정보에서는 반환하지 않습니다.null 허용: False 예: {"type": "service_account", "project_id": "project-example", "private_key": "<PEM-PRIVATE-KEY>", "client_email": "xxx@guance.com"}가져오기 또는 입력 방법: GCS serviceAccount 권한 부여 시 Google에서 다운로드한 전체 서비스 계정 JSON 객체를 사용하며 실제 내용을 문서에 업로드하지 않습니다. |
|
| accessCfg.sk | string | 수정 시 생략/빈 값이면 이전 SK 유지를 시도하며 빈 문자열로 지울 수 없습니다. 신규 추가 시 전체 값을 제공합니다. null 허용: False 예: <EXTERNAL-SK>가져오기 또는 입력 방법: ak와 함께 사용하는 키입니다. |
|
| accessCfg.table | string | Doris 테이블 이름은 [A-Za-z][A-Za-z0-9_]{0,63}과 일치해야 하며 이후 생성/쓰기 동작은 대상 서비스에서 수행합니다.null 허용: False 예: archive_logs가져오기 또는 입력 방법: Doris 대상 테이블 이름입니다. |
|
| accessCfg.topic | string | Kafka는 대상 전송 설정에 따라 입력합니다. 빈 값일 때 대상을 자동 생성할지는 하위 시스템에 따라 달라지며 저장을 쓰기 가능 증명으로 간주하지 않습니다. 빈 문자열 허용: True null 허용: False 예: archive_logs가져오기 또는 입력 방법: Kafka 클러스터의 대상 topic입니다. |
|
| accessCfg.url | string | Kafka 연결 주소입니다. 네트워크/권한 부여와 프로토콜이 일치해야 합니다. null 허용: False 예: kafka.example.com:9092가져오기 또는 입력 방법: Kafka 관리자가 제공한 도달 가능한 broker 주소입니다. |
|
| accessCfg.username | string | Kafka SASL 및 Doris에서 조건부 필수입니다. 수정 시 사용자 이름을 자동으로 상속하지 않습니다. 빈 문자열 허용: True null 허용: False 예: archive_writer가져오기 또는 입력 방법: 대상 시스템에서 쓰기 권한이 부여된 계정입니다. |
|
| dataType | string | 선택 사항이며 생성 시 기본값은 logging입니다. 수정 시 원래 카테고리만 다시 전달할 수 있고 전환할 수 없습니다. metric은 사용 가능한 대상과 함께 구성해야 하며 logbamboo는 lineage를 지원하지 않습니다. 요청 쿼리의 dataType은 규칙 카테고리를 덮어쓸 수 없습니다.null 허용: False 선택 가능한 값: ['lineage', 'metric', 'llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am'] 예: logging가져오기 또는 입력 방법: lineage/metric/llm/logging/tracing/rum/keyevent/audit_event/am을 선택하며 대상 원본 데이터 카테고리에서 결정합니다. |
|
| duration | string | 신규 추가 시에만 이 필드가 있으며 현재 구현에서는 감사 컨텍스트에 사용되고 단일 규칙 보존 설정으로 저장되지 않습니다. 이를 통해 버킷 수명 주기를 변경하지 마십시오. 목록의 duration은 워크스페이스 backup_log 보존 기간에서 가져옵니다.선택 가능한 값: ['180d', '360d', '720d'] 예: 180d가져오기 또는 입력 방법: 이전 선언 호환 값 180d/360d/720d입니다. |
|
| extend | json | 선택 사항이며 생성 시 일반적으로 {}입니다. 수정 시 전달하면 전체를 교체하며 이전 인덱스 선택에는 전용 상속 규칙이 있으므로 사용 설명을 참조하십시오. 생략하면 유지됩니다. 생성 시 null을 전달하면 이후 extend.get에서 500이 발생할 수 있습니다. 수정 시 명시적 null은 {}로 전체 교체되며 신규 버전 인덱스 선택의 전용 상속 규칙은 여전히 유지됩니다.null 허용: True 예: {"filters": []}가져오기 또는 입력 방법: 실제 필드로 필터를 구성하며 로그 범위는 아래 indexs와 regularLogIndexNames 두 필드를 사용할 수 있습니다. |
|
| name | string | Y | 신규 추가 시 필수입니다. 최대 64개의 UTF-16 단위(대부분의 중국어는 1, BMP가 아닌 문자 예: 일부 emoji는 2)이며 중복될 수 없습니다. 수정 시 name을 선언하지 않으며 이 API로 이름을 변경하지 않습니다. 호출자는 비어 있지 않아야 하지만 현재 이름 검증은 비어 있지 않음을 강제하지 않습니다.null 허용: False 최대 길이: 64 예: production_archive가져오기 또는 입력 방법: 비즈니스에서 이름을 지정하며 먼저 데이터 전송 규칙 목록에서 동일 워크스페이스의 비삭제/삭제 중 레코드 이름을 확인합니다. |
| openPermissionSet | boolean | 선택 사항이며 생성 시 false, 수정 시 생략하면 유지됩니다. readPermissionSet은 데이터 쿼리 권한을 제어하며 규칙 관리 API 권한이 아닙니다. LogBamboo에 독립 searchToken이 없으면 강제로 닫히고 읽기 주체가 비워집니다.null 허용: False 예: false가져오기 또는 입력 방법: 전송된 데이터 읽기를 추가로 제한해야 할 때 활성화합니다. |
|
| readPermissionSet | array | 선택적 전체 읽기 주체 배열이며 일반적으로 owner가 아닌 역할을 구성하고 owner/생성자에게는 유지 읽기 경로가 있습니다. 생성 시 [], 수정 시 전달하면 전체를 교체하고 생략하면 유지됩니다. 빈 배열은 모든 사용자가 조회 가능함을 의미하지 않습니다.null 허용: False 예: ["wsAdmin"]가져오기 또는 입력 방법: 역할은 현재 워크스페이스 역할 관리에서 가져옵니다(예: wsAdmin/general/readOnly). 구성원/팀은 현재 워크스페이스의 실제 UUID로 입력합니다. |
|
| storageClass | string | 선택적 아카이브 카테고리이며 사이트/공급자가 사용 가능한 값을 결정합니다. 소스 코드는 이 계층에서 통합 열거를 나열하지 않습니다. LogBamboo는 반드시 생략/빈 값이어야 하며 Doris는 비웁니다. 아카이브 데이터를 직접 쿼리할 수 있는지는 대상 복구 상태에 따라 달라집니다. 빈 문자열 허용: True null 허용: False 예: STANDARD가져오기 또는 입력 방법: 대상 공급자의 실제 스토리지 클래스 코드에 따라 구성합니다(예: STANDARD/ARCHIVE). 버킷 정책 및 콘솔에서 검증된 설정에서 가져옵니다. |
|
| storageFormat | string | 선택 사항이며 일반적으로 기본값은 json입니다. 수정 시 생략하면 유지됩니다. 공개 열거에는 iceberg가 포함되지 않습니다. LogBamboo는 명시적 json/parquet도 거부됩니다. Kafka는 빈 값으로 정규화되고 Doris는 json으로 강제됩니다.빈 문자열 허용: True null 허용: False 선택 가능한 값: ['json', 'parquet'] 예: json가져오기 또는 입력 방법: 오브젝트 스토리지는 json/parquet를 선택하고 LogBamboo는 생략하며 Kafka는 파일 형식을 사용하지 않고 Doris는 json으로 고정됩니다. |
|
| storeType | string | 생성 시 선택 사항이며 수정 시 기존 값으로 고정됩니다. 공개적으로 TiDB 또는 Iceberg 생성을 지원하지 않습니다. 기존 TiDB는 목록/상세에 나타날 수 있으나 이를 근거로 숨겨진 파라미터를 추가하려고 시도하지 않습니다. 빈 문자열 허용: True null 허용: False 선택 가능한 값: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris', 'logbamboo'] 예: s3가져오기 또는 입력 방법: 오브젝트 스토리지 s3/oss/obs/tos/gcs, 메시지 kafka, 데이터베이스 doris, 서비스 logbamboo, 플랫폼 내장 오브젝트 스토리지 guanceObject이며 생략하거나 빈 값이면 사이트 기본값입니다. |
|
| syncExtensionField | boolean | 선택 사항이며 생성 시 기본값은 false입니다. 수정 시 생략하면 유지됩니다. 로그 반환 message의 구조 및 마스킹 방식에 영향을 주며 어떤 필드를 선택할지에 대한 화이트리스트가 아닙니다.null 허용: False 예: false가져오기 또는 입력 방법: 전체 로그 및 확장 필드를 전송해야 하면 true, 기존 message만 전송하는 방식이면 false입니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/log_backup_cfg/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"production_archive","dataType":"logging","storeType":"s3","storageFormat":"json","storageClass":"STANDARD","extend":{"filters":[],"regularLogIndexNames":["default"]},"syncExtensionField":false,"accessCfg":{"provider":"aws","grantType":"ram","region":"us-east-1","bucket":"customer-archive-example","ak":"<EXTERNAL-AK>","sk":"<EXTERNAL-SK>","dataWaitSeconds":3600}}'
응답¶
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 | 업데이트 주체이며 초기에는 비어 있을 수 있습니다. |
| 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.declaration | object | 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"id": null,
"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,
"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 파일 형식 오류 | 파라미터 표의 JSON 객체를 제출합니다. |
| 406 | ft.ParameterValidationFailed | 데이터 카테고리/스토리지 대상/연결/이름/대기/인덱스 선택 또는 불변 필드 검증 불일치 | 파라미터 파싱 실패 | 대상 조합에 따라 완전히 입력하며 내부 TiDB/Iceberg 파라미터 또는 알 수 없는 필드를 사용할 수 없습니다. |
| 406 | ft.UnsupportRuleType | filters에서 match/not match 및 해당 정규화 별칭 사용 | 지원하지 않는 규칙 유형:{} |
지원되는 등가, 집합 또는 정규식 등 조건으로 변경합니다. |
| 400 | ft.LogBackupCfgRegionInvalid | 오브젝트 스토리지 리전이 비어 있음 | 외부 스토리지의 리전이 유효하지 않음 | 대상 리전을 명시적으로 입력합니다. |
| 400 | ft.LogBackupCfgProviderInvalid | 공급자가 비어 있거나 GCS가 google이 아님 등 | 외부 스토리지 공급자 유형이 유효하지 않음 | 실제 대상과 일치하는 provider를 입력합니다. |
| 404 | ft.LogBackupCfgUserNameInvalid | Kafka SASL 사용자 이름이 비어 있음 | 백업 규칙 설정의 사용자 이름이 유효하지 않음 | 프로토콜과 일치하는 사용자 이름을 제공합니다. |
| 404 | ft.LogBackupCfgPasswordInvalid | Kafka SASL 비밀번호가 비어 있음 | 백업 규칙 설정의 비밀번호가 유효하지 않음 | 유효한 비밀번호를 제공하거나 수정 시 상속 규칙에 따라 유지합니다. |
| 406 | ft.DataTransferBucketUnavailable | 대상이 플랫폼 예약 데이터 전송 버킷을 사용 | Bucket을 사용할 수 없음 | 고객 소유 권한 부여 버킷을 사용합니다. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 필드 형태 또는 일반 하위 5xx/타임아웃 처리 실패 | 내부 오류 | 쓰기 후 먼저 규칙 현재 상태를 확인하고 쿼리 작업은 task_id를 먼저 확인합니다. 지속 실패 시 traceId를 제공합니다. |
| 400 | ft.BackupLogNameRepeat | 워크스페이스에 동일 이름의 비삭제 레코드(삭제 중 규칙 포함) 존재 | 현재 워크스페이스에 동일 이름의 데이터 전송 설정 이름 {}이(가) 이미 존재합니다 |
고유한 이름으로 변경하거나 삭제 완료 후 확인합니다. |
| 403 | ft.Forbidden | 무료/체험 버전에서는 생성 불가 | 작업 권한이 없습니다 | 지원 버전 및 API Key 권한을 확인합니다. |