新建定时运维 - CreateScheduledTask

ticket_infos

否

Array of TicketInfo objects

参数解释：

变更管理相关配置信息，请参考变更管理进行配置。

约束限制：

若当前接口已在“变更管控”中启用了“工单授权”，则该值必填，即给定对应的提权信息。

取值范围：

不涉及。

默认取值：

不涉及。

name

是

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

由中文、字母、数字、中划线、下划线组成，长度在3~100之间。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

约束限制：

若没有，请前往创建企业管理中创建。

取值范围：

请选择存在的企业项目ID。

默认取值：

默认值：0。

agency_name

否

String

参数解释：

委托名称。

约束限制：

若选择的委托权限不足，将无法执行任务，请前往统一身份认证服务创建委托并授权。

取值范围：

请选择存在的委托名称。

默认取值：

ServiceAgencyForCOC，推荐使用。

version_no

是

String

参数解释：

版本号。

约束限制：

不涉及。

取值范围：

可自定义，长度在1~50之间。

默认取值：

默认值：1.0.0。

trigger_time

是

TriggerTime object

参数解释：

定时任务执行时间详情。

约束限制：

不涉及。

取值范围：

请参考TriggerTime的具体取值约束。

默认取值：

请参考TriggerTime的具体取值约束。

task_type

是

String

参数解释：

任务类型。

约束限制：

不涉及。

取值范围：

• SCRIPT：脚本。

• RUNBOOK：作业。

默认取值：

SCRIPT。

associated_task_id

是

String

参数解释：

关联任务ID（脚本ID或作业ID）。

约束限制：

关联任务必须在“脚本管理”或“作业管理”中存在。

取值范围：

不涉及。

默认取值：

不涉及。

associated_task_type

是

String

参数解释：

关联任务的类型。

约束限制：

不涉及。

取值范围：

• CUSTOMIZATION：自定义脚本/作业。

• COMMUNAL：公共脚本/作业。

默认取值：

CUSTOMIZATION。

associated_task_name

是

String

参数解释：

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

约束限制：

与associated_task_id对应。

取值范围：

不涉及。

默认取值：

不涉及。

associated_task_name_en

否

String

参数解释：

关联任务的英文名称。

约束限制：

与associated_task_id对应。

取值范围：

不涉及。

默认取值：

不涉及。

associated_task_enterprise_project_id

否

String

参数解释：

关联任务的企业项目ID。

约束限制：

与associated_task_id对应。

取值范围：

不涉及。

默认取值：

不涉及。

runbook_instance_mode

否

String

参数解释：

目标实例模式。

约束限制：

当关联任务类型为作业时，该值必填，实例资源的关联方式。

取值范围：

• SAME：所有作业步骤关联相同的实例资源。

• DIFF：每个作业步骤下的每个任务独立关联实例资源。

默认取值：

SAME。

risk_level

是

String

参数解释：

定时任务的风险等级。

约束限制：

不涉及。

取值范围：

• HIGH：高风险。

• MEDIUM：中风险。

• LOW：低风险。

默认取值：

HIGH。

input_param

是

Map<String,String>

参数解释：

任务执行参数，即脚本或作业的执行参数。

约束限制：

json字符串，其中最多50个键值对，每个键值对的值长度为0~16777215的字符串，请与脚本或作业的执行参数保持一致。如脚本，需指定对应的执行用户、超时时间、执行入参等。

取值范围：

不涉及。

默认取值：

不涉及。

target_instances

是

Array of ScheduleInstance objects

参数解释：

目标实例信息。

约束限制：

• 若任务关联的为脚本，则该数组仅有一个元素，即指定关联脚本操作的资源实例。

• 若任务关联的为作业，且目标实例为SAME，则该数组仅有一个元素，即指定关联作业操作的资源实例。

• 若任务关联的为作业，且目标实例为DIFF，则该数组的元素数量等同于关联作业的步骤数量，即每个步骤下的每个任务单独指定要操作的资源实例。

取值范围：

不涉及。

默认取值：

不涉及。

enable_approve

是

Boolean

参数解释：

是否开启入库人工审核。

约束限制：

不涉及。

取值范围：

布尔值。

默认取值：

true。

reviewer_notification

否

MessageNotification object

参数解释：

审核人通知信息。

约束限制：

不涉及。

取值范围：

请参考MessageNotification的具体取值约束。

默认取值：

请参考MessageNotification的具体取值约束。

reviewer_user_name

否

String

参数解释：

审核人昵称。

约束限制：

请选择在人员管理中存在的人员信息。

取值范围：

不涉及。

默认取值：

不涉及。

enable_message_notification

是

Boolean

参数解释：

是否启用消息通知。

约束限制：

