1. 设置

2. 租户页面设置

2.1. 页面设置结构说明

租户结构说明

2.2. 接口说明

2.2.1. 获取页面设置

请求URL

GET /api/v1/tenants/{tenantId} 需要认证：是

请求参数

URL Path 参数
字段 类型 是否必须 说明
tenantId LONG 是 租户的 id

返回对象格式说明

租户结构说明

接口示例1: 获取租户页面设置

GET /api/v1/tenants/{tenantId} 返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 10001,
    "tenantName": "tenant",
    "code": "tenant",
    "options": {
      "appMartTabOrders": [
        {
          "visible": true,
          "title": "公共空间1",
          "key": "system_portal"
        },
        {
          "visible": true,
          "title": "平台空间",
          "key": "vendor_area"
        },
        {
          "visible": true,
          "title": "我的空间",
          "key": "app_mart"
        }
      ]
    }
  }
}

2.2.2. 修改租户页面设置

请求URL

PUT /api/v1/tenants/{tenantId} 需要认证：是

请求参数

URL Path参数
字段 类型 是否必须 说明
tenantId LONG 是 租户的 id
request body 参数

租户结构说明， options.appMartTabOrders部分说明。

返回对象格式说明

租户结构说明

接口示例1: 修改租户页面设置

PUT /api/v1/tenants/{tenantId}

{
    "options":{
        "appMartTabOrders":[
            {
                "key":"system_portal",
                "title":"公共空间1",
                "visible":true
            },
            {
                "key":"vendor_area",
                "title":"平台空间",
                "visible":true
            },
            {
                "key":"app_mart",
                "title":"我的空间",
                "visible":true
            }
        ]
    }
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 10001,
    "tenantName": "tenant",
    "code": "tenant",
    "options": {
      "appMartTabOrders": [
        {
          "visible": true,
          "title": "公共空间1",
          "key": "system_portal"
        },
        {
          "visible": true,
          "title": "平台空间",
          "key": "vendor_area"
        },
        {
          "visible": true,
          "title": "我的空间",
          "key": "app_mart"
        }
      ]
    }
  }
}

3. 平台页面设置

3.1. 标签页设置结构说明

字段 类型 是否必须 描述
tabOrders JSON 数组 是 是否显示
tabOrders.visible BOOLEAN 是 是否显示
tabOrders.title STRING 是 标题
tabOrders.key STRING 是 租户应用集市标签页标识，可选值为：system_portal（公共空间），app_mart（我的空间）

3.2. 标签页接口说明

3.2.1. 获取标签页设置

请求URL

GET /api/v1/configurations/app-mart-tag 需要认证：是

请求参数

无

返回对象格式说明

标签页设置结构说明

接口示例1: 获取标签页设置

GET /api/v1/configurations/app-mart-tag 返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "tabOrders": [
      {
        "visible": true,
        "title": "我的空间",
        "key": "app_mart"
      },
      {
        "visible": true,
        "title": "公共空间1",
        "key": "system_portal"
      }
    ]
  }
}

3.2.2. 修改标签页设置

请求URL

PUT /api/v1/configurations/app-mart-tag 需要认证：是

请求参数

URL 参数

无

request body 参数

平台页面设置结构说明

返回对象格式说明

平台页面设置结构说明

接口示例1: 修改租户页面设置

PUT /api/v1/configurations/app-mart-tag

{
    "tabOrders":[
        {
            "visible":true,
            "title":"我的空间",
            "key":"app_mart"
        },
        {
            "visible":true,
            "title":"公共空间1",
            "key":"system_portal"
        }
    ]
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "tabOrders": [
      {
        "visible": true,
        "title": "我的空间",
        "key": "app_mart"
      },
      {
        "visible": true,
        "title": "公共空间1",
        "key": "system_portal"
      }
    ]
  }
}

3.3. 首页设置结构说明

字段 类型 是否必须 描述
defaultLandingPage STRING 是 默认首页，可选值为：home（首页），app_mart（应用集市）

3.4. 首页设置接口说明

3.4.1. 获取首页设置

请求URL

GET /api/v1/configurations/home 需要认证：是

请求参数

无

返回对象格式说明

首页设置结构说明

接口示例1: 获取首页设置

GET /api/v1/configurations/home 返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "defaultLandingPage": "app_mart"
  },
  "chartDataStartTimeMillis": 0
}

3.4.2. 修改首页设置

请求URL

PUT /api/v1/configurations/home 需要认证：是

请求参数

request body 参数

首页设置结构说明

返回对象格式说明

首页设置结构说明

接口示例1: 修改首页设置

PUT /api/v1/configurations/home

