DICloak API-环境分组接口

一、环境分组接口

GET 获取环境分组列表

GET /v1/env/group

请求参数

名称	位置	类型	必选	说明
page_no	query	integer(int32)	否	页码，默认1
page_size	query	integer(int32)	否	分页大小，默认10
all	query	boolean	否	是否获取全量数据，当为true时，忽略pageNo和pageSize
detail	query	boolean	否	是否需要详情
name	query	string	否	名称
remark	query	string	否	备注
env_id	query	string	否	包含环境
member_id	query	string	否	授权成员
X-API-KEY	header	string	是	none

返回结果

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "create_time": "string",
        "update_time": "string",
        "org_id": "string",
        "name": "string",
        "remark": "string",
        "member_list": [
          {
            "group_id": null,
            "env_group_name": null,
            "member_id": null,
            "member_name": null
          }
        ],
        "env_list": [
          {
            "name": null,
            "serial_num": null
          }
        ],
        "is_default": true
      }
    ],
    "total": 0
  }
}

名称	类型	说明
id	string	id
create_time	string	创建时间
update_time	string	修改时间
org_id	string	组织Id
name	string	名称
remark	string	备注
member_list	EnvironmentGroupMemberVO	授权成员
env_list	Env	包含环境列表
is_default	boolean	默认分组

EnvironmentGroupMemberVO

名称	类型	说明
group_id	string	环境组ID
env_group_name	string	环境组名称
member_id	string	成员ID
member_name	string	成员名称

Env

名称	类型	必选	说明
name	string	否	名称
serial_num	string	否	序号

GET 获取环境分组详情

GET /v1/env/group/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是
X-API-KEY	header	string	是

返回结果

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "org_id": "string",
    "name": "string",
    "remark": "string",
    "member_list": [
      {
        "group_id": "string",
        "env_group_name": "string",
        "member_id": "string",
        "member_name": "string"
      }
    ],
    "env_list": [
      {
        "name": "string",
        "serial_num": "string"
      }
    ],
    "is_default": true
  },
  "next": "string"
}

名称	类型	说明
code	integer
msg	string
data	OpenEnvironmentGroupVO	参考列表字段
next	string

POST 创建环境分组

POST /v1/env/group

请求参数

名称	位置	类型	必选	说明
X-API-KEY	header	string	是
body	body	EnvironmentGroupEditReq	否

{
  "name": "string",
  "member_ids": [
    "string"
  ],
  "remark": "string"
}

名称	类型	必选	说明
name	string	否	名称
member_ids	string	否	授权成员
remark	string	否	备注

返回结果

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "org_id": "string",
    "name": "string",
    "remark": "string",
    "member_list": [
      {
        "group_id": "string",
        "env_group_name": "string",
        "member_id": "string",
        "member_name": "string"
      }
    ],
    "env_list": [
      {
        "name": "string",
        "serial_num": "string"
      }
    ],
    "is_default": true
  },
  "next": "string"
}

名称	类型	说明
code	integer
msg	string
data	OpenEnvironmentGroupVO	参考列表字段
next	string

PUT 修改环境分组

PUT /v1/env/group/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是
X-API-KEY	header	string	是
body	body		否

{
  "name": "string",
  "member_ids": [
    "string"
  ],
  "remark": "string"
}

名称	类型	必选	说明
name	string	否	名称
member_ids	[string]	否	授权成员
remark	string	否	备注

返回结果

{
  "code": 0,
  "msg": "string",
  "data": {}
}

DELETE 删除环境分组

DELETE /v1/env/group/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是
X-API-KEY	header	string	是
body	body	EnvGroupDelReq	否

{
  "del_env": true
}

名称	类型	必选	说明
del_env	boolean	否	是否删除环境

返回结果

{
  "code": 0,
  "msg": "string",
  "data": {}
}