跳转至

导出


POST /api/v1/tag/export

概述

按标签列表筛选条件导出全局标签模板。

Query 请求参数

参数名 类型 必选 说明
search string tag 名称搜索
允许为空: False
filter string 过滤条件
允许为空: False
可选值: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'SmartCheckerRefTagObject', 'DialingRefTagObject', 'SecurityRuleRefTagObject']

参数补充说明

该接口用于单独导出全局标签，不需要走工作空间资源导出任务。

请求说明

  1. 导出参数与标签列表接口保持一致，但不支持分页参数。
  2. 当前支持的筛选参数为 search、filter。
  3. 仅导出当前工作空间下有效的标签。
  4. 返回内容是 JSON 列表，可直接作为 /tag/import 的导入模板使用。

导出字段

字段 type 说明
name string 标签名称
description string 标签描述
colour string 标签颜色

不会导出的字段

  • uuid
  • workspaceUUID
  • creator
  • updator
  • createAt
  • updateAt

请求例子

curl 'https://openapi.guance.com/api/v1/tag/export?search=%E6%A0%B8%E5%BF%83&filter=CheckerRefTagObject' \
-H 'DF-API-KEY: <DF-API-KEY>'

响应

{
    "code": 200,
    "content": [
        {
            "name": "核心服务",
            "description": "核心服务标签",
            "colour": "style_key3"
        },
        {
            "name": "线上环境",
            "description": "",
            "colour": "default"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
}

文档评价

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