{"defaultLandingPage":"app_mart"}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "defaultLandingPage": "app_mart"
  },
  "chartDataStartTimeMillis": 0
}

4. 公开数仓

4.1. 数仓结构说明

字段 类型 描述
enable BOOL 公开数仓是否开启
host STRING 数仓地址
port INTEGER 数仓端口
username STRING 登录用户名
password STRING 登录密码

4.2. 接口说明

4.2.1. 获取数仓信息

请求URL

GET /api/v1/configurations/open-dwinfo 需要认证：是

请求参数

无

返回对象格式说明

数仓结构说明

接口示例1: 获取数仓信息

GET /api/v1/configurations/open-dwinfo 返回

{
    "version": "",
    "code": 0,
    "msg": "success",
    "data": {
        "enable": true,
        "host": "greenplum.hengshi.org",
        "port": 15432,
        "dbname": "dev_engine_hs_dw",
        "username": "demo",
        "password": "abcd"
    }
}

4.2.2. 修改数仓信息

PUT /api/v1/configurations/open-dwinfo

请求参数

request body
字段 类型 描述
enable BOOL 公开数仓是否开启
password STRING 登录密码

返回对象格式说明

数仓结构说明

接口示例1: 修改数仓信息

PUT /api/v1/configurations/open-dwinfo

{
    "password":"abcd",
    "enable":true
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "enable": true,
    "username": "demo",
    "password": "abcd"
  }
}

5. 皮肤

5.1. 皮肤结构说明

字段 类型 是否必须 描述
base STRING 是 皮肤，可选值为 ：light/dark
custom JSON 否 自定义皮肤的json对象

5.2. 接口说明

修改皮肤

请求URL

PUT /api/v1/configurations/skin

请求参数

URL 参数

无

request body 参数

皮肤结构说明

返回对象的格式说明

皮肤结构说明

6. 偏好配置

6.1. 偏好配置的定义

可以获取偏好的配置

6.1.1. 偏好结构说明

字段 类型 说明
version STRING 当前系统版本哈希值
data.skin.base STRING 皮肤，值为 ：light/dark
data.home.defaultLandingPage STRING 首页设置，参考首页设置结构说明

6.2. 接口说明

6.2.1. 获取偏好配置

请求URL

GET /api/v1/system-preferences

请求参数

URL 参数

无

request body 参数

无

返回对象的格式说明

偏好结构说明

7. 安全策略配置

7.1. 安全策略配置的定义

可以获取和修安全策略配置

7.1.1. 安全策略结构说明

字段 类型 描述
enableComplexPassword BOOL 是否启用复杂密码
enablePasswordExpire BOOL 是否密码90天失效
enableCaptcha BOOL 是否启用图片验证码
enableWatermark BOOL 是否开启水印保护
sessionTimeout INTEGER session 回话过期时间，单位是小时
enableHmac BOOL 是否启用HMAC签名保护
hmacKey STRING HMAC key
downloadRowLimit INTEGER 数据集和图片下载excel行数限制
exportingDataConfig.exportSwitch BOOL 是否允许导出数据
exportingDataConfig.policy 导出数据策略，可选值为：ENUM WHITE(包含), BLACK（排除）
exportingDataConfig.users BOOL 包含/排除的用户列表
exportingDataConfig.organizations BOOL 包含/排除的用户组列表
exportingDataConfig.orgs BOOL 包含/排除的组织架构列表
exportingDataConfig.tenants BOOL 包含/排除的租户列表

7.2. 接口说明

7.2.1. 获取安全策略配置

请求URL

GET /api/v1/configurations/security

请求参数

URL 参数

无

request body 参数

无

返回对象的格式说明

字段 类型 描述
data OBJECT 见 安全策略结构说明

接口示例1: 获取安全策略配置

GET /api/v1/configurations/security

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "enableComplexPassword": false,
    "enablePasswordExpire": false,
    "enableCaptcha": false,
    "enableWatermark": false,
    "exportingDataConfig": {
      "exportSwitch": true,
      "policy": "WHITE",
      "users": [],
      "organizations": [
        {
          "id": 0,
          "name": "ALL_USERS"
        }
      ],
      "orgs": [],
      "tenants": [
        {
          "id": 0,
          "tenantName": "ALL_TENANTS"
        }
      ]
    },
    "downloadRowLimit": 100000,
    "sessionTimeout": "38",
    "sessionTimeoutInt": 38
  }
}

7.2.2. 修改安全策略配置

请求URL

PUT /api/v1/configurations/security

请求参数

URL 参数

无

request body 参数

见 安全策略结构说明

