20、操作手册
Java API(孵化中)
1. 配置类API
JobSettingsAPI 作业配置的API
JobSettings getJobSettings(String jobName) 获取作业设置.
- Parameters: jobName — 作业名称
- Returns: 作业设置对象
void updateJobSettings(JobSettings jobSettings) 更新作业设置.
- Parameters: jobSettings — 作业设置对象
void removeJobSettings(String jobName) 删除作业设置.
- Parameters: jobName — 作业名称
2. 操作类API
2.1 JobOperateAPI 操作作业的API
void trigger(Optional jobName, Optional serverIp) 作业立刻执行.作业在不与上次运行中作业冲突的情况下才会启动, 并在启动后自动清理此标记.
-
Parameters:
-
jobName — 作业名称
-
serverIp — 作业服务器IP地址
void disable(Optional jobName, Optional serverIp) 作业禁用.会重新分片.
-
Parameters:
-
jobName — 作业名称
-
serverIp — 作业服务器IP地址
void enable(Optional jobName, Optional serverIp) 作业启用.
-
Parameters:
-
jobName — 作业名称
-
serverIp — 作业服务器IP地址
void shutdown(Optional jobName, Optional serverIp) 作业关闭.
-
Parameters:
-
jobName — 作业名称
-
serverIp — 作业服务器IP地址
void remove(Optional jobName, Optional serverIp) 作业删除.
-
Parameters:
-
jobName — 作业名称
-
serverIp — 作业服务器IP地址
2.2 ShardingOperateAPI 操作分片的API
void disable(String jobName, String item) 禁用作业分片.
-
Parameters:
-
jobName — 作业名称
-
item — 作业分片项
void enable(String jobName, String item) 启用作业分片.
-
Parameters:
-
jobName — 作业名称
-
item — 作业分片项
3. 统计类API
3.1 JobStatisticsAPI 作业状态展示的API
int getJobsTotalCount() 获取作业总数.
- Returns: 作业总数
JobBriefInfo getJobBriefInfo(String jobName) 获取作业简明信息.
- Parameters: jobName — 作业名称
- Returns: 作业简明信息
Collection getAllJobsBriefInfo() 获取所有作业简明信息.
- Returns: 作业简明信息集合
Collection getJobsBriefInfo(String ip) 获取该IP下所有作业简明信息.
- Parameters: ip — 服务器IP
- Returns: 作业简明信息集合
3.2 ServerStatisticsAPI 作业服务器状态展示的API
int getServersTotalCount() 获取作业服务器总数.
- Returns: 作业服务器总数
Collection getAllServersBriefInfo() 获取所有作业服务器简明信息.
- Returns: 作业服务器简明信息集合
3.3 ShardingStatisticsAPI 作业分片状态展示的API
Collection getShardingInfo(String jobName) 获取作业分片信息集合.
- Parameters: jobName — 作业名称
- Returns: 作业分片信息集合