分组管理

Updated by MoreLogin

1 获取分组列表

基本信息

POST  /api/envgroup/page
  • 接口描述:查询分组信息,分组信息包括分组ID和分组名称,其中分组ID用于给环境分组。需将MoreLogin应用更新至2.9.0及以上版本。

请求参数

Body 参数, 非必传参数可以不传递,传参格式为JSON

参数名称

类型

必传

说明

pageNo

integer(int64)

当前页,默认:1

pageSize

integer(int64)

每页条数,默认:20

groupName

string

按分组名称查询

请求示例

{
"pageNo": 1,
"pageSize": 10,
"groupName": ""
}

返回数据

{
"code": 0, // 返回结果编码 0:正常 其他编码都是异常
"msg": "", // 错误信息
"data": {
"current": 0,
"dataList": [
{
"id": 0, // 分组ID
"groupName": "" // 分组名称
}
],
"pages": 0,
"total": 0
},
"requestId": "", // 操作请求ID
}

2 新建分组

基本信息

POST  /api/envgroup/create
  • 接口描述:添加分组,添加成功后可用于将环境进行分组操作,名称不能重复,创建成功后将返回分组ID。需将MoreLogin应用更新至2.9.0及以上版本。

请求参数

Body 参数, 非必传参数可以不传递,传参格式为JSON

参数名称

类型

必传

说明

groupName

string

分组名称

请求示例

{
"groupName": ""
}

返回数据

{
"code": 0, // 返回结果编码 0:正常 其他编码都是异常
"msg": "", // 错误信息
"data": 0, // 操作返回的数据
"requestId": "", // 操作请求ID
}

3 修改分组信息

基础信息

GET  /api/envgroup/edit
  • 接口描述: 修改分组信息,可以修改分组名称,名称不能重复。需将MoreLogin应用更新至2.14.0及以上版本。

请求参数

Body 参数, 非必传参数可以不传递,传参格式为JSON

参数名称

类型

必传

说明

groupName

string

分组名称

id

integer(int64)

分组ID

请求示例

{
"groupName": "",
"id": 0
}

返回数据

{
"code": 0, // 返回结果编码 0:正常 其他编码都是异常
"msg": "", // 错误信息
"data": true,
"requestId": "", // 操作请求ID
}

4 删除分组

基础信息

POST  /api/envgroup/delete
  • 接口描述: 删除指定的分组。需将MoreLogin应用更新至2.14.0及以上版本。

请求参数

Body 参数, 非必传参数可以不传递,传参格式为JSON

参数名称

类型

必传

说明

ids

array

分组ID

isDeleteAllEnv

boolean

是否同时删除分组内的环境,默认:false

false:不删除,true:删除

请求示例

{
"ids": [],
"isDeleteAllEnv": false
}

请求数据

{
"code": 0, // 返回结果编码 0:正常 其他编码都是异常
"msg": "", // 错误信息
"data": true,
"requestId": "", // 操作请求ID
}


How did we do?