返回对象的格式说明

字段 类型 描述
data OBJECT 见 安全策略结构说明

接口示例1: 修改安全策略配置

PUT /api/v1/configurations/security

{
  "exportingDataConfig":{
    "exportSwitch":true,
    "policy":"WHITE",
    "users":[
      {
        "id":29
      }
    ],
    "organizations":[
      {
        "id":0
      }
    ],
    "orgs":[

    ],
    "tenants":[
      {
        "id":0,
        "tenantName":"ALL_TENANTS",
        "code":"ALL_TENANTS",
        "resetPassword":true,
        "isTenant":true
      }
    ]
  }
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "enableComplexPassword": false,
    "enablePasswordExpire": false,
    "enableCaptcha": false,
    "enableWatermark": false,
    "exportingDataConfig": {
      "exportSwitch": true,
      "policy": "WHITE",
      "users": [],
      "organizations": [
        {
          "id": 0,
          "name": "ALL_USERS"
        }
      ],
      "orgs": [],
      "tenants": [
        {
          "id": 0,
          "tenantName": "ALL_TENANTS"
        }
      ]
    },
    "downloadRowLimit": 100000,
    "sessionTimeout": "38",
    "sessionTimeoutInt": 38
  }
}

8. 系统设置

8.1. 系统设置的定义

可以获取和修系统设置

8.1.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 停止应用创作的数据集定时更新

8.2. 接口说明

8.2.1. 获取系统设置

请求URL

GET /api/v1/configurations/everest

请求参数

URL 参数

无

request body 参数

无

返回对象的格式说明

字段 类型 描述
data OBJECT 见 系统设置结构说明

接口示例:获取系统设置

GET /api/v1/configurations/everest

返回

{
    "version":"",
    "code":0,
    "msg":"success",
    "data":{
        "baseUrl": "https://develop.hengshi.org",
        "datasetCacheLimit": 500000,
        "hsResultCacheInterval": 7200,
        "startTime": 1634734561711,
        "version": "",
        "totalEngineResource":10000,
        "cpuPerResourceUnit":0.001,
        "memPerResourceUnit":10,
        "disableAreaRefresh":false
    }
}

8.2.2. 修改系统设置

请求URL

PUT /api/v1/configurations/everest

请求参数

URL 参数

无

request body 参数

见 系统设置结构说明中的非只读字段

返回对象的格式说明

字段 类型 描述
data OBJECT 见 系统设置结构说明

接口示例:修改系统设置

PUT /api/v1/configurations/everest

{
    "baseUrl": "https://develop.hengshi.org",
    "datasetCacheLimit": 500000,
    "hsResultCacheInterval": 7200,
    "totalEngineResource":1000,
    "disableAreaRefresh":true
}

返回

{
    "version":"",
    "code":0,
    "msg":"success",
    "data":{
        "baseUrl": "https://develop.hengshi.org",
        "datasetCacheLimit": 500000,
        "hsResultCacheInterval": 7200,
        "startTime": 1634734561711,
        "version": "",
        "totalEngineResource":1000,
        "cpuPerResourceUnit":0.01,
        "memPerResourceUnit":100,
        "disableAreaRefresh":true
    }
}

8.2.3. GET 获取日志清理计划配置信息

GET /api/configurations/running-log

获取当前衡石系统日志清理计划的配置信息。

返回示例

成功

{
"code": 0,
"msg": "success",
"data": {
"days": 7
},
"chartDataStartTimeMillis": 0
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» code integer true none none
» msg string true none none
» data object true none none
»» days integer true none 日志保留天数
» chartDataStartTimeMillis integer true none none

8.2.4. GET 获取日志清理任务状态

GET /api/running-log/log

获取当前衡石系统清理任务的状态信息。

返回示例

成功

{
  "code": 0,
  "msg": "success",
  "data": {
    "executeObject": "系统",
    "endingTime": "2023-08-10 22:08:00",
    "startTime": "2023-08-10 22:00:00",
    "status": "FAILED",
    "releaseSize": 0,
    "earliestSaveTime": "2023-08-04"
  },
  "chartDataStartTimeMillis": 0
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» code integer true none none
» msg string true none none
» data object true none none
»» executeObject string true none 触发此次清理任务的对象（具体用户或者衡石系统）
»» endingTime string true none 任务结束时间
»» startTime string true none 任务开始时间
»» status string true none 任务状态
»» releaseSize integer true none 释放空间大小
»» earliestSaveTime string true none 日志最早保留时间
» chartDataStartTimeMillis integer true none none

results matching ""

    No results matching ""

    通用数据查询接口 数据连接

    衡石文档