数据质量管理平台

# SDK接口

SDK全称为Software Development Kit，软件开发工具包，SDK接口，则是这些资源中的API接口，可以让开发者与底层的软件系统进行交互，实现各种自定义的功能。

# 适用范围

本文档适用于集成数据质量平台的三方应用系统（供开发者参考），文档的适用产品版本为：7.2 GA。

# 编写目的

本文档主要介绍sdk的调用方式, 包括检核规则, 检核指标, 检核任务等数据质量相关操作的API, 为使用数据质量平台服务进行后续开发提供便利。

# 适用读者

本文档的适用读者范围主要是在EOS平台使用数据质量平台服务的设计和开发人员。

# 使用SDK

# 引入依赖

  • 在独立部署项目中引入以下依赖
<dependency>
    <groupId>com.primeton.dqms</groupId>
    <artifactId>dqms-starter</artifactId>
    <version>7.2.0</version>
</dependency>
  • 在微应用项目中引入以下依赖
<dependency>
    <groupId>com.primeton.dqms</groupId>
    <artifactId>dqms-sdk</artifactId>
    <version>7.2.0</version>
</dependency>

# 添加配置文件application-dqms.properties

  • 独立应用配置
eos.springmvc.eos-serialize.exclude-packages=com.primeton.dqms

mybatis.type-aliases-package=com.primeton.dqms.entity
mybatis.mapper-locations=classpath*:mapper/**/*Mapper.xml
mybatis.configuration.call-setters-on-nulls=true

mapper.mappers=com.primeton.dqms.core.mapperBase.MyMapper
mapper.not-empty=false
#mapper.identity=NORMAL

pagehelper.page-size-zero=true
# OpenGuass,postgresql,kingbase dialect use postgresql
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true

common.base_dir=${app.home:.}

#logging.level.com.primeton.dqms=debug
hadoop.hdfs_type=local
hadoop.tenent_name=
hadoop.core-site=${common.base_dir}/config/core-site.xml
hadoop.hdfs-site=${common.base_dir}/config/hdfs-site.xml
hadoop.user_keytab=${common.base_dir}/config/user.keytab
hadoop.krb5_file=${common.base_dir}/config/krb5.conf
hadoop.fileDownloadUrl=http://127.0.0.1:50070

cache.type=mem

datashard.type=local
datashard.base_path=${common.base_dir}/upload
datashard.delSrc=true
datashard.fileSuffix=.bcp
datashard.ftp.host=127.0.0.1
datashard.ftp.port=2121
datashard.ftp.userName=admin
datashard.ftp.password=primeton000000
datashard.sftp.host=127.0.0.1
datashard.sftp.port=22
datashard.sftp.userName=root
datashard.sftp.password=primeton

file.dqms.otherErrorDataFilePath=${common.base_dir}/dataCheck/otherErrorData
file.dqms.dataSummaryFilePath=${common.base_dir}/dataCheck/dataSummary
file.dqms.errorDetailFilePath=${common.base_dir}/dataCheck/errorDetail
file.damp.dataTemplateFilePath=${common.base_dir}/resourceTemplate/resourceTemplate.xlsx
file.damp.templateFileLocation=${common.base_dir}/fileTemplate/dataResourceImport.xlsx
file.damp.VerificationTemplatePath=${common.base_dir}/resourceTemplate/VerificationTemplate.xlsx
file.damp.clclassTemplateFilePath=${common.base_dir}/resourceTemplate/classifDataImport.xlsx

# Optional
metacube.address=http://127.0.0.1:10800/dgs

datacheck.conf.corePoolSize=10
datacheck.conf.maxPoolSize=50
datacheck.conf.queueCapacity=300
datacheck.conf.keepAliveSeconds=1000
datacheck.checkResult.warehouseType=apache
datacheck.checkResult.checkFileLocalTempDir=${common.base_dir}/dataCheck
datacheck.checkResult.checkFileUploadRootDir=${common.base_dir}/dataCheck
datacheck.checkResult.isSyncHadoop=true
datacheck.DBkerberos.path=${common.base_dir}/kerberos/

