用户手册
# 版本更新说明
本文档根据实际进行更新,最新版本包含历史修改记录。
| 日期 | 手册版本 | 适用产品 | 更新说明 |
|---|---|---|---|
| 2024年5月 | V11F01 | 金蝶Apusic许可授权中心V1.1 | 修正文档描述 |
| 2024年12月 | V11F02 | 金蝶Apusic许可授权中心V1.1 | 更新登录动态码、删除授权、修改密码和常见配置修改说明的功能描述 |
| 2025年3月 | V11F03 | 金蝶Apusic许可授权中心V1.1 | 更新命名空间自定义和日志下载功能描述 |
| 2025年5月 | V11F04 | 金蝶Apusic许可授权中心V1.1 | 更新支持高可用部署使用数据库、支持星空oem产品授权的功能描述 |
# 前言
# 产品简介
在云环境中,随着虚拟机、容器的增加和启停,各个中间件产品运行的环境在变化,IP地址也在变化,各个中间件产品通过限制IP的授权模式已经不能适应客户的部署需求。基于此,实现Apusic许可授权中心(Apusic Cloud License Server,简称"ACLS"),便于对中间件产品的授权进行统一管理。
# 范围和读者
本手册介绍ACLSV1.1产品的使用详细说明,适用于ACLS产品的用户,ACLS产品技术顾问,ACLS产品维护人员,以及希望学习了解ACLS产品的相关人员。
# 文档导航
| 章节 | 内容概述 |
|---|---|
| 1. 前言 | 产品简介,文档范围,约定内容 |
| 2. 快速开始 | 产品快速使用说明 |
| 3. 授权管理 | 对授权中心的授权管理功能的使用说明 |
| 4. 在线实例 | 对授权中心的在线实例功能的使用说明 |
| 5. 使用统计 | 对授权中心的使用统计功能的使用说明 |
# 约定与术语
ACLS
金蝶Apusic许可授权中心(Apusic Cloud License Server)
# 快速开始
# 系统部署架构
授权中心以各个中间件产品运行的独立组件作为授权的单位,部署架构如下图所示:

授权中心独立部署在固定的IP地址机器中,各个环境下的产品或产品组件连接到授权中心进行认证,如果认证通过,则产品或产品组件启动成功;如果认证不通过,则产品或产品组件启动不成功。 从部署架构可看到,授权中心通过中间件产品的授权文件来管控中间件产品。
【注意】中间件产品的授权文件:在授权中心管控台中导入,或者放置在授权中心的专用目录下,授权中心启动后,会读取授权文件,用于协助各个中间件产品/组件启动的请求验证。
# 申请授权文件
产品的授权文件需要与授权中心部署机器的特征码进行绑定,在申请授权文件时,需要获取特征码。
# 获取特征码
授权中心提供两个获取特征码的方式,一种是通过运行命令行的方式获取,另一种是通过登录授权中心管控台的方式获取。特征码作为申请授权使用,需要发回到金蝶天燕生成授权文件,具体示例如下:
1.通过运行命令行的方式获取: 进入解压后的ACLS_HOME目录ACLS_HOME/domains/mydomain/bin/,运行“startup.sh -ac IP”命令获取其中IP为授权中心对外链接的IP地址,会输出类似如下的信息:
Auth Code=SZTY-6558630195468794381
【注意】:这里的IP地址根据实际部署环境修改;如果存在多个IP地址,需要提供一个其他中间件部署环境能连接到的IP地址;地址不能是127.0.0.1这样的回环地址。
操作示例如下:

2.通过登录授权中心管控台的方式获取:
登录授权中心,访问菜单【软件特征码】,即可在“软件特征码”窗口中查看并复制到特征码。
操作示例如下:

# 申请中间件产品授权文件
参照【获取特征码】,将获取的特征码发回到金蝶天燕生成中间件产品的授权文件。例如,向金蝶天燕购买应用服务器产品的授权20个,购买时间为2023-05-15至2023-08-23,金蝶天燕会根据该信息生成该中间件产品的授权文件。
客户获得授权文件后,登陆授权中心的管控界面,在授权管理中导入该授权文件。
# 导入中间件产品授权文件
参照【申请授权中心授权文件】,成功启动并登录授权中心管控台。访问菜单【系统管理-授权管理】,点击"导入"按钮,导入【申请中间件产品授权文件】申请的文件。
【注意】产品授权文件也可放置在授权中心ACLS_HOME/host-license目录下,重启授权中心时,会加载该目录的产品授权文件到系统中。

