跳转至

导入



POST /api/v1/log_index_cfg/import

概述

批量导入日志索引模板,支持重名检查、跳过和覆盖。

Body 请求参数

参数名 类型 必选 说明
logIndexes array Y 日志索引模板列表
允许为空: False
logIndexes[*] None
logIndexes[*].name string Y 索引名称
允许为空: False
logIndexes[*].desc string 索引描述
允许为空: False
logIndexes[*].directIndex boolean 是否为原生直写索引
允许为空: False
logIndexes[*].conditions string 匹配条件
允许为空: False
logIndexes[*].duration string 存储时长
允许为空: False
logIndexes[*].extend json 扩展配置
允许为空: False
logIndexes[*].setting json 存储设置
允许为空: False
logIndexes[*].fields array 字段映射配置
允许为空: False
logIndexes[*].is_disable boolean 是否禁用
允许为空: False
repeatLogIndexNameOp string 日志索引重名处理策略
允许为空: False
可选值: ['check', 'skip', 'recover']

参数补充说明

该接口用于单独导入日志索引模板。

调用流程

  1. 准备 logIndexes 数组,每个元素表示一个日志索引模板。
  2. 通过 repeatLogIndexNameOp 指定遇到同名索引时的处理策略。
  3. 如果策略为 check 且存在同名索引,接口会返回 repeat_name,不执行落库。

repeatLogIndexNameOp 说明

取值 说明
check 仅检查重复;有同名索引时返回 repeat_name
skip 跳过已存在的同名索引,只导入不存在的索引
recover 目标空间已有同名索引时,按导入模板覆盖该索引配置

特殊规则

  • name=default 的模板会被忽略,不执行导入
  • 外部索引模板会被忽略,不执行导入
  • recover 仅覆盖同名内部索引,不会操作 default

模板字段

字段 type 必填 说明
name string 索引名称
desc string 索引描述
directIndex boolean 是否为原生直写索引
conditions string 匹配条件
duration string 存储时长
extend json 扩展配置
setting json 存储设置
fields array 字段映射
is_disable boolean 是否禁用

返回说明

  • 导入成功时返回 successCountfailCount
  • 若部分对象失败,返回中会额外带 failedNames
  • check 模式若发现重复,返回 repeat_name

请求例子

curl 'https://openapi.guance.com/api/v1/log_index_cfg/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"repeatLogIndexNameOp":"recover","logIndexes":[{"name":"app-log","desc":"应用日志索引","directIndex":false,"conditions":"","duration":"7d","extend":{},"setting":{},"fields":[],"is_disable":false}]}'

响应

{
    "code": 200,
    "content": {
        "successCount": 1,
        "failCount": 0
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
} 

文档评价

文档内容是否对您有帮助? ×