新建¶
POST /api/v1/log_backup_cfg/add
概述¶
新建单个数据转发规则
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| name | string | Y | 规则名字 例子: xxx 允许为空: False |
| 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'] |
|
| storageClass | string | 存储类型 允许为空: False 允许为空字符串: True |
|
| storageFormat | string | 存储格式, 默认值为 json 允许为空: False 允许为空字符串: True 可选值: ['json', 'parquet'] |
|
| dataType | string | 数据类型 允许为空: False 可选值: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event'] |
|
| duration | string | 数据保留时长, 例子: 180d 可选值: ['180d', '360d', '720d'] |
|
| accessCfg | json | 外部资源访问配置信息 允许为空: False |
|
| accessCfg.provider | string | 供应商 允许为空: False 可选值: ['aliyun', 'aws', 'huawei', 'volcengine'] |
|
| accessCfg.grantType | string | 授权类型 允许为空: False 可选值: ['role', 'ram', 'account'] |
|
| 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.endpoint | string | 访问地址，当 storeType 为 s3/obs/oss/tos 且 grantType=ram 时可选 允许为空: False |
|
| accessCfg.bucketPath | string | 存储桶路径 允许为空: False 允许为空字符串: True |
|
| 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