콘텐츠로 이동

수정¶

POST /api/v1/log_backup_cfg/{cfg_uuid}/modify

개요¶

데이터 전송 규칙 하나를 수정합니다.

경로 매개변수¶

매개변수명	유형	필수	설명
cfg_uuid	string	Y	구성 UUID

본문 요청 매개변수¶

매개변수명	유형	필수	설명
extend	json		프런트엔드 사용자 지정 데이터 빈 값 허용: True
syncExtensionField	boolean		확장 필드 동기화, true면 동기화, false면 비동기화, 기본값은 비동기화 빈 값 허용: False
openPermissionSet	boolean		사용자 지정 권한 구성을 활성화(기본값 false: 비활성화), 활성화하면 전송 규칙 데이터를 읽는 권한이 readPermissionSet에 따라 결정됨(2025-03-26 업데이트에서 추가) 빈 값 허용: False
readPermissionSet	array		데이터 전송 규칙 데이터를 읽을 수 있는 권한 구성, 역할(소유자 제외)을 구성할 수 있음(2025-03-26 업데이트에서 추가) 예: ['wsAdmin', 'general'] 빈 값 허용: False
storageClass	string		스토리지 유형 빈 값 허용: False 빈 문자열 허용: True
storageFormat	string		저장 형식, 기본값은 json 빈 값 허용: False 빈 문자열 허용: True 선택 가능한 값: ['json', 'parquet']
dataType	string		데이터 유형; 이전 클라이언트가 현재 값을 다시 전달하는 것과의 호환성만 제공하며, 규칙 생성 후에는 수정할 수 없음 빈 값 허용: False 선택 가능한 값: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am']
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		topic 빈 값 허용: False 빈 문자열 허용: True
accessCfg.url	string		연결 주소(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

매개변수 추가 설명¶

요청 예시¶

curl 'https://openapi.guance.com/api/v1/log_backup_cfg/lgbp_xxxx32/modify' \
-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","indexs":["default"]},"syncExtensionField":true,"accessCfg":{"grantType":"ram","bucket":"test-s3-001","region":"cn-south-1","provider":"aws","endpoint":"https://s3.custom-endpoint.example.com"}}' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "conditions": "{}",
        "createAt": 1697613651,
        "creator": "xxx",
        "dataType": "logging",
        "deleteAt": -1,
        "extend": {
            "filterLogic": "and",
            "filters": [],
            "indexs": [
                "default"
            ]
        },
        "externalResourceAccessCfgUUID": "erac_xxxx32",
        "id": 686,
        "name": "temp_test",
        "status": 0,
        "storeType": "obs",
        "syncExtensionField": true,
        "taskErrorCode": "",
        "taskStatusCode": -1,
        "updateAt": 1697613856.5497322,
        "updator": "wsak_xxxxx",
        "uuid": "lgbp_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-599A0794-3DD7-4731-BA2F-0A3655C09684"
}