主机清单列表¶
说明¶
- 管理主机清单
1、主机清单列表、新增主机清单、批量删除主机清单 API¶
请求方式: GET(查询) POST(新增) DELETE(批量删除)
请求地址: /api/project/inventory/
Content-Type:
新增数据的时候需要指定Content-Type,以下对Content-Type进行说明:
application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串
查询参数:
参数 | 数据类型 | 是否必须 | 说明 |
offset | int | 否 | 数据起始位置 |
limit | int | 否 | 查询条数 |
name | string | 否 | 项目名称 |
search | string | 否 | 模糊查询,查询字段为name和description |
输入参数(新增):
参数 | 数据类型 | 是否必须 | 说明 |
name | string | 是 | 名称 |
description | string | 否 | 描述 |
variables | string | 否 | 参数 |
inventory | string | 否 | 主机清单内容 |
credential | int | 否 | 登录凭据ID |
输出参数:
参数 | 数据类型 | 是否必须 | 说明 |
id | int | 是 | inventory id |
name | string | 是 | 名称 |
description | string | 否 | 描述 |
variables | string | 否 | 参数 |
inventory | string | 否 | 主机清单内容 |
credential | int | 否 | 登录凭据ID |
批量删除参数:
参数 | 数据类型 | 是否必须 | 说明 |
pk | string | 与pk[]不能都为空 | 主键,多个主键用半角逗号隔开。通过http body传入 |
pk[] | array | 与pk不能都为空 | 主键数组。通过http body传入 |
排序:
参数 | 数据类型 | 是否必须 | 说明 |
ordering | string | 否 |
|
GET返回数据例子:
{
"count": 9,
"next": null,
"previous": null,
"results": [
{
"id": 18,
"cuser": 48,
"name": "阿里云主机",
"description": "",
"variables": "",
"credential": 35
},
{
"id": 17,
"cuser": 48,
"name": "1234",
"description": "",
"variables": "",
"credential": 35
}
]
}
新增主机清单返回数据例子:
{
"id": 18,
"cuser": 48,
"name": "阿里云主机",
"description": "",
"variables": "",
"credential": 35
},
2、获取单个主机清单,修改主机清单、删除主机清单 API¶
请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)
请求地址: /api/project/inventory/18/
请求地址中18为主机清单的id
输入/输出参数: 见章节1中输入和输出参数说明,修改数据时输入参数均为非必须
返回数据例子:
{
"id": 18,
"cuser": 48,
"name": "阿里云主机",
"description": "",
"variables": "",
"credential": 35
},