这类接口供SysAdmin进行业务应用的设置、进行数据源的设置、进行缓存的设置。
如果在MatrixAuthServer启动时在参数中通过matrixauth.server.adminToken
设置了adminToken
,则在调用所有面向SysAdmin的接口时,需要在接口参数中通过adminToken
参数设置adminToken
,否则接口会报出“Administrator token verification failed.”错误。
1 数据源设置接口
/datasource/add
: 增加一个数据源。
参数名称 |
是否必填 |
参数含义 |
dataSourceName |
是 |
数据源名称,这是数据源的唯一标识,设置后不允许再修改。 |
dataSourceUrl |
是 |
数据源地址 |
dataSourceDriver |
是 |
数据源驱动 |
dataSourceUserName |
否 |
数据源用户名 |
dataSourcePassword |
否 |
数据源密码 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/datasource/update
: 更新数据源信息。
参数名称 |
是否必填 |
参数含义 |
dataSourceName |
是 |
数据源名称,该字段用来索引需要修改的数据源。不允许变更 |
dataSourceUrl |
是 |
数据源地址 |
dataSourceDriver |
是 |
数据源驱动 |
dataSourceUserName |
否 |
数据源用户名 |
dataSourcePassword |
否 |
数据源密码 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/datasource/queryAll
: 查询所有的数据源。
参数名称 |
是否必填 |
参数含义 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/datasource/queryByName
: 依据名称查询一个数据源。
参数名称 |
是否必填 |
参数含义 |
dataSourceName |
是 |
要查询的数据源的名称 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/datasource/deleteByName
: 依据名称删除一个数据源。
参数名称 |
是否必填 |
参数含义 |
dataSourceName |
是 |
要删除的数据源的名称 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
2 缓存设置接口
参数名称 |
是否必填 |
参数含义 |
cacheName |
是 |
缓存名称,这是缓存的唯一性标识,设置后不允许再修改。 |
cacheUrl |
是 |
缓存地址 |
cachePassword |
否 |
缓存密码 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
参数名称 |
是否必填 |
参数含义 |
cacheName |
是 |
缓存名称,该字段用来索引需要修改的缓存。不允许变更 |
cacheUrl |
是 |
缓存地址 |
cachePassword |
否 |
缓存密码 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/cache/queryAll
: 查询所有的缓存。
参数名称 |
是否必填 |
参数含义 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/cache/queryByName
: 依据名称查询一个缓存。
参数名称 |
是否必填 |
参数含义 |
cacheName |
是 |
要查询的缓存的名称 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/cache/deleteByName
: 依据名称删除一个缓存。
参数名称 |
是否必填 |
参数含义 |
cacheName |
是 |
要删除的缓存的名称 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
3 应用设置接口
/application/add
: 新增加一个业务应用,以备接入。
参数名称 |
是否必填 |
参数含义 |
appName |
是 |
业务应用名称,这是业务应用的唯一性标识,设置后不允许再修改。 |
appToken |
否 |
业务应用的appToken,如果设置,则后续对该应用进行权限设置时需要携带该appToken以验明业务管理员身份 |
dataSourceName |
否 |
业务应用使用的数据源名称。如果设置,则该业务应用的权限信息将存入该名称指定的数据源;否则,将使用MatrixAuthServer的默认数据源 |
cacheName |
否 |
业务应用的缓存名称,如果设置,则该业务应用的权限信息将使用该名称指定的缓存;否则,该业务应用的权限信息将不使用缓存 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/application/update
: 更新一个业务应用的信息。
参数名称 |
是否必填 |
参数含义 |
appName |
是 |
业务应用名称,该字段仅用来锁定要更新的业务应用,不允许变更。 |
appToken |
否 |
业务应用的appToken |
dataSourceName |
否 |
业务应用使用的数据源名称。 |
cacheName |
否 |
业务应用的缓存名称。 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/application/queryAll
: 查询所有的业务应用。
参数名称 |
是否必填 |
参数含义 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/application/queryByName
: 依据名称查询一个业务应用。
参数名称 |
是否必填 |
参数含义 |
appName |
是 |
要查询的业务应用的名称 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |
/application/deleteByName
: 依据名称删除一个业务应用。
参数名称 |
是否必填 |
参数含义 |
appName |
是 |
要删除的业务应用的名称 |
adminToken |
否 |
用来进行系统管理员身份校验的依据 |