Skip to content

Modify a single data forwarding rule¶

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		Front-end custom data Allow empty: True
syncExtensionField	boolean		Synchronize backup extension fields, true for synchronization, false for no synchronization, default is no synchronization Allow empty: False
openPermissionSet	boolean		Enable custom permission configuration, (default false: not enabled), after enabling, the permission to read the data of the forwarding rule is based on readPermissionSet (added in iteration on 2025-03-26) Allow empty: False
readPermissionSet	array		Permission configuration for reading data forwarding rule data, configurable roles (excluding owners) (added in iteration on 2025-03-26) Example: ['wsAdmin', 'general'] Allow empty: False
accessCfg	json		External resource access configuration information Allow empty: False
accessCfg.provider	string		Provider Allow empty: False Optional values: ['aliyun', 'aws', 'huawei']
accessCfg.grantType	string		Authorization type Allow empty: False Optional values: ['role', 'ram']
accessCfg.cloudAccountId	string		Cloud account ID Allow empty: False
accessCfg.bucket	string		Bucket Allow empty: False
accessCfg.externalId	string		External unique identifier ID (external unique identifier ID in aws role authorization method) Allow empty: False
accessCfg.role	string		Role name Allow empty: False
accessCfg.ak	string		Key Id Allow empty: False
accessCfg.sk	string		Key Allow empty: False
accessCfg.topic	string		Topic Allow empty: False Allow empty string: True
accessCfg.url	string		Link address (used for kafka) Allow empty: False
accessCfg.securityProtocol	string		Security protocol (used for kafka) Allow empty: False Optional values: ['plaintext', 'sasl_plaintext', 'sasl_ssl']
accessCfg.ca	string		Client ssl certificate content Allow empty: False Allow empty string: True
accessCfg.mechanism	string		Authentication method Allow empty: False Allow empty string: True Optional 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.region	string		Region (optional value, if not entered, it will default to the corresponding vendor region matching the current site) Allow empty: False
accessCfg.bucketPath	string		Bucket path Allow empty: False

Supplementary Parameter Explanation¶

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"},"syncExtensionField":true,"accessCfg":{"cloudAccountId":"f000ee4d7327428da2f53a081e7109bd","bucket":"test-obs01","region":"cn-south-1","provider":"huawei"}}' \
--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"
}