查询ScheduledTask

task_id

是

String

任务ID。

取值范围：以“ST”开头长度26的字符串。

默认值：不涉及。

id

String

定时任务ID。

enterprise_project_id

String

定时任务关联的企业项目ID。

name

String

定时任务名称。

agency_name

String

创建定时任务时关联的委托名称。

trigger_time

TriggerTime object

定时任务执行策略。

version_no

String

版本号。

task_type

Object

定时任务关联任务类型（脚本/作业）。

associated_task_id

String

定时任务关联任务ID（脚本ID/作业ID）。

associated_task_name

String

定时任务关联任务名称（脚本名称/作业名称）。

associated_task_name_en

String

关联任务名称（英文）（脚本名称/作业名称）。

associated_task_type

String

定时任务关联任务的属性（公共/自定义）。

runbook_instance_mode

String

定时任务的目标实例模式。

risk_level

String

定时任务的风险等级。

input_param

String

定时任务的执行参数，值为json串。

enable_approve

Boolean

是否开启入库人工审核。

reviewer_notification

MessageNotification object

审核人通知信息。

created_user_name

String

定时任务的创建人昵称。

reviewer_user_name

String

定时任务的审核人昵称。

approve_status

Object

定时任务的审批状态。

approve_comments

String

定时任务的审批意见。

target_instances

String

定时任务的目标节点，值为json串。

enable_message_notification

Boolean

是否启用消息通知。

message_notification

MessageNotification object

消息通知格式。

time_zone

String

参数解释：

时区。

约束限制：

不涉及。

取值范围：

真实存在的时区即可。

默认取值：

Asia/Shanghai（东八区）。

policy

String

参数解释：

定时任务执行策略。

约束限制：

不涉及。

取值范围：

• PERIODIC：周期执行。

• ONCE：单次执行。

• CRON：按CRON表达式执行。

默认取值：

ONCE。

single_scheduled_time

Long

参数解释：

单次执行类定时任务的执行时间。

约束限制：

若定时任务执行策略为单次执行，则该值必填。

取值范围：

毫秒级UTC时间戳。

默认取值：

不涉及。

periodic_scheduled_time

String

参数解释：

周期执行类定时任务的每天执行时间。

约束限制：

若定时任务执行策略为周期执行，则该值必填。

取值范围：

24小时制的时间字符串。如任务在当天下午5点半执行，即17:30:00。

默认取值：

当前时间。

period

String

参数解释：

周期执行类定时任务的具体星期列表。

约束限制：

若定时任务执行策略为周期执行，则该值必填。

取值范围：

星期按英文逗号分隔；如星期日为“1”，星期一为“2”。如任务在每周一、周三、周四、周天执行，即1,2,4,5。

默认取值：*

不涉及。

cron

String

参数解释：

按CRON表达式执行类定时任务的CRON表达式具体值。

约束限制：

若定时任务执行策略为按CRON表达式执行，则该值必填。

取值范围：

有效CRON表达式即可。如任务在每天上午10点15分执行，即0 15 10 ? * *。

默认取值：

不涉及。

scheduled_close_time

Long

参数解释：

定时任务执行截止时间。

约束限制：

当定时任务执行策略为PERIODIC和CRON时，则该值必填，即定时任务规则截止日期的时间戳。

取值范围：

毫秒级UTC时间戳。

默认取值：

不涉及。

policy

String

参数解释：

通知策略。

约束限制：

当启用消息通知时，该值必填，即需要指定对应的通知策略。

取值范围：

• START_EXECUTION：开始执行。

• EXECUTION_FAILED：执行失败。

• EXECUTION_SUCCEEDED：执行成功。

默认取值：

不涉及。

notification_endpoint_type

String

参数解释：

通知对象类型。

约束限制：

不涉及。

取值范围：

• USER：个人。

• ONCALL：排班。

默认取值：

ONCALL。

schedule_scene_id

String

参数解释：

排班场景ID。

约束限制：

• 当通知对象类型为排班时，该值必填，即需要指定对应的排班场景ID。

• 若不存在，请参考创建排班创建场景ID。

取值范围：

同“约束限制”。

默认取值：

不涉及。

schedule_role_id

String

参数解释：

排班角色ID。

约束限制：

• 当通知对象类型为排班时，该值必填，即需要指定对应的排班角色ID。

• 请确保选择的角色ID已在所选排班场景中存在。

取值范围：

同“约束限制”。

默认取值：

不涉及。

recipients

String

参数解释：

通知人ID。

约束限制：

• 当通知对象类型为个人时，需要指定对应的消息通知人ID。

• 请确保选择的通知人ID已在人员管理中存在。

取值范围：

同“约束限制”。

默认取值：

不涉及。

protocol

String

参数解释：

通知渠道。

约束限制：

请确保当前渠道已被订阅，参考人员管理中的用户订阅。

取值范围：

• DEFAULT：默认。

• NONE：不通知。

• SMS：短信。

• EMAIL：邮箱。

• DINGDING：钉钉。

• LARK：飞书。

• CALLNOTIFY：语音。

• WECHAT：企业微信。

默认取值：

DEFAULT，将任选一种您已订阅的通知渠道，若未订阅任何通知渠道，将无法接收通知。

error_code

String

错误码

error_msg

String

错误描述

200

请求成功。

400

服务器未能处理请求。