Tag管理¶
说明¶
- 管理playbook中默认的tag,用于作业模板中tags参数和skip_tags参数选择的默认值
1、tag列表、新增tag、批量删除tag API¶
请求方式: GET(查询) POST(新增) DELETE(批量删除)
请求地址: /api/system/tag/
Content-Type:
新增数据的时候需要指定Content-Type,以下对Content-Type进行说明:
application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串
查询参数:
参数 | 数据类型 | 是否必须 | 说明 |
offset | int | 否 | 数据起始位置 |
limit | int | 否 | 查询条数 |
tag | string | 否 | tag名 |
search | string | 否 | 模糊查询,查询字段为tag和comment |
输入参数(新增):
参数 | 数据类型 | 是否必须 | 说明 |
tag | string | 是 | tag名 |
weight | int | 否 | 权重,默认为0,默认按权重由大到小排序 |
comment | string | 否 | 描述 |
输出参数:
参数 | 数据类型 | 是否必须 | 说明 |
id | int | 是 | tag id |
tag | string | 是 | tag名 |
weight | int | 否 | 权重,默认为0,权重大的排在前面 |
comment | string | 否 | 描述 |
批量删除参数:
参数 | 数据类型 | 是否必须 | 说明 |
pk | string | 与pk[]不能都为空 | 主键,多个主键用半角逗号隔开。通过http body传入 |
pk[] | array | 与pk不能都为空 | 主键数组。通过http body传入 |
排序:
参数 | 数据类型 | 是否必须 | 说明 |
ordering | string | 否 |
|
GET返回数据例子:
{
"count": 6,
"next": null,
"previous": null,
"results": [
{
"id": 2,
"tag": "tomcat",
"weight": 1,
"comment": "tomcat"
},
{
"id": 3,
"tag": "git",
"weight": 0,
"comment": ""
},
{
"id": 4,
"tag": "nginx",
"weight": 0,
"comment": ""
},
{
"id": 5,
"tag": "dubbo",
"weight": 0,
"comment": ""
},
{
"id": 6,
"tag": "spark",
"weight": 0,
"comment": ""
},
{
"id": 7,
"tag": "zookeeper",
"weight": 0,
"comment": ""
}
]
}
新增Tag返回数据例子:
{
"id": 2,
"tag": "tomcat",
"weight": 1,
"comment": "tomcat"
}
2、获取单个tag,修改tag、删除tag API¶
请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)
请求地址: /api/system/tag/2/
请求地址中2为tag的id
输入/输出参数: 见章节1中输入和输出参数说明,修改数据时输入参数均为非必须
返回数据例子:
{
"id": 2,
"tag": "tomcat",
"weight": 1,
"comment": "tomcat"
}