不涉及。

取值范围：

布尔值。

默认取值：

false。

message_notification

否

MessageNotification object

参数解释：

消息通知信息。

约束限制：

不涉及。

取值范围：

请参考MessageNotification的具体取值约束。

默认取值：

请参考MessageNotification的具体取值约束。

ticket_id

否

String

参数解释：

变更管理相关工单ID。

约束限制：

请选择当前生效的工单。

取值范围：

不涉及。

默认取值：

不涉及。

ticket_type

否

String

参数解释：

工单类型。

约束限制：

不涉及。

取值范围：

• CHANGE：变更单。

• INCIDENT：事件单。

• WARROOM：WARROOM单。

默认取值：

不涉及。

target_id

否

String

参数解释：

工单关联的应用ID。

约束限制：

请选择工单真实关联的应用ID。

取值范围：

不涉及。

默认取值：

不涉及。

scope_id

否

String

参数解释：

区域ID。

约束限制：

请选择工单真实关联的区域ID。

取值范围：

不涉及。

默认取值：

不涉及。

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时间戳。

默认取值：

不涉及。

target_selection

是

String

参数解释：

目标实例选择方式。

约束限制：

不涉及。

取值范围：

• ALL：全部实例。

• MANUAL：手动选择。

• NONE：不指定实例。

默认取值：

MANUAL。

target_resource

否

TargetResource object

参数解释：

目标实例查询条件。

约束限制：

若目标实例选择方式为全部实例，则该值必填。

取值范围：

请参考TargetResource的具体取值约束。

默认取值：

请参考TargetResource的具体取值约束。

target_instances

否

String

参数解释：

实例信息。

约束限制：

当目标实例选择方式为手动选择，则该值必填，即为目标实例资源的详细信息。

取值范围：

长度在0~100000000的json字符串。

默认取值：

不涉及。

order_no

是

Integer

参数解释：

步骤号。

约束限制：

• 当定时任务关联脚本时，该值为1。

• 当定时任务关联作业时，该值即表示作业中的第几个步骤。

取值范围：

不涉及。

默认取值：

不涉及。

batch_strategy

否

String

参数解释：

实例分批策略。

约束限制：

• 当定时任务关联作业时，且当前步骤无需指定资源实例，则该值必须为NONE。

• 当目标实例选择方式为全部实例时，则该值必须为AUTO_BATCH。

• 当资源实例不为空时，则该值只能为AUTO_BATCH或MANUAL_BATCH。

取值范围：

• AUTO_BATCH：自动分批。

• MANUAL_BATCH：手动分批。

• NONE：不分批。

默认取值：

不涉及。

sub_target_instances

否

Array of ScheduleInstance objects

参数解释：

二级资源实例信息。

约束限制：

若定时任务关联的作业中某一步骤下有多个任务，且目标实例模式为DIFF时，该值必填，即表示每个任务单独指定操作的资源实例。

取值范围：

长度为0~100的数组。

默认取值：

不涉及。

type

否

String

参数解释：

资源选择方式（REGION, APPLICATION），即按region或application选择资源实例。

约束限制：

不涉及。

取值范围：

• REGION：按region选择资源实例。

• APPLICATION：按application选择资源实例。

默认取值：

REGION。

id

否

String

参数解释：

region或application对应ID。

约束限制：

与选择的region或application对应即可。

取值范围：

不涉及。

默认取值：

不涉及。

app_name

否

String

参数解释：

应用名称（层级关系用.隔开）。

约束限制：

当资源选择方式为APPLICATION时，该值必填，即所选application的名称。

取值范围：

不涉及。

默认取值：

不涉及。

region_id

否

String

参数解释：

region_id（application所关联的region）。

约束限制：

当资源选择方式为APPLICATION时，该值必填，即所选application所关联region_id。

取值范围：

不涉及。

默认取值：

不涉及。

params

否

Array of ResourceQuery objects

参数解释：

资源实例的动态查询条件。

约束限制：

不涉及。

取值范围：

请参考ResourceQuery的具体取值约束。

默认取值：

请参考ResourceQuery的具体取值约束。

key

是

String

参数解释：

资源属性名。

约束限制：

请选择“应用资源管理”中资源存在的属性，如ep_id（企业项目ID）、agent_state（uniagent状态）等。

取值范围：

不涉及。

默认取值：

不涉及。

value

是

String

参数解释：

资源属性对应的参数值。

约束限制：

参照所选key给定参数值即可。

取值范围：

不涉及。

默认取值：

不涉及。

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，将任选一种您已订阅的通知渠道，若未订阅任何通知渠道，将无法接收通知。

data

String

参数解释：

接口响应数据。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

200

请求成功。

400

请求体有误。