新建单个数据转发规则¶

POST /api/v1/log_backup_cfg/add

概述¶

新建单个数据转发规则

Body 请求参数¶

参数名	类型	必选	说明
name	string	Y	规则名字例子: xxx 允许为空: False
extend	json		前端自定义数据允许为空: True
syncExtensionField	boolean		同步备份扩展字段, true为同步, false不同步, 默认不同步允许为空: False
storeType	string	Y	存储类型允许为空: False 可选值: ['guanceObject', 's3', 'obs', 'oss', 'kafka']
dataType	string		数据类型允许为空: False 可选值: ['logging', 'tracing', 'rum']
duration	string		数据保留时长, 例子: 180d 可选值: ['180d', '360d', '720d']
accessCfg	json		外部资源访问配置信息允许为空: False
accessCfg.provider	string		供应商允许为空: False 可选值: ['aliyun', 'aws', 'huawei']
accessCfg.grantType	string		授权类型允许为空: False 可选值: ['role', 'ram']
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.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.region	string		地域(可选值，如果不输入则默认取与当前站点相匹配的对应厂商地域) 允许为空: False
accessCfg.bucketPath	string		存储桶路径允许为空: False

参数补充说明¶

请求例子¶

curl 'https://openapi.guance.com/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":"obs","name":"temp_test","dataType":"tracing","accessCfg":{"cloudAccountId":"f000ee4d7327428da2f53a081e7109bd","bucket":"test-obs01-418d","region":"cn-south-1","provider":"huawei"}}' \
--compressed

响应¶

{
    "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"
}