导入成功后,在授权管理列表中可以查看到对应的中间件授权信息。

# 配置中间件产品授权租户(可选)
在导入授权文件后,默认租户public将拥有全部实例授权总数。在授权信息的授权详情页面中,授权中心支持租户自定义分配其授权时间段内的实例数量,也支持通过黑白名单来限制使用授权。
操作示例如下:
1.授权文件导入后,在授权管理列表中点击"查看"进入授权详情页面。可查看到默认租户public拥有50个实例的授权数量,剩余可分配数为50。

2 . 点击"租户信息"标签页中的"新增"按钮,新增一个租户"Apusic测试",并为其分配5个实例的授权数量。

点击"确定"完成新增后,默认租户public拥有45个实例的授权数量,剩余可分配数为45。而租户"Apusic测试"拥有5个实例的授权数量。

3 . 在租户列表中,点击租户"Apusic测试"的"黑名单"按钮,进行黑名单设置,支持正则表达式。
如下图,限制172.24.4.*网段所有的IP不能使用此租户授权。

# 配置中间件产品连接授权中心
在另一台服务器上部署中间件产品,设置授权中心连接配置,中间件产品在启动的时候,将通过此配置向授权中心验证其授权信息,当授权信息验证通过时,中间件产品启动成功。
授权中心配置连接参数包括如下:
| 参数名 | 参数值说明 |
|---|---|
| apusic_acls_enable | 是否开启授权中心认证,取值为true或false,为true则表示开启授权中心认证。没有该参数或该参数值为false,都表示没有开启授权中心认证; |
| apusic_acls_authUrls | 授权中心的地址,可设置多个授权地址,格式为ip1:port1,ip2:port2,如果一个授权地址链接失败,会轮询其他的地址;如果开启授权中心认证,则为必填参数,其中端口为授权中心的https端口; |
| apusic_acls_ns | 设置该实例所属的命名空间名称,可选参数;默认值为public,具体的命名空间可以在授权中心管理控制台-系统管理-授权管理查看。 |
| apusic_acls_tenant | 设置该实例所属的租户名称,可选参数。 |
【注意】参数设置支持三种方式:JVM参数、系统变量参数以及配置文件中,参数名字不变。在系统中读取的优先级为JVM参数>系统变量参数>配置文件参数。
以AASV10敏捷版中间件产品为例,操作示例如下:
- 配置文件方式:
在AASv10产品的根目录下创建acls.properties文件,并加入对应的参数,如下所示,然后启动AASv10产品既可。(acls.properties文件放置的具体目录,可以查询各个产品的部署说明)

- 系统变量方式:
在系统环境中设置环境变量,如下图所示,也可以开启集中授权:

- JVM参数方式:
修改启动脚本apusic.sh,加入JVM参数也可以开启集中授权,如下图所示:

授权验证成功:
【注意】在容器环境下,可以使用容器方式注入上述参数即可。
# 查看在线授权实例
访问授权中心的管理控制台,在菜单【系统管理-授权管理】,可查看当前授权中间件产品的使用情况。

点击授权管理列表中的已用数量,可跳转到在线实例页面,查看中间件产品的在线实例信息。

# 查看在线授权使用统计
授权中心支持对产品实例的历史使用时间段的统计查询操作。
在授权管理页面的列表中,选择某一产品授权信息,点击其操作列中的【查看】按钮,可在授权信息详情页面中查看当前授权中间件产品的付费模式。

访问菜单【系统管理-使用统计】,按产品名称等条件可查询到在线实例使用统计信息。点击【导出】按钮,可对使用统计情况导出成Excel文件,便于进行后付费计算。

