跳转至

导出



POST /api/v1/log_index_cfg/export

概述

按日志索引列表筛选条件导出日志索引模板。

Query 请求参数

参数名 类型 必选 说明
search string 按索引名称搜索
允许为空字符串: True
isBindCustomStore boolean 是否绑定自定义存储,导出时仅支持内部索引,传 true 时结果为空
isDirectIndex boolean 是否为原生直写索引
queryType commaArray 存储查询类型

参数补充说明

该接口用于单独导出日志索引模板,不需要走工作空间资源导出任务。

请求说明

  1. 导出参数与日志索引列表接口保持一致,但不支持分页和跨空间相关参数。
  2. 当前支持的筛选参数为 searchqueryTypeisDirectIndexisBindCustomStore
  3. 仅导出当前工作空间下的内部日志索引。
  4. default 索引和外部索引不会被导出。
  5. 返回结果是 JSON 列表,可直接作为 /log_index_cfg/import 的输入模板。

导出字段

字段 type 说明
name string 索引名称
desc string 索引描述
directIndex boolean 是否为原生直写索引
isFullLineIndex int 是否为全行索引,0 表示保留 message 字段索引,1 表示全行索引;仅日志存储为 scopedb 的工作空间允许设置为 1
conditions string 索引匹配条件
duration string 存储时长
storagePolicy json 长期存储策略
extend json 扩展配置
setting json 存储设置
fields array 字段映射配置
is_disable boolean 是否禁用

请求例子

curl 'https://openapi.guance.com/api/v1/log_index_cfg/export?search=app-log&isDirectIndex=false' \
-H 'DF-API-KEY: <DF-API-KEY>'

响应

{
    "code": 200,
    "content": [
        {
            "name": "app-log",
            "desc": "应用日志索引",
            "directIndex": false,
            "isFullLineIndex": 0,
            "conditions": "",
            "duration": "7d",
            "storagePolicy": {},
            "extend": {},
            "setting": {},
            "fields": [
                {
                    "field": "service",
                    "originalField": "service"
                }
            ],
            "is_disable": false
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
} 

文档评价

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