콘텐츠로 이동

생성¶

POST /api/v1/log_backup_cfg/add

개요¶

단일 데이터 전송 규칙 생성

Body 요청 매개변수¶

매개변수명	유형	필수	설명
name	string	Y	규칙 이름 예시: xxx 빈 값 허용: False 최대 길이: 64
extend	json		프론트엔드 사용자 정의 데이터 빈 값 허용: True
syncExtensionField	boolean		백업 확장 필드 동기화, true는 동기화, false는 동기화 안 함, 기본값은 동기화 안 함 빈 값 허용: False
openPermissionSet	boolean		사용자 정의 권한 구성 활성화, (기본값 false: 비활성화), 활성화 시 전송 규칙 데이터 읽기 권한은 readPermissionSet에 따라 결정됨 (2025-03-26 반복 업데이트 추가) 빈 값 허용: False
readPermissionSet	array		데이터 전송 규칙 데이터 읽기 권한 구성, 역할(소유자 제외) 구성 가능 (2025-03-26 반복 업데이트 추가) 예시: ['wsAdmin', 'general'] 빈 값 허용: False
storeType	string		저장 유형 빈 값 허용: False 빈 문자열 허용: True 선택 가능 값: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris']
storageClass	string		저장 유형 빈 값 허용: False 빈 문자열 허용: True
storageFormat	string		저장 형식, 기본값은 json 빈 값 허용: False 빈 문자열 허용: True 선택 가능 값: ['json', 'parquet']
dataType	string		데이터 유형 빈 값 허용: False 선택 가능 값: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am']
duration	string		데이터 보존 기간 예시: 180d 선택 가능 값: ['180d', '360d', '720d']
accessCfg	json		외부 리소스 액세스 구성 정보 빈 값 허용: False
accessCfg.provider	string		공급업체 빈 값 허용: False 선택 가능 값: ['aliyun', 'aws', 'huawei', 'volcengine', 'google']
accessCfg.grantType	string		권한 부여 유형 빈 값 허용: False 선택 가능 값: ['role', 'ram', 'account', 'serviceAccount']
accessCfg.cloudAccountId	string		클라우드 계정 ID 빈 값 허용: False
accessCfg.bucket	string		스토리지 버킷 빈 값 허용: False
accessCfg.externalId	string		외부 고유 식별 ID (AWS 역할 권한 부여 방식의 외부 고유 식별 ID) 빈 값 허용: False
accessCfg.role	string		역할 이름 빈 값 허용: False
accessCfg.ak	string		액세스 키 ID 빈 값 허용: False
accessCfg.sk	string		비밀 액세스 키 빈 값 허용: False
accessCfg.serviceAccountJson	json		GCP 서비스 계정 JSON 객체 빈 값 허용: False
accessCfg.topic	string		토픽 빈 값 허용: False 빈 문자열 허용: True
accessCfg.url	string		연결 URL (kafka에 적용) 빈 값 허용: False
accessCfg.securityProtocol	string		보안 프로토콜 (kafka에 적용) 빈 값 허용: False 선택 가능 값: ['plaintext', 'sasl_plaintext', 'sasl_ssl']
accessCfg.ca	string		클라이언트 SSL 인증서 내용 빈 값 허용: False 빈 문자열 허용: True
accessCfg.mechanism	string		인증 방식 빈 값 허용: False 빈 문자열 허용: True 선택 가능 값: ['plain', 'scram-sha-256', 'scram-sha-512']
accessCfg.username	string		사용자 이름 빈 값 허용: False 빈 문자열 허용: True
accessCfg.password	string		비밀번호 빈 값 허용: False 빈 문자열 허용: True
accessCfg.endpoints	string		Apache Doris FE HTTP/HTTPS 주소, 여러 주소는 쉼표로 구분 빈 값 허용: False
accessCfg.database	string		Apache Doris 데이터베이스 이름 빈 값 허용: False
accessCfg.table	string		Apache Doris 테이블 이름, ^[A-Za-z][A-Za-z0-9_]{0,63}$ 패턴 일치 빈 값 허용: False
accessCfg.replicationNum	integer		Apache Doris 새 테이블 복제본 수; 생략 또는 0 입력 시 클러스터 기본값 사용 빈 값 허용: False $minValue: 0
accessCfg.region	string		리전 (선택 사항, 입력하지 않으면 현재 사이트와 일치하는 해당 공급업체 리전 기본 사용) 빈 값 허용: False
accessCfg.endpoint	string		액세스 주소, storeType이 s3/obs/oss/tos이고 grantType=ram인 경우 선택 가능 빈 값 허용: False
accessCfg.bucketPath	string		스토리지 버킷 경로 빈 값 허용: False 빈 문자열 허용: True
accessCfg.dataWaitSeconds	integer		객체 스토리지 데이터 대기 시간 (초 단위); 미입력 시 기본값 3600 빈 값 허용: False 선택 가능 값: [900, 1800, 3600]
accessCfg.isEncrypt	boolean		전송 데이터 암호화 처리 여부, 기본값 false는 암호화 안 함 빈 값 허용: False

매개변수 추가 설명¶

응답¶

{"code":200,"content":{"conditions":"","createAt":1697613651,"creator":"xxx","dataType":"tracing","deleteAt":-1,"extend":{"filterLogic":"and","filters":[]},"externalResourceAccessCfgUUID":"erac_xxxx32","id":null,"name":"temp_test","status":0,"storeType":"obs","syncExtensionField":true,"taskErrorCode":"","taskStatusCode":-1,"updateAt":1697613651,"updator":"xxx","uuid":"lgbp_xxxx32","workspaceUUID":"wksp_xxxx32"},"errorCode":"","message":"","success":true,"traceId":"TRACE-31D4417B-2665-4CFA-9BC9-60BD6A540744"}
requestCurl: |
```shell
curl '<Endpoint>/api/v1/log_backup_cfg/add' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"extend":{"filters":[],"filterLogic":"and"},"syncExtensionField":true,"storeType":"s3","name":"temp_test","dataType":"tracing","accessCfg":{"grantType":"ram","bucket":"test-s3-001","region":"cn-south-1","provider":"aws","endpoint":"https://s3.custom-endpoint.example.com"}}' \
--compressed