环境变量¶
说明¶
- 管理环境变量的变量值
1、环境变量列表、新增环境变量、批量删除环境变量 API¶
请求方式: GET(查询) POST(新增) DELETE(批量删除)
请求地址: /api/system/system/environment/variable/
Content-Type:
新增数据的时候需要指定Content-Type,以下对Content-Type进行说明:
application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串
查询参数:
参数 | 数据类型 | 是否必须 | 说明 |
offset | int | 否 | 数据起始位置 |
limit | int | 否 | 查询条数 |
name | string | 否 | 变量名称 |
search | string | 否 | 模糊查询,查询字段为name |
输入参数(新增):
参数 | 数据类型 | 是否必须 | 说明 |
name | string | 是 | 变量名称 |
value | string | 是 | 变量值 |
remark | string | 否 | 备注 |
输出参数:
参数 | 数据类型 | 是否必须 | 说明 |
id | int | 是 | 环境变量 id |
name | string | 是 | 变量名称 |
value | string | 是 | 变量值 |
remark | string | 否 | 备注 |
批量删除参数:
参数 | 数据类型 | 是否必须 | 说明 |
pk | string | 与pk[]不能都为空 | 主键,多个主键用半角逗号隔开。通过http body传入 |
pk[] | array | 与pk不能都为空 | 主键数组。通过http body传入 |
排序:
参数 | 数据类型 | 是否必须 | 说明 |
ordering | string | 否 |
|
GET返回数据例子:
{
"count": 5,
"next": null,
"previous": null,
"results": [
{
"id": 5,
"name": "22",
"value": "",
"remark": ""
},
{
"id": 1,
"name": "权重测试1",
"value": "3",
"remark": "a"
}
]
}
新增环境变量返回数据例子:
{
"id": 1,
"name": "权重测试1",
"value": "3",
"remark": "a"
}
2、获取单个环境变量,修改环境变量、删除环境变量 API¶
请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)
请求地址: /api/system/system/environment/variable/1/
请求地址中1为环境变量的id
输入/输出参数: 见章节1中输入和输出参数说明,修改数据时输入参数均为非必须
返回数据例子:
{
"id": 1,
"name": "权重测试1",
"value": "3",
"remark": "a"
}