#dqms.datasource.sync.enabled=true
#dqms.datasource.sync.cron=0 */5 * * * ?
dqms.scheduler.route-strategy=FIRST
dqms.scheduler.block-strategy=SERIAL_EXECUTION

afc.system-variable.tenantId=sys_tenant
afc.system-variable.mdm-resGroupId=quality-11
afc.system-variable.afc-resGroupId=quality-12
afc.user.dqms-admin-role=dqms-92

check.result.save-mode=local
#check.result.host=10.15.15.136
#check.result.port=22
#check.result.username=test
#check.result.password=test
check.result.local-temp-dir=${common.base_dir}/dataCheck
check.result.upload-root-dir=${common.base_dir}/dataCheck
#check.result.kerberosPath=/opt/kerberos
#check.result.hdfsConfPath=/opt/hdfsConf

datasource.config.save-mode=local
#datasource.config.host=
#datasource.config.port=
#datasource.config.username=
#datasource.config.password=
#datasource.config.reply=
#datasource.config.kerberosPath=/opt/kerberos
#datasource.config.hdfsConfPath=/opt/hdfsConf

# 0mins 0seconds 1hours 1date *month ?  explain: 1:00 of first day of each month
# eg: 0 0 16 29 * ? -> 16:00 of 29th of each month
rating.statistics.cron=0 0 1 1 * ?
# statistic the grades of each org for present cycle or last cycle, 'true' present last cycle
rating.statistics.last_rating_cycle=true
#DEFAULT_RATING_CYCLE:month , eg: month year week quarter
rating.statistics.cycle=month
# use AFCenter job admin server port
xxl.job.admin.addresses=http://127.0.0.1:28083
xxl.job.admin.token=c0101b6109e8478784ceb8897159fe2b
  • 微应用项目配置：
quality.application.name=localhost:28091
quality.application.afctoken=fb9d872b8a5545d1b38bbe21c8e0175d

# 使用示例

@Component
public class Demo{
    @Autowired
    IQualityClient qualityClient;

    public RuleInfoDTO findById(String ruleId){
        IRuleInfoAPI ruleInfoAPI = qualityClient.getRuleInfoAPI();
        RuleInfoDTO ruleInfo = ruleInfoAPI.findById(ruleId);
        return ruleInfo;
    }
}

# SDK Apis

# 产品相关API: IAboutProductAPI

# 关于产品

  • API:
    Properties about();
  • 参数说明 无参

# 告警配置相关API: IAlarmConfigAPI

# 根据ID获取告警详细信息

  • API:
    AlarmConfigDTO findById(String alarmId);
  • 参数说明:
参数 类型 说明
alarmId String 告警配置主键

