1. 设置
1.1. 公开数仓
1.1.1. 数仓结构说明
| 字段 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 公开数仓是否开启 |
| host | STRING | 数仓地址 |
| port | INTEGER | 数仓端口 |
| username | STRING | 登录用户名 |
| password | STRING | 登录密码 |
1.1.2. 接口说明
获取数仓信息
GET /api/configurations/open-dwinfo
需要认证：是
请求参数
无
返回对象格式说明
修改数仓信息
PUT /api/configurations/open-dwinfo
请求参数
request body
| 字段 | 类型 | 描述 |
|---|---|---|
| enable | BOOL | 公开数仓是否开启 |
| password | STRING | 登录密码 |
返回对象格式说明
1.2. 皮肤
1.2.1. 皮肤的定义
皮肤结构说明
| 字段 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| base | STRING | 是 | 皮肤，可选值为 ：light/dark |
1.3. 接口说明
1.3.1. 修改皮肤
请求URL
PUT /api/v1/configurations/skin
请求参数
URL 参数
无
request body 参数
返回对象的格式说明
| 字段 | 类型 | 说明 |
|---|---|---|
| version | STRING | 当前系统版本哈希值 |
| data.base | STRING | 皮肤，值为 ：light/dark |
1.4. 偏好配置
1.4.1. 偏好配置的定义
可以获取偏好的配置
偏好结构说明
1.5. 接口说明
1.5.1. 获取偏好配置
请求URL
GET /api/v1/system-preferences
请求参数
URL 参数
无
request body 参数
无
返回对象的格式说明
| 字段 | 类型 | 说明 |
|---|---|---|
| version | STRING | 当前系统版本哈希值 |
| data.skin.base | STRING | 皮肤，值为 ：light/dark |
1.6. 安全策略配置
1.6.1. 安全策略配置的定义
可以获取和修安全策略配置
安全策略结构说明
| 字段 | 类型 | 描述 |
|---|---|---|
| enableComplexPassword | BOOL | 是否启用复杂密码 |
| enablePasswordExpire | BOOL | 是否密码90天失效 |
| enableCaptcha | BOOL | 是否启用图片验证码 |
| enableWatermark | BOOL | 是否开启水印保护 |
| allowExportingData | BOOL | 是否允许导出数据 |
| enableHmac | BOOL | 是否启用HMAC签名保护 |
| hmacKey | STRING | HMAC key |
| downloadRowLimit | INTEGER | 数据集和图片下载excel行数限制 |
1.7. 接口说明
1.7.1. 获取全策略配置
请求URL
GET /api/v1/configurations/security
请求参数
URL 参数
无
request body 参数
无
返回对象的格式说明
| 字段 | 类型 | 描述 |
|---|---|---|
| data | OBJECT | 见 安全策略结构说明 |
1.7.2. 修改全策略配置
请求URL
PUT /api/v1/configurations/security
请求参数
URL 参数
无
request body 参数
见 安全策略结构说明
返回对象的格式说明
| 字段 | 类型 | 描述 |
|---|---|---|
| data | OBJECT | 见 安全策略结构说明 |
1.8. 系统设置配置
1.8.1. 系统设置配置的定义
可以获取和修系统设置配置
系统设置结构说明
| 字段 | 类型 | 描述 |
|---|---|---|
| version | STRING | 当前版本号（只读） |
| startTime | INTEGER | 系统启动时间，精确到毫秒（只读） |
| baseUrl | STRING | 系统域名 |
| hsHttpProxy | STRING | HTTP代理 |
| hsResultCacheInterval | INTEGER | 图表数据换成周期（秒） |
| datasetCacheLimit | INTEGER | 数据集缓存大小限制（MB） |
| disableCSRF | BOOL | 是否停用CSRF |
| totalEngineResource | INTEGER | 租户能用的总资源数 |
| cpuPerResourceUnit | NUMBER | 资源数代表的cpu核数（只读 ） |
| memPerResourceUnit | NUMBER | 资源数代表的内存大小，单位MB（只读） |
| disableAreaRefresh | BOOL | 停止应用创作的数据集定时更新 |
1.9. 接口说明
1.9.1. 获取系统设置配置
请求URL
GET /api/configurations/everest
请求参数
URL 参数
无
request body 参数
无
返回对象的格式说明
| 字段 | 类型 | 描述 |
|---|---|---|
| data | OBJECT | 见 系统设置结构说明 |
接口示例:
GET /api/configurations/everest
返回
{
"version":"",
"code":0,
"msg":"success",
"data":{
"baseUrl": "https://develop.hengshi.org",
"datasetCacheLimit": 500000,
"hsResultCacheInterval": 7200,
"startTime": 1634734561711,
"version": "3.6-SNAPSHOT@22c6a15#833d712",
"totalEngineResource":10000,
"cpuPerResourceUnit":0.001,
"memPerResourceUnit":10,
"disableAreaRefresh":false
}
}
1.9.2. 修改系统设置配置
请求URL
PUT /api/configurations/everest
请求参数
URL 参数
无
request body 参数
见 系统设置结构说明中的非只读字段
返回对象的格式说明
| 字段 | 类型 | 描述 |
|---|---|---|
| data | OBJECT | 见 系统设置结构说明 |
接口示例:
PUT /api/configurations/everest
{
"baseUrl": "https://develop.hengshi.org",
"datasetCacheLimit": 500000,
"hsResultCacheInterval": 7200,
"totalEngineResource":1000,
"disableAreaRefresh":true
}
返回 ```json { "version":"", "code":0, "msg":"success", "data":{ "baseUrl": "https://develop.hengshi.org", "datasetCacheLimit": 500000, "hsResultCacheInterval": 7200, "startTime": 1634734561711, "version": "3.6-SNAPSHOT@22c6a15#833d712", "totalEngineResource":1000, "cpuPerResourceUnit":0.01, "memPerResourceUnit":100, "disableAreaRefresh":true } }