# 授权管理
# 业务概述
授权管理是对中间件产品的授权文件信息进行统一管理。用户在购买金蝶天燕的产品后,将获取到对应产品的授权文件,在授权中心中,通过授权管理导入所授予的产品授权文件,实时查看授权使用数量和使用时效,并以此作为接收各个中间件产品的授权验证数据,控制中间件产品的授权验证请求。而在授权详情中,展示的授权基本信息、租户信息、原始授权信息、生效授权信息和附加模块信息,支持租户自定义分配和黑白名单限制授权。
# 授权管理列表
进入授权管理页面,可以看到授权管理的列表信息,包括命名空间、产品名称、发行版本、总数、已用、开始时间、结束时间和签发时间,可以进行查看的操作。
命名空间:授权信息所属的命名空间。
产品名称:授权信息所属的产品名称。
发行版本:授权信息所属的产品发行版本。
授权类型:授权信息所属授权类型。授权类型分为两种,一种是CPU授权,支持通过CPU核心数来控制授权。另一种是实例数量来控制授权。
总数:授权信息对应的产品所授予的实例总数。
已用:授权信息的产品已使用的CPU核心数或实例数量。点击此数值,将跳转到对应的在线实例页面。
【注意】对于实例授权,当产品向授权中心发送授权请求,授权通过后,将占用一个授权,对应的已用实例数将递增1。对于CPU授权,授权通过后,将占用产品端对应的CPU核心数,在同一台服务器上启动多个产品,将只占用一次授权的CPU核心数。
开始时间:授权文件的生效的开始时间。
结束时间:授权文件的生效的结束时间。
签发时间:授权文件的签发时间。

# 导入操作
导入用户所购买的中间件产品的授权文件。
进入授权管理页面,点击列表上方的【导入】按钮,弹出导入窗口,在窗口中点击或将文件拖拽的方式,将中间件产品授权文件进行导入,导入成功后,将在授权列表中新增一条授权信息。

【注意】
以下场景下,导入授权文件将失败,可将失败提示信息反馈到金蝶天燕,以便重新制作授权文件。
1)授权文件超过授权结束时间,将视为非法授权文件,提示类似“is not valid”的信息。
2)授权文件的特征码与授权中心的不符时,将视为非法授权文件,提示类似“host …..is not valid”的信息。
3)授权文件信息已存在,提示类似“..repeated…”或“.. existed already…”,可决定是否勾选“若导入的文件已存在,是否覆盖”选项,勾选再点击导入则覆盖原有授权信息。
# 查看授权详情操作
进入授权管理页面,在授权管理列表中,选择某一授权,点击其操作列中的【查看】按钮进入授权详情界面。
# 授权详情
在授权详情页面中,可以查看授权租户信息、基本信息、原始授权信息、生效授权信息和附加模块信息,支持租户自定义分配和黑白名单限制授权。
# 基本信息
基本信息展示授权所属的命名空间、产品名称、发行版本、付费模式、黑名单和白名单。支持为授权文件设置黑白名单。

设置黑白名单:点击编辑按钮即可进行设置,支持输入正则表达式,多文本用;分隔。
【注意】
1) 黑白名单限制授权分为授权文件级别和授权文件下租户级别的设置黑白名单。
2) 租户下的设置级别更高,当都存在设置时,以租户的设置为准。
3) 当设置了白名单必须存在白名单中才能访问。
4) 当在白名单范围中的IP,可以通过黑名单再次限制。
# 租户信息
租户信息展示此授权下的租户列表信息,包括租户名称、授权开始时间、授权结束时间、授权数和已使用数,可以进行新增、编辑和删除租户,设置黑白名单的操作。

- 新增租户
点击"新增",在新增租户窗口中设置租户名称、授权开始、结束时间和授权数量。

- 编辑租户
在租户列表中,点击某一租户操作列中的"编辑",在编辑租户窗口中设置授权开始、结束时间和授权数量。

- 删除租户
在租户列表中,勾选一个或多个租户后,点击列表上方的"删除"。
- 设置租户黑名单
在租户列表中,点击某一租户操作列中的"黑名单",在编辑黑名单窗口中进行设置。支持输入正则表达式,多文本用;分隔。

- 设置租户白名单
在租户列表中,点击某一租户操作列中的"白名单",在编辑白名单窗口中进行设置。支持输入正则表达式,多文本用;分隔。

# 原始授权信息
原始授权信息展示授权数、授权开始时间和授权结束时间。
# 生效授权信息
生效授权信息展示根据原始授权信息,自动计算出各个授权时间段的授权信息,包括授权数、授权开始时间和授权结束时间。