# 主菜单查询所有告警配置信息列表

  • API:
    List<AlarmConfigDTO> find(String alarmName, String thresholdType, String alarmLevel,
                                String state, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
alarmName String 告警配置名，将模糊查询
thresholdType String 阈值类型，数字类型或百分比
alarmLevel String 告警等级, 分为 一般,中等,严重
state String 告警配置状态, 分为 新增, 运作, 挂起
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 新增告警配置

  • API:
    void add(AlarmConfigDTO alarmConfigDTO);
  • 参数说明:
参数 类型 说明
alarmConfigDTO AlarmConfigDTO AlarmConfigDTO实体类

# 根据告警配置id删除数据告警配置

  • API:
    void deleteById(Long id);
  • 参数说明:
参数 类型 说明
id Long 告警配置主键

# 根据告警配置id List删除数据

  • API:
    void deleteAll(List<Long> idList);
  • 参数说明:
参数 类型 说明
idList List 告警配置主键集合

# 启用告警配置

  • API:
    void enable(List<Long> idList);
  • 参数说明:
参数 类型 说明
idList List 告警配置主键集合

# 禁用告警配置

  • API:
    void disable(List<Long> idList);
  • 参数说明:
参数 类型 说明
idList List 告警配置主键集合

# 修改告警配置

  • API:
    void modify(AlarmConfigDTO alarmConfigDTO);
  • 参数说明:
参数 类型 说明
alarmConfigDTO AlarmConfigDTO AlarmConfigDTO实体类

# 告警记录相关API: IAlarmRecordAPI

# 条件查询告警记录

  • API:
    List<CkAlarmRecordDTO> find(String alarmName, String startDate, String endDate, String alarmLevel,
        String state, String alarmContent, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
alarmName String 告警名模糊查询
startDate String 时间范围起点, format:YYYY-mm-dd
endDate String 时间范围末点, format:YYYY-mm-dd
alarmLevel String 告警等级
state String 告警配置状态, 分为 新增, 运作, 挂起
alarmContent String 告警记录信息
pageIndex Integer 分页条件
pageSize Integer 分页条件

# 查询告警结果列表

  • API:
    List<CkAlarmRecordDTO> findAll(Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
pageIndex Integer 分页条件
pageSize Integer 分页条件

# 根据id关闭告警提醒

  • API:
    void close(Long id);
  • 参数说明:
参数 类型 说明
id Long 告警记录主键

# 大数据配置相关API: IBigDataConfigAPI

# 查询配置信息

  • API:
    List<DsDataConfigDTO> find(String configName,Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
configName String 大数据配置名
pageIndex pageIndex 分页参数
pageSize pageIndex 分页参数

# 业务字典项相关API: IBizDictEntryAPI

# 根据业务字典项ID查询业务字典项

  • API:
    DictEntryDTO findById(String id);
  • 参数说明:
参数 类型 说明
id String 业务字典项主键

# 根据业务字典类型ID获取业务字典项列表

  • API:
    List<DictEntryDTO> findByTypeId(String dictTypeId);
  • 参数说明:
参数 类型 说明
dictTypeId String 业务字典类型主键

# 业务字典类型相关API: IBizDictTypeAPI

# 根据业务字典类型ID查询业务字典

  • API:
    DictTypeDTO findById(String id);
  • 参数说明:
参数 类型 说明
id String 业务字典类型主键

# 根据业务字典类型编码查询业务字典类型

  • API:
    DictTypeDTO findByCode(String code);
  • 参数说明:
参数 类型 说明
code String 业务字典类型编码

# 日历相关API: ICalendarAPI

# 日历配置新增

  • API:
    void add(CkCalendarDTO ckCalendarDTO);
  • 参数说明:
参数 类型 说明
ckCalendarDTO CkCalendarDTO 日历配置实体类

# 查询所有的日历配置信息列表

  • API:
    List<CkCalendarDTO> findByName(String name, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
name String 日历配置名
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 日历主键查询

  • API:
    CkCalendarDTO findById(String id);
  • 参数说明:
参数 类型 说明
id String 日历配置主键

# 日历配置修改 (主键修改)

  • API:
    void modify(CkCalendarDTO ckCalendarDTO);
  • 参数说明:
参数 类型 说明
ckCalendarDTO CkCalendarDTO 日历配置实体类

# 根据名称批量删除日历信息

  • API:
    void deleteByName(String name);
  • 参数说明:
参数 类型 说明
name String 日历名称

# 根据ID删除日历配置

  • API:
    void deleteById(String id);
  • 参数说明:
参数 类型 说明
id String 日历配置主键

# 通用检核规则相关API: ICommonRuleInfoAPI

# 新增通用检核

  • API:
    void add(CommonRuleInfoDTO commonRuleInfoDTO);
  • 参数说明:
参数 类型 说明
commonRuleInfoDTO CommonRuleInfoDTO 通用检核配置

# 修改-包括明细

  • API:
    void modify(CommonRuleInfoDTO commonRuleInfoDTO);
  • 参数说明:
参数 类型 说明
commonRuleInfoDTO CommonRuleInfoDTO 修改后的通用检核配置

# 根据ids删除通检配置数据

  • API:
    void delete(String type, List<String> idList);
  • 参数说明:
参数 类型 说明
type String 1:有检核结果就不删除 2：都删
idList List 主键 List

# 条件查询数据列表

  • API:
    List<CommonRuleInfoDTO> find(String configName, String configType, String state,
        String schedulerId, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
configName String 通检配置名称
configType String 通检配置类别
state String 通检配置状态
schedulerId String 调度ID
pageIndex Integer 页号
pageSize Integer 每页条数(为0时查询所有数据)

# 根据general_config SID查询数据明细

  • API:
    CommonRuleInfoDTO findById(Long id);
  • 参数说明:
参数 类型 说明
configName String 通检配置主键

# 启用通检规则

  • API:
    void enable(List<String> idList);
  • 参数说明:
参数 类型 说明
idList List 通检配置主键集合

# 停用通检规则

  • API:
    void disable(List<String> idList);
  • 参数说明:
参数 类型 说明
idList List 通检配置主键集合

# 通用检核结果相关API: ICommonRuleResultAPI

# 根据通检结果ID查询数据明细

  • API:
    CommonRuleResultDTO findById(Long id);
  • 参数说明:
参数 类型 说明
id CommonRuleResultDTO 通检结果主键

# 查询最后一次检核时间

  • API:
    String findLastCheckDateTime(Long resourceSid);
  • 参数说明:
参数 类型 说明
resourceSid Long 资源ID

# 查询通用检核结果

  • API:
    List<CommonRuleResultDTO> find(Long configId, String createTime);
  • 参数说明:
参数 类型 说明
configId Long 通检规则ID
createTime String 通检规则更新时间

# 根据SID查询数据明细

  • API:
        CommonRuleResultDTO findDetail(Long id);
  • 参数说明:
参数 类型 说明
id Long 通检规则ID

# 条件查询通检结果

  • API:
        List<CommonRuleResultDTO> findAll(String configName, String configType, String startDate, String endDate,
        Long schedulerId, Long jobLogId, Long resultId, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
configName String 通检配置名
configType String 通检类型
startDate String 检核结果时间区间 起点
endDate String 检核结果时间区间 止点
schedulerId String 任务ID
jobLogId String 日志ID
resultId String 通检结果ID
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 数据源相关API: IDataSourceAPI

# 查询数据列表

  • API:
    List<DsDataSourceDTO> find(String dataSourceName, String dataSourceType, String source,
        Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
dataSourceName String 数据源配置主键
dataSourceType String 数据源配置类型
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 根据ID查询数据源数据明细

  • API:
    DsDataSourceDTO findById(Long id);
  • 参数说明:
参数 类型 说明
id Long 数据源配置主键

# 修改数据源

  • API:
    void modify(DsDataSourceDTO dsDataSourceDTO);
  • 参数说明:
参数 类型 说明
dsDataSourceDTO DsDataSourceDTO 数据源配置

# 根据id删除数据源数据

  • API:
    void deleteById(Long id);
  • 参数说明:
参数 类型 说明
id Long 数据源配置主键

# 新增数据源

  • API:
    void add(DsDataSourceDTO dsDataSourceDTO);
  • 参数说明:
参数 类型 说明
dsDataSourceDTO DsDataSourceDTO 数据源配置

# 频度相关API: IFrequencyAPI

# 查询所有的频度信息列表

  • API:
    List<CkFrequencyDTO> find(String name, String type, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
name String 频度名称
type String 频度类型
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 新增频度

  • API:
    void add(CkFrequencyDTO ckFrequencyDTO);
  • 参数说明:
参数 类型 说明
ckFrequencyDTO CkFrequencyDTO 频度配置

# 根据频度名删除频度信息

  • API:
    void delete(String name);
  • 参数说明:
参数 类型 说明
name String 频度名

# 频度修改

  • API:
    void modify(CkFrequencyDTO ckFrequencyDTO);
  • 参数说明:
参数 类型 说明
ckFrequencyDTO CkFrequencyDTO 频度配置

# Hbase 规则相关API: IHBaseRuleAPI

# 查询规则列表

  • API:
    List<CkRuleInfoDTO> find(String ruleCode, String ruleName, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
ruleCode String 规则编码
ruleName String 规则名
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 主键查询规则详情

  • API:
    CkRuleInfoDTO findById(Long id);
  • 参数说明:
参数 类型 说明
id Long 规则主键

# 保存规则

  • API:
    void add(CkRuleInfoDTO ckRuleInfoDTO);
  • 参数说明:
参数 类型 说明
ckRuleInfoDTO CkRuleInfoDTO 规则配置

# 修改规则

  • API:
    void modify(CkRuleInfoDTO ckRuleInfoDTO);
  • 参数说明:
参数 类型 说明
ckRuleInfoDTO CkRuleInfoDTO 规则配置

# 删除规则

  • API:
    void deleteById(Long id);
  • 参数说明:
参数 类型 说明
id Long 规则配置主键

# 指标相关API: IIndexAPI

# 查询指标列表，并组装为树状结构

  • API:
    List<CkIndexInfoDTO> find(String code, String name, int level);
  • 参数说明:
参数 类型 说明
code String 指标编码
name String 指标名称
level int 指标等级

# 根据ID查看指标

  • API:
    CkIndexInfoDO findById(Long id);
  • 参数说明:
参数 类型 说明
id Long 指标主键

# 主键删除指标

  • API:
    void deleteById(Long id);
  • 参数说明:
参数 类型 说明
id Long 指标主键

# 新建指标

  • API:
    void add(CkIndexInfoDTO ckIndexInfoDTO);
  • 参数说明:
参数 类型 说明
ckIndexInfoDTO CkIndexInfoDTO 指标配置

# 修改指标

  • API:
    void modify(CkIndexInfoDTO ckIndexInfoDTO);
  • 参数说明:
参数 类型 说明
ckIndexInfoDTO CkIndexInfoDTO 指标配置

# 问题相关API: IIssueAPI

# 保存问题

  • API:
    void save(OptionDTO optionDTO);
  • 参数说明:
参数 类型 说明
optionDTO OptionDTO 问题配置

# 关闭问题

  • API:
    void close(Long id);
  • 参数说明:
参数 类型 说明
id Long 问题配置主键

# 条件查询问题

  • API:
    List<OptionDTO> find(String title, String source, String description, String username, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
title String 问题名称
source String 问题来源
description String 问题描述
pageIndex Integer 问题描述
pageSize Integer 问题描述

# 主键查询

  • API:
    OptionDTO findById(String id);
  • 参数说明:
参数 类型 说明
id String 问题配置主键

# 问题反馈意见相关API: IIssueFeedbackAPI

# 保存反馈意见

  • API:
    void add(FeedbackDTO feedbackDTO);
  • 参数说明:
参数 类型 说明
feedbackDTO FeedbackDTO 反馈意见实体

# 查询反馈意见

  • API:
    List<FeedbackDTO> find(Long optionId, String username);
  • 参数说明:
参数 类型 说明
optionId Long 反馈意见实体主键
username String 反馈意见的用户

# 知识库相关API: IKnowledgeBaseAPI

# 查询知识库数据列表

  • API:
    List<CkKnowledgeInfoDTO> findByTitle(String title, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
title String 知识库数据名称
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 根据ID查询知识数据明细

  • API:
    CkKnowledgeInfoDTO findById(Long id);
  • 参数说明:
参数 类型 说明
id Long 知识库主键

# 修改知识库

  • API:
    void modify(CkKnowledgeInfoDTO ckKnowledgeInfoDTO);
  • 参数说明:
参数 类型 说明
ckKnowledgeInfoDTO CkKnowledgeInfoDTO 知识库配置

# 根据id删除数据

  • API:
    void delete(Long id);
  • 参数说明:
参数 类型 说明
id Long 知识库配置主键

# 新增知识库

  • API:
    void add(CkKnowledgeInfoDTO ckKnowledgeInfoDTO);
  • 参数说明:
参数 类型 说明
ckKnowledgeInfoDTO CkKnowledgeInfoDTO 知识库配置

# 检核规则分组相关

# 根据分组 ID 查询下一级分类

  • API:
    List<RuleGroupDTO> findByUpperId(Long sid);
  • 参数说明:
参数 类型 说明
sid Long 分组配置主键ID

# 分页查询下一级分类下的资源信息(可能包括 表检核规则 通检规则)

  • API:
    List<CkGroupData> findDataById (Long sid, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
sid Long 分组配置主键ID
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 检核规则添加至分组

  • API:
    void saveRelation(RuleGroupDTO.GroupRelation groupRelation);
  • 参数说明:
参数 类型 说明
groupRelation RuleGroupDTO.GroupRelation 分组关系配置

# 新增或修改规则分组

  • API:
    void save(RuleGroupDTO ruleGroupDTO);
  • 参数说明:
参数 类型 说明
ruleGroupDTO RuleGroupDTO 分组配置

# 删除分组

  • API:
    void deleteById(String sid);
  • 参数说明:
参数 类型 说明
sid String 分组配置主键

# 表检核规则相关API: IRuleInfoAPI

# 检核规则综合查询根据条件获取检核列表信息

  • API:
    List<RuleInfoDTO> findAll(String resourceName, String name,String dataSourceName,
    String checkType, String state,String resourceType, Long groupSid, 
    Long indexId, String indexCode, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
resourceName String 资源名称
name String 检核规则名称
dataSourceName String 数据源名称
checkType String 检核类型
state String 检核规则状态
resourceType String 资源类型
groupSid Long 分组 ID
indexId Long 指标 ID
indexCode String 指标编码
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 通过SID查询检核规则详细信息

  • API:
    RuleInfoDTO findById(String sid);
  • 参数说明:
参数 类型 说明
sid String 检核规则主键

# 根据检核任务ID 查询校验规则信息

  • API:
    List<RuleInfoDTO> findByTaskId (String taskId, String resourceName, String name, String dataSourceName,
                                   String jobLogId,Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
taskId String 检核任务主键
resourceName String 资源名称
name String 检核规则名称
dataSourceName String 数据源名称
jobLogId String 检核作业日志ID
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 查询所有检核规则信息列表-根据alarmId

  • API:
    List<RuleInfoDTO> findByAlarmId(Long alarmId, Integer page, Integer size);
  • 参数说明:
参数 类型 说明
alarmId String 告警配置主键
page Integer 分页参数
size Integer 分页参数

# 新增传统检核规则

  • API:
    void add(RuleInfoDTO ruleInfoDTO);
  • 参数说明:
参数 类型 说明
ruleInfoDTO RuleInfoDTO 检核规则配置

# 修改传统检核规则

  • API:
    void modify(RuleInfoDTO ruleInfoDTO);
  • 参数说明:
参数 类型 说明
ruleInfoDTO RuleInfoDTO 检核规则配置

# 停用检核规则

  • API:
    void disable(String sid);
  • 参数说明:
参数 类型 说明
sid String 检核规则配置主键

# 启用检核规则

  • API:
    void enable(String sid);
  • 参数说明:
参数 类型 说明
sid String 检核规则配置主键

# 删除配置信息(包括其对应检核结果)

  • API：
    void deleteByIdList(List<String> idList);
  • 参数说明:
参数 类型 说明
idList List 检核规则配置主键集合

# 检核日志相关API: IRuleLogAPI

# 主键查询检核结果日志

  • API：
    RuleLogDTO findById(String sid);
  • 参数说明:
参数 类型 说明
sid String 检核规则日志主键

# 条件查询日志

  • API：
    List<RuleLogDTO> findAll(String taskId, String resourceName, String name, String dataSourceName, String jobLogId,Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
taskId String 检核任务主键
resourceName String 资源名
name String 检核规则名
dataSourceName String 数据源名
jobLogId String 任务日志ID
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 质量监控-检核规则监控-条件查询检核规则信息

  • API：
    List<RuleLogDTO> findLastMonitor( String methodId);
  • 参数说明:
参数 类型 说明
methodId String 检核规则主键

# 检核规则综合查询根据条件获取检核列表信息

  • API：
    List<RuleLogDTO> findMonitorHis(String methodId);
  • 参数说明:
参数 类型 说明
methodId String 检核规则主键

# 检核结果相关

# 检核结果条件查询

  • API：
    List<RuleResultDTO> find(String startTime, String endTime,
                             String resourceName, String configName, String dataSourceName,
                             String checkStatus, String resourceType, String errorRateS,
                             String errorRateE, String methodId, String principal,
                             boolean desc, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
startTime String 检核结果产生时间段 前点
endTime String 检核结果产生时间段 前点
resourceName String 资源名, 此处可视为 表名
configName String 检核配置名
dataSourceName String 数据源名
checkStatus String 检核状态
resourceType String 资源类型
errorRateS String 错误率-起点
errorRateE String 错误率-末点
methodId String 检核规则配置ID
principal String 负责人
desc boolean 是否倒序
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 根据检核结果SID获取检核详情数据预览

  • API：
    List<Map<String, Object>> findByResultId(Long resultId);
  • 参数说明:
参数 类型 说明
resultId String 检核结果主键

# 检核任务相关API：ITaskAPI

# 新增检核任务

  • API：
    void add(CkScheduleConfigDTO ckScheduleConfigDTO);
  • 参数说明:
参数 类型 说明
ckScheduleConfigDTO CkScheduleConfigDTO 检核任务配置

# 根据调度任务ID删除调度数据和删除调度任务数据

  • API：
    void deleteById(String id, String jobid);
  • 参数说明:
参数 类型 说明
id String 检核任务配置ID
id String 检核任务配置对应JobId

# 检核任务修改

  • API：
    void modify(CkScheduleConfigDTO ckScheduleConfigDTO);
  • 参数说明:
参数 类型 说明
ckScheduleConfigDTO CkScheduleConfigDTO 检核任务配置

# 根据ID查询数据明细

  • API：
    CkScheduleConfigDTO findById(Long id);
  • 参数说明:
参数 类型 说明
id Long 检核任务配置ID

# 主菜单查询所有调度信息列表

  • API：
    List<CkScheduleConfigDTO> findAll(String name, String jobHandler, String jobGroup,
                                     String type, String state, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
name String 调度名称
jobHandler String 调度执行器
jobGroup String 执行器类别
type String 调度类型
state String 任务状态
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 立即启动调度任务

  • API：
    void start(String id);
  • 参数说明:
参数 类型 说明
id String 检核任务配置ID

# 批量启用调度任务

  • API：
    void enable(List<String> ids);
  • 参数说明:
参数 类型 说明
ids List 检核任务配置ID集合

# 批量停止调度任务

  • API：
    void disable(List<String> idList);
  • 参数说明:
参数 类型 说明
idList List 检核任务配置ID集合

# 任务日志相关API: ITaskLogAPI

# 主菜单查询调度监控信息列表，这里只显示最近的信息

  • API：
    List<TaskLogDTO> findLatest(String name, String jobStatus, String jobGroup, String startTime,
                                String endTime, String jobHandler, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
name String 调度名称
jobStatus String 任务状态
jobGroup String 调度执行器类别
startTime String 开始时间
endTime String 结束时间
jobHandler String 调度执行器
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 根据 xxl-job-log id查询任务日志

  • API：
    List<TaskLogDTO> findAll(Integer jobId, String name, String jobStatus, String jobGroup, String startTime,
                                  String endTime, String jobHandler, Integer pageIndex, Integer pageSize);
  • 参数说明:
参数 类型 说明
jobId String 调度任务ID
name String 调度名
jobStatus String 任务状态
jobGroup String 调度执行器类别
startTime String 开始时间
endTime String 结束时间
jobHandler String 调度执行器
pageIndex Integer 分页参数
pageSize Integer 分页参数

# 获取日志详情

  • API：
    String findById(int logId, int fromLineNum);
  • 参数说明:
参数 类型 说明
logId int 日志ID
fromLineNum int 从哪行开始

←