导入¶
POST /api/v1/tag/import
概述¶
批量导入全局标签模板,支持重名检查、跳过和覆盖。
Body 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| tags | array | Y | 标签模板列表 允许为空: False |
| tags[*] | None | ||
| tags[*].name | string | Y | 标签名称 允许为空: False |
| tags[*].description | string | 标签描述 允许为空: False |
|
| tags[*].colour | string | 标签颜色 允许为空: False |
|
| repeatTagNameOp | string | 标签重名处理策略 允许为空: False 可选值: ['check', 'skip', 'recover'] |
参数补充说明¶
该接口用于单独导入全局标签模板。
调用流程
- 准备
tags数组,每个元素表示一个标签模板。 - 通过
repeatTagNameOp指定遇到同名标签时的处理策略。 - 如果策略为
check且存在同名标签,接口会直接返回repeat_name,不执行落库。
repeatTagNameOp 说明
| 取值 | 说明 |
|---|---|
| check | 仅检查重复;存在同名标签时返回 repeat_name |
| skip | 跳过已存在的同名标签,只导入不存在的标签 |
| recover | 目标空间已有同名标签时,覆盖其 description 和 colour |
模板字段
| 字段 | type | 必填 | 说明 |
|---|---|---|---|
| name | string | 是 | 标签名称 |
| description | string | 否 | 标签描述 |
| colour | string | 否 | 标签颜色 |
返回说明
- 导入执行成功时返回
successCount、failCount - 若部分对象执行失败,返回中会额外带
failedNames check模式若发现重复,返回repeat_name
请求例子¶
curl 'https://openapi.guance.com/api/v1/tag/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"repeatTagNameOp":"recover","tags":[{"name":"核心服务","description":"核心服务标签","colour":"style_key3"}]}'