Skip to content

Modify¶

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

Overview¶

Modify a single data forwarding rule

Route Parameters¶

Parameter Name	Type	Required	Description
cfg_uuid	string	Y	Configuration UUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
extend	json		Frontend custom data Allow empty: True
syncExtensionField	boolean		Synchronize backup extension fields; true to sync, false to not sync, default is not sync Allow empty: False
openPermissionSet	boolean		Enable custom permission configuration (default false: not enabled). When enabled, the permission to read data forwarding rule data is based on readPermissionSet (added in the 2025-03-26 iteration) Allow empty: False
readPermissionSet	array		Permission configuration for reading data forwarding rule data, configurable roles (excluding the owner) (added in the 2025-03-26 iteration) Example: ['wsAdmin', 'general'] Allow empty: False
storageClass	string		Storage class Allow empty: False Allow empty string: True
storageFormat	string		Storage format, default value is json Allow empty: False Allow empty string: True Allowed values: ['json', 'parquet']
dataType	string		Data type; only used for backward compatibility with old clients to pass back the current value, cannot be modified after rule creation Allow empty: False Allowed values: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am']
accessCfg	json		External resource access configuration Allow empty: False
accessCfg.provider	string		Provider Allow empty: False Allowed values: ['aliyun', 'aws', 'huawei', 'volcengine', 'google']
accessCfg.grantType	string		Grant type Allow empty: False Allowed values: ['role', 'ram', 'account', 'serviceAccount']
accessCfg.cloudAccountId	string		Cloud account ID Allow empty: False
accessCfg.bucket	string		Bucket Allow empty: False
accessCfg.externalId	string		External unique ID (external unique ID for AWS role-based authorization) Allow empty: False
accessCfg.role	string		Role name Allow empty: False
accessCfg.ak	string		Access key ID Allow empty: False
accessCfg.sk	string		Secret key Allow empty: False
accessCfg.serviceAccountJson	json		GCP service account JSON object Allow empty: False
accessCfg.topic	string		Topic Allow empty: False Allow empty string: True
accessCfg.url	string		Link URL (applies to Kafka) Allow empty: False
accessCfg.securityProtocol	string		Security protocol (applies to Kafka) Allow empty: False Allowed values: ['plaintext', 'sasl_plaintext', 'sasl_ssl']
accessCfg.ca	string		Client SSL certificate content Allow empty: False Allow empty string: True
accessCfg.mechanism	string		Authentication mechanism Allow empty: False Allow empty string: True Allowed values: ['plain', 'scram-sha-256', 'scram-sha-512']
accessCfg.username	string		Username Allow empty: False Allow empty string: True
accessCfg.password	string		Password Allow empty: False Allow empty string: True
accessCfg.endpoints	string		Apache Doris FE HTTP/HTTPS addresses, multiple addresses separated by commas Allow empty: False
accessCfg.database	string		Apache Doris database name Allow empty: False
accessCfg.table	string		Apache Doris table name, must match ^[A-Za-z][A-Za-z0-9_]{0,63}$ Allow empty: False
accessCfg.replicationNum	integer		Replication number for new Apache Doris tables; if omitted or set to 0, the cluster default is used Allow empty: False $minValue: 0
accessCfg.region	string		Region (optional; if not provided, the default region matching the current site's provider is used) Allow empty: False
accessCfg.endpoint	string		Access endpoint, optional when storeType is s3/obs/oss/tos and grantType=ram Allow empty: False
accessCfg.bucketPath	string		Bucket path Allow empty: False Allow empty string: True
accessCfg.dataWaitSeconds	integer		Object storage data wait time, in seconds; if not provided, the existing value is used, default is 3600 if no existing value Allow empty: False Allowed values: [900, 1800, 3600]
accessCfg.isEncrypt	boolean		Indicates whether the forwarded data should be encrypted, default is false (not encrypted) Allow empty: False

Supplementary Parameter Notes¶

Request Example¶

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

Response¶

{
    "code": 200,
    "content": {
        "conditions": "{}",
        "createAt": 1697613651,
        "creator": "xxx",
        "dataType": "tracing",
        "deleteAt": -1,
        "extend": {
            "filterLogic": "and",
            "filters": []
        },
        "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"
}