# 附加模块信息
附加模块信息从所属产品的模块出发,定义各个模块的授权信息,包括授权数、授权开始时间和授权结束时间。

# 授权删除
# 业务概述
授权删除展示当前授权中心有效的授权文件信息列表,方便用户查看授权文件信息,支持进行删除操作。
# 授权文件列表
进入授权删除页面,可以看到授权文件的列表信息,包括ID、命名空间、产品信息、签发时间和结束时间,支持通过结束时间进行过滤查询。
ID:授权文件名称。
命名空间:授权文件所属的命名空间。
产品信息:授权文件所属的产品名称。
签发时间:授权文件的签发时间。
结束时间:授权文件生效的结束时间。

# 删除操作
删除用户导入的授权文件。
进入授权删除页面,勾选列表中的某一条或多条授权文件信息,点击列表上方的【删除】按钮,弹出删除提示窗口,在窗口中点击确定或取消,在删除成功后,将会删除授权文件列表中的授权文件信息,同时授权文件信息所对应的授权信息也会从授权管理列表中被删除。

# 命名空间自定义
# 业务概述
在授权管理导入的授权信息中,命名空间名称根据授权信息生成,存在如下问题:
1、命名空间通过编码生成,不利于记忆和使用;
2、命名空间固定,会出现只能导入一个产品和版本的一个授权,没法满足多个授权的场景;
3、临时授权和正式授权的命名空间不一致,增加了应用配置的工作量。
命名空间自定义支持用户创建自定义的命名空间集合,该自定义命名空间可以包含多个子命名空间(子命名空间就是授权文件导入时生成的空间)。在中间件端请求授权时,将命名空间的参数设置为该自定义命名空间名称即可正常使用。 使用自定义命名空间时,授权中心会轮询包含的子命名空间,只要有一个子命名空间符合要求,就通过验证并返回,如果所有子命名空间都不符合要求,则验证失败。自定义命名空间不提供租户的配置,租户的配置需要到各个产品授权中进行设置。
【注意】
1.从老版本授权中心迁移到新版本授权中心时,如果使用了默认的命名空间,则需要创建一个public的自定义命名空间,子空间包含之前有效的授权;如果使用了其他固定的名称作为命名空间,则在该功能创建对应的命名空间,并包含之前有效的授权。
2.新版本授权中心在授权导入时,默认使用授权编码作为命名空间,中间件端也可以直接使用该名称作为命名空间使用。
3.当新增的自定义命名空间与授权文件导入时生成的空间名称一样时,会以自定义命名空间优先,如果要使用该子命名空间,需要把该子命名空间添加到自定义的命名空间里。否则,会影响到中间件端请求此子命名空间的授权。
# 自定义命名空间列表
进入命名空间自定义页面,可以看到自定义命名空间的列表信息,包括自定义命名空间的名称、使用数、包含的子命名空间等,并可以进行命名空间的添加、删除及修改。支持通过自定义命名空间的名称进行过滤查询。
名称:自定义命名空间的名称。
使用数:当前通过自定义命名空间授权的实例数。
子命名空间:自定义命名空间包含的子命名空间,子命名空间是授权文件导入时生成的空间。
修改时间:自定义命名空间最后修改的时间。

# 新增操作
点击列表上方的“新增”按钮,打开新增自定义命名空间界面,输入命名空间名称、在左边的选择框中选择包含的命名空间到右边的选择框,点击“确定”即可进行保存。保存成功后提示添加成功。

# 删除操作
勾选列表中的一个或多个自定义命名空间,点击列表上方的“删除”按钮,在弹出的删除确认提示窗中点击“确定”按钮后则进行删除,点击“取消”按钮取消删除操作。命名空间删除后则不能通过该名称进行使用,可能会影响使用该命名空间的中间件使用。

# 编辑操作
点击列表中某一命名空间的操作列中的“编辑”按钮,可以编辑对应的命名空间,如增加命名空间或去除选择的部分命名空间等,点击“确定”即可进行保存。保存成功后提示编辑成功。

