HTTP API – Profile Group Interface

by DICloak
2025-11-282025-12-1

GET Obtain Profile Group List

GET /v1/api/request/env/group

Request Parameters

Name	Location	Type	Required	Instructions
page_no	query	integer(int32)	No	Page number, default 1
page_size	query	integer(int32)	No	Page size, default 10
all	query	boolean	No	Whether to obtain full data. When it is true, pageNo and pageSize are ignored
detail	query	boolean	No	Do you need details?
name	query	string	No	Name
remark	query	string	No	Remarks
env_id	query	string	No	Contains Profile
member_id	query	string	No	Authorized Member
X-HTTP-KEY	header	string	Yes	none

Return Result

{
  "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
  }
}

Name	Type	Description
id	string	id
create_time	string	Creation Time
update_time	string	Modification Time
org_id	string	Organization ID
name	string	Name
remark	string	Remarks
member_list	ProfileGroupMemberVO	Authorized Member
env_list	Env	Contains Profile list
is_default	boolean	Default Grouping

ProfileGroupMemberVO

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

Env

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

GET Retrieve Profile Group Details

GET /v1/api/request/env/group/{id}

Request Parameters

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

Return Result

{
  "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	HttpApiProfileGroupVO	参考列表字段
next	string

POST Save Profile Group

POST /v1/api/request/env/group

Request Parameters

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

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

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

Return Result

{
  "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	HttpApiProfileGroupVO	参考列表字段
next	string

DICloak Help Center