定时调用API
通过在ROMA Connect中创建API定时任务,可以实现定时自动调用API的功能。
前提条件
操作步骤
- 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
- 在左侧的导航栏选择“服务集成 APIC > API策略”,在“API定时任务”页签下单击“创建API定时任务”。
- 在创建API定时任务弹窗中配置任务信息。
表1 定时任务配置 参数
说明
任务名称
填写任务的名称,根据规划自定义。建议您按照一定的命名规则填写任务名称,方便您快速识别和查找。
集成应用
选择任务所属的集成应用,ROMA Connect会使用该集成应用的认证信息调用API。
描述
填写任务的描述信息。
开始启动时间
定时任务的开始执行时间,定时任务在执行时间开始后根据触发条件开始执行。
触发器类型
定时任务的触发方式。
- CRON:使用CRON表达式设置任务的触发时间。
- CALENDAR:按固定周期设置任务的触发时间。
CRON表达式
仅当“触发器类型”选择“CRON”时需配置。
填写任务触发时间的CRON表达式,当时间与表达式相匹配时,系统将自动触发任务执行。
调用周期
仅当“触发器类型”选择“CALENDAR”时需配置。
填写任务的触发周期,可按分钟、小时、天、周、月设置任务的触发时间周期。
失败重试次数
任务执行失败后的重试执行次数,可设置重试0-3次。
API
单击右侧的“选择API”,选择任务要调用的API。
若API所属集成应用与定时任务所属集成应用不同,仅能选择“APP认证”类型的API,且需要配置API授权给定时任务所属的集成应用,才可实现定时调度。
请求参数
添加调用API的请求参数。- Headers:设置API请求的Headers参数。单击“增加请求参数”可增加参数,并分别填写参数名和参数值。
- Parameters:设置API请求参数的Query参数。单击“增加请求参数”可增加参数,并分别填写参数名和参数值。
- Body:仅当API的请求方法为POST、PUT、PATCH时可配置,根据需要选择内容类型并填写对应类型格式的请求内容。
- application/json:JSON格式数据
- application/xml:XML格式数据
- application/text:文本格式数据
- 单击“确定”,完成API定时任务的创建。
- 启动API定时任务。
API定时任务创建后,任务的“运行状态”为“初始化”,此时任务不会执行,需先启动任务。
在API定时任务列表中,单击任务右侧的“启动”,然后在确认弹窗中单击“确定”,启动任务。此时任务的“运行状态”变为“已启动”,并会根据配置的触发方式按计划执行定时任务。