# 删除某一命名空间操作
点击列表中某一命名空间的操作列中的“删除”按钮,进行删除对应的命名空间,在弹出的删除确认提示窗口中点击“确定”按钮后则进行删除,点击“取消”按钮取消删除操作。命名空间删除后则不能通过该名称进行使用,可能会影响使用该命名空间的中间件使用。
# 在线实例
# 业务概述
在线实例展示所有通过授权中心授权的实例和实例信息,方便用户查看在线实例信息。在授权产品认证通过后,将在在线实例列表中展示其实例信息,并在授权时间段内,每隔一定间隔向授权中心发送心跳信息,以刷新产品实例在线状态。
# 在线实例列表
进入在线实例页面,可以看到在线实例的列表信息,包括实例IP、物理地址、实例路径、产品名称、发行版本、命名空间、所属租户、启动时间和更新时间。支持通过实例IP、物理地址、实例路径、产品名称、发行版本、所属租户进行过滤查询。
实例IP:实例所在机器IP地址。
【注意】当IP前面显示Exceeded时,警告表示当前的授权信息在过期后,已被授权中心删除,但是中间件端还一直连着授权中心,如授权中心不引入新的授权信息,这意味着中间件端在下次重启时将因没有授权信息而启动失败。
物理地址:实例所在机器的网卡MAC地址。
实例路径:实例的产品安装路径。
产品名称:实例的产品名称。
发行版本:实例的产品发行版本。
命名空间:实例所属的命名空间。
所属租户:实例所属租户。
授权类型:授权信息所属授权类型。
核心/实例数:实例占用的CPU核心数和实例数。
启动时间:实例启动时间。
更新时间:实例最后一次的心跳时间。

# 使用统计
# 业务概述
使用统计展示产品实例的使用情况,以便后续对产品实例的使用进行审计和统计等。
# 使用统计列表
进入使用统计页面,可以看到实例的使用情况,包括实例IP、物理地址、实例路径、产品名称、发行版本、命名空间、所属租户、更新时间和事件状态。支持通过实例IP、物理地址、实例路径、产品名称、发行版本、所属租户、事件和时间范围进行过滤查询。
实例IP:实例所在机器IP地址。
物理地址:实例所在机器的网卡MAC地址。
实例路径:实例的产品安装路径。
产品名称:实例的产品名称。
发行版本:实例的产品发行版本。
命名空间:实例所属的命名空间。
所属租户:实例所属租户。
授权类型:授权信息所属授权类型。
核心/实例数:实例占用的CPU核心数和实例数。
更新时间:实例事件操作的时间。
事件状态:实例事件操作,包括请求认证、心跳、停止实例、心跳恢复等。

# 导出操作
使用统计页面提供导出实例使用情况的操作。
在使用统计列表上,支持设置产品名称等过滤查询条件进行查询,点击【导出】按钮,将查询出来的结果导出成Excel文件。

# 软件特征码
# 业务概述
软件特征码展示授权中心的软件特征码,以便后续用户将特征码发回到金蝶天燕生成中间件产品的授权文件。可在“软件特征码”窗口中查看并复制到特征码。
# 复制操作
访问菜单【软件特征码】,在“软件特征码”窗口中查看软件特征码,点击蓝色的复制按钮即可复制软件特征码。

# 日志下载
# 业务概述
日志下载是提供授权中心最新日志下载功能,便于管理员进行问题的分析。
# 日志下载操作
登录授权中心后,点击页面右上角的admin用户图标后,再点击菜单【日志下载】,即可将授权中心最新日志文件保存到本地。

# 修改密码
# 业务概述
修改密码是提供修改授权中心的登录密码的功能,以便后续用户修改其登录密码。
# 修改密码操作
登录授权中心后,点击页面右上角的admin用户图标后,再点击菜单【修改密码】,在弹出的"修改密码"窗口中填写当前密码、新密码、确认密码和动态码即可完成修改密码。

# 常见配置修改和说明
# 禁用验证码验证
授权中心在登录时,默认开启验证码验证。当在登录时输入验证码,若存在一些情况下无法显示验证码的,可以通过如下方式禁用验证码验证:
方式1:通过设置系统环境变量ACLS_DISABLEDLOGINCODE为true进行配置禁用。
方式2:通过修改JVM配置参数文件ACLS-1.1/domains/mydomain/config/vm.options文件中的JVM参数com.apusic.acls.disabledLoginCode=true进行禁用。
禁用验证码后,登录时在验证码输入框中输入非空字符即可跳过验证。