文档

清理时间线

更新时间:
一键部署

请求路径和方法

请求路径

请求方法

描述

/api/delete_meta

POST

删除时间线

请求内容

名称

类型

是否必需

描述

举例

metric

String

待删除的时间线的metric。

cpu

fields

List

待删除的时间线的域名称,在没有fields的情况下, metric下单值模型和多值模型时间线都会被清除。

usage_system, usage_guest

tags

Map

待删除的时间线。在没有tag的情况下, 所有metric相关时间线都将删除。

见下面的相关说明

deleteData

Boolean

是否删除时间线关联的数据。

  • true(默认值):表示清除关联数据。

  • false:表示只清除时间线。

说明

在删除时间线的同时清除数据比较耗费资源,只删除时间线耗时较短。

false

recursive

Boolean

对于用户指定tagKV,指示是否要精准匹配指定的tagKV。

  • true(默认值):只要目标时间线的Tag包含了删除条件指定的tagKV,则会被删除。

  • false: 目标时间线的TagKV 有且只有指定的TagKV,才会被删除。

说明

例如数据库中存在2条时间线:时间线1:TagK1=TagV1 ,TagK2=TagV2, 时间线2: Tagk1=TagV1 删除条件的tags指定为TagK1=TagV1。若recursive=true, 则时间线1和时间线2都会被删除; 若recursive=false,则只有时间线2会被删除,时间线1则不会被删除。

false

请求 JSON 示例

任务: 清除指标为 “cpu”,tag 为 “host: 192.168.0.2”,”appName: hitsdb” 的所有相关时间线。(包括单值模型下的相关时间线和多值模型所有域的相关时间线)

请求:POST/api/delete_meta请求体:

    {
        "metric": "cpu",
        "tags": {
            "host": "192.168.0.2",
            "appName": "hitsdb"
        }
        "deleteData":false
    }

任务: 清除指标 “cpu” 下 “usage_system” 和 “usage_idle” 域,tag 为 “host: 192.168.0.2”,”appName: hitsdb” 的时间线。请求:POST/api/delete_meta请求体:

    {
        "metric": "cpu.usage",
        "fields": ["usage_system", "usage_idle"],
        "tags": {
            "host": "192.168.0.2",
            "appName": "hitsdb"
        }
    }

响应说明

200 表示成功,其他返回码表示失败,错误信息参考公共响应状态码

  • 本页导读 (1)
文档反馈