主题
创建用户组
- 本接口只允许创建普通用户组和外部数据用户组
- 用户组的名称,用户组的代码不允许重复
- 第三方系统不允许在系统域下创建用户组
接口说明
请求URL:http[s]://{网关地址}/minos-platform/group/add
请求方式: POST
请求内容类型: application/json
响应内容类型: application/json
请求说明
请求体
| 字段名 | 参数名 | 是否必填 | 类型 | 描述 |
|---|---|---|---|---|
| 用户组id | groupId | M | String | 用户组编码 |
| 用户组名称 | groupName | M | String | 用户组名称 |
| 所属域 | domainId | M | String | 所属域ID |
| 数据源名称 | datasourceName | O | String | 当与dynamicSql都不为空时,则为创建外部数据用户组 |
| 动态组sql语句 | dynamicSql | O | String | 当与datasourceName都不为空时,则为创建外部数据用户组,采用AES加密传输 |
| 备注 | groupRemark | O | String | 备注 |
| 自动更新 | autoSyn | O | int | 仅针对外部数据 0:不开启 1:开启 |
| 间隔时间 | syncPeriod | O | int | 间隔时间,当自动更新开启时为必传 |
| 间隔时间单位 | syncPeriodUnit | *M | String | 1:分钟 2:小时 3:天 当自动更新开启时为必传 |
| 首次同步时间 | firstSyncTime | *M | String | 格式yyyy-MM-dd HH:mm:ss,当自动更新开启时为必传 |
请求示例
json
{
"groupId":"gp001",
"groupName":"gp001",
"domainId":"-200",
"datasourceName": "61platform",
"dynamicSql": "2wvg/eeQmxeVr2mXTWxkdEUQYtbBCsYxm+kH6MDqtXi2mM15DJSfuvzHSvsr7JmR",
"groupRemark": "这是备注",
"autoSyn":1,
"syncPeriod": 1,
"syncPeriodUnit": "1",
"firstSyncTime":"2022-08-25 16:00:01"
}1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
响应说明
响应体
| 字段名 | 参数名 | 是否必填 | 类型 | 描述 |
|---|---|---|---|---|
| 返回码 | errcode | M | String | 返回码,0 成功,其他为错误 |
| 返回码描述 | errmsg | M | Sring | 返回码描述 |
| 返回对象 | data | O | Group | 返回的用户组对象 |
| 字段名 | 参数名 | 是否必填 | 类型 | 描述 |
|---|---|---|---|---|
| 用户组id | groupId | M | String | 用户组编码 |
| 用户组名称 | groupName | M | String | 用户组名称 |
| 所属域 | domainId | M | String | 所属域ID |
| 数据源名称 | datasourceName | O | String | 当为外部数据用户组类型时返回此字段 |
| 动态组sql语句 | dynamicSql | O | String | 当为外部数据用户组类型时返回此字段 |
| 数据源wid | datasourceWid | O | String | 当为外部数据用户组类型时返回此字段 |
| 备注 | groupRemark | O | String | 备注 |
| 自动更新 | autoSyn | O | int | 0:不开启 1:开启 |
| 间隔时间 | syncPeriod | O | int | 间隔时间 |
| 间隔时间单位 | syncPeriodUnit | O | String | 1:分钟 2:小时 3:天 |
| 首次同步时间 | firstSyncTime | O | String | 格式yyyy-MM-dd HH:mm:ss |
| 上次同步时间 | lastSyncTime | O | String | 格式yyyy-MM-dd HH:mm:ss |
响应示例
json
{
"errcode": "0",
"errmsg": "操作成功",
"data": {
"groupId": "gp001",
"groupName": "gp001",
"domainId": "-200",
"datasourceName": "61platform",
"datasourceWid": "1001147653935230976",
"dynamicSql": "2wvg/eeQmxeVr2mXTWxkdEUQYtbBCsYxm+kH6MDqtXi2mM15DJSfuvzHSvsr7JmR",
"autoSyn": 1,
"syncPeriod": 1,
"syncPeriodUnit": "1",
"firstSyncTime": "2022-08-25 16:00:01"
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
错误码
| 错误码 | 描述 |
|---|---|
| 111001 | 必填参数不能为空 |
| 111002 | 请求参数格式错误 |
| 111003 | 请求参数长度超出范围 |
| 111006 | 用户组id或名称已经存在 |
| 111007 | 业务域不存在 |
| 116008 | 系统域下不允许创建用户组 |
| 116009 | 数据源不存在 |
| 116019 | 高级选项中的动态用户组开关未开启,不可创建外部数据类型的用户组 |
Demo
创建普通用户组
java
// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
GroupAddRequest request = new GroupAddRequest();
request.setGroupId("grouptest001");
request.setGroupName("grouptest001");
request.setDomainId("1124046240062230528");
BaseResponse response = client.execute(request);
//调用成功,则处理业务逻辑
if (response.isSuccess()) {
//.....
}1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
创建外部数据用户组
java
// 创建客户端
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
// 创建请求对象
GroupAddRequest request = new GroupAddRequest();
request.setGroupId("grouptest002");
request.setGroupName("grouptest002");
request.setDomainId("1124046240062230528");
request.setDatasourceName("minos");
request.setDynamicSql("2wvg/eeQmxeVr2mXTWxkdEUQYtbBCsYxm+kH6MDqtXi2mM15DJSfuvzHSvsr7JmR");
request.setAutoSyn(1);
request.setSyncPeriod(2);
request.setSyncPeriodUnit("2");
request.setFirstSyncTime("2024-07-25 16:00:00");
BaseResponse response = client.execute(request);
//调用成功,则处理业务逻辑
if (response.isSuccess()) {
//.....
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

