新建定时运维
功能介绍
新建定时运维任务，按确定时间或周期定时触发脚本执行、作业管理等操作。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/schedule/task
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ticket_infos |
否 |
Array of TicketInfo objects |
选择的四号提权单信息。 |
|
name |
是 |
String |
任务名称。 取值范围：由中文、字母、数字、中划线、下划线组成，长度在3~100之间。 默认值：不涉及。 |
|
enterprise_project_id |
否 |
String |
企业项目ID。 约束：若没有，请前往创建企业管理中创建。 默认值：0。 |
|
agency_name |
否 |
String |
委托名称。 约束：
默认值：ServiceAgencyForCOC，推荐使用。 |
|
version_no |
是 |
String |
版本号。 取值范围：可自定义，长度在1~50之间。 默认值：1.0.0。 |
|
trigger_time |
是 |
TriggerTime object |
定时任务执行策略。 |
|
task_type |
是 |
String |
任务类型。 取值范围： 默认值：SCRIPT。 |
|
associated_task_id |
是 |
String |
关联任务ID（脚本ID或作业ID）。 约束：关联任务必须在“脚本管理”或“作业管理”中存在。 默认值：不涉及。 |
|
associated_task_type |
是 |
String |
关联任务的类型。 取值范围： 默认值：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。 |
|
risk_level |
是 |
String |
定时任务的风险等级。 取值范围： 默认值：HIGH。 |
|
input_param |
是 |
Map<String,String> |
执行参数，如脚本对应的执行用户、超时时间、执行入参等。 取值范围：长度为0~2147483647的json字符串。 默认值：不涉及。 |
|
target_instances |
是 |
Array of ScheduleInstance objects |
目标实例信息。 |
|
enable_approve |
是 |
Boolean |
是否开启入库人工审核。 取值范围：布尔值。 默认值：true。 |
|
reviewer_notification |
否 |
MessageNotification object |
审核人通知信息。 |
|
reviewer_user_name |
否 |
String |
审核人昵称。 约束：请选择在人员管理中存在的人员信息。 默认值：不涉及。 |
|
enable_message_notification |
是 |
Boolean |
是否启用消息通知。 取值范围：布尔值。 默认值：false。 |
|
message_notification |
否 |
MessageNotification object |
消息通知信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ticket_id |
否 |
String |
四号单ID。 |
|
ticket_type |
否 |
String |
四号单类型，可选CHANGE/INCIDENT/ALARM/WARROOM。 |
|
target_id |
否 |
String |
四号单关联的应用ID。 |
|
scope_id |
否 |
String |
区域ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
time_zone |
是 |
String |
时区。 取值范围：时区字符串。 默认值：Asia/Shanghai（东八区）。 |
|
policy |
是 |
String |
定时任务执行策略。 取值范围： 默认值：ONCE。 |
|
single_scheduled_time |
否 |
Long |
定时任务执行策略为ONCE时，任务单次执行的时间戳。 取值范围：毫秒级UTC时间戳。 默认值：不涉及。 |
|
periodic_scheduled_time |
否 |
String |
定时任务执行策略为PERIODIC时，任务执行的当天时间。 取值范围：24小时制的时间字符串，如任务在当天下午5点半执行，即17:30:00。 默认值：不涉及。 |
|
period |
否 |
String |
定时任务执行策略为PERIODIC时，任务执行的具体星期列表，按英文逗号分隔；如星期日为“1”，星期一为“2”。 示例：任务在每周一、周三、周四、周天执行，即1,2,4,5。 默认值：不涉及。 |
|
cron |
否 |
String |
定时任务执行策略为CRON时，任务执行时间对应的CRON表达式。 示例：任务在每天上午10点15分执行，即0 15 10 ? * *。 默认值：不涉及。 |
|
scheduled_close_time |
否 |
Long |
定时任务执行策略为PERIODIC和CRON时，定时任务规则截止日期的时间戳。 取值范围：毫秒级UTC时间戳。 默认值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
target_selection |
是 |
String |
目标实例选择方式。 取值范围： |
|
target_resource |
否 |
TargetResource object |
实例查询条件，默认为空。 |
|
target_instances |
否 |
String |
实例信息。当目标实例选择方式不为NONE，该字段即为目标实例资源信息。 取值范围：长度在0~100000000的json字符串。 默认值：不涉及。 |
|
order_no |
是 |
Integer |
步骤号。当定时任务关联的作业含有多个步骤，且目标实例选择方式为NONE，就会对应多个步骤号。 取值范围：和定时任务关联作业的步骤数一致。 默认值：0。 |
|
batch_strategy |
否 |
String |
实例分批策略。 取值范围： 默认值：NONE。 |
|
sub_target_instances |
否 |
Array of ScheduleInstance objects |
当目标实例选择方式为NONE时，该字段即为各步骤关联的实例资源信息。 取值范围：长度为0~100000的json字符串。 默认值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
资源选择方式（REGION, APPLICATION）。 |
|
id |
否 |
String |
资源ID。 |
|
app_name |
否 |
String |
应用名称（层级关系用.隔开）。 |
|
region_id |
否 |
String |
region（应用关联region）。 |
|
params |
否 |
Array of ResourceQuery objects |
动态查询条件 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policy |
否 |
String |
当启用消息通知时，需要指定对应的通知策略。 取值范围： 默认值：不涉及。 |
|
notification_endpoint_type |
是 |
String |
通知对象类型。 取值范围： 默认值：ONCALL。 |
|
schedule_scene_id |
否 |
String |
当通知对象类型为排班时，需要指定对应的排班场景ID。 约束：若不存在，请参考创建排班创建场景ID。 默认值：不涉及。 |
|
schedule_role_id |
否 |
String |
当通知对象类型为排班时，需要指定对应的排班角色ID。 约束：请确保选择的角色ID已在所选排班场景中存在。 默认值：不涉及。 |
|
recipients |
否 |
String |
当通知对象类型为个人时，需要指定对应的消息通知人ID。 约束：请确保选择的通知人ID已在人员管理中存在。 默认值：不涉及。 |
|
protocol |
否 |
String |
通知渠道，请确保当前渠道已被订阅，参考人员管理中的用户订阅。 取值范围： 默认值：DEFAULT，将任选一种您已订阅的通知渠道，若未订阅任何通知渠道，将无法接收通知。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
String |
响应数据 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
创建一个单次执行的定时任务，关联任务类型为Script，同时启用消息通知和入库审核。
POST https://{Endpoint}/v1/schedule/task
{
"name" : "test",
"version_no" : "1.0.0",
"enterprise_project_id" : "0",
"task_type" : "SCRIPT",
"associated_task_type" : "CUSTOMIZATION",
"associated_task_id" : "SC****",
"associated_task_enterprise_project_id" : "0",
"associated_task_name" : "test-scripts",
"input_param" : {
"timeout" : 300,
"execute_user" : "root",
"success_rate" : 100,
"project_id" : "****",
"script_params" : "[]"
},
"target_instances" : [ {
"target_selection" : "MANUAL",
"target_instances" : "{\"batches\":[{\"batchIndex\":1,\"rotationStrategy\":\"CONTINUE\",\"targetInstances\":[{\"resourceId\":\"****\",\"regionId\":\"cn-north-4\",\"provider\":\"ECS\",\"type\":\"CLOUDSERVERS\",\"agentSn\":\"****\",\"agentStatus\":\"ONLINE\",\"nodeId\":\"\",\"enterpriseProjectId\":\"0\",\"properties\":{\"hostName\":\"****\",\"fixedIp\":\"****\",\"floatingIp\":\"****\",\"regionId\":\"cn-north-4\",\"zoneId\":\"cn-north-4b\",\"projectId\":\"****\"}}]}],\"policy\":\"none\",\"all_rotation\":\"ALL_CONTINUE\"}",
"order_no" : 0,
"batch_strategy" : "NONE"
} ],
"runbook_instance_mode" : "SAME",
"agency_name" : "ServiceAgencyForCOC",
"trigger_time" : {
"time_zone" : "Asia/Shanghai",
"policy" : "ONCE",
"single_scheduled_time" : 1746072075000
},
"risk_level" : "LOW",
"enable_approve" : true,
"reviewer_user_name" : "****",
"reviewer_notification" : {
"notification_endpoint_type" : "USER",
"protocol" : "DEFAULT",
"recipients" : "****"
},
"enable_message_notification" : true,
"message_notification" : {
"policy" : "EXECUTION_FAILED,START_EXECUTION",
"notification_endpoint_type" : "USER",
"protocol" : "DEFAULT",
"recipients" : "****"
}
}响应示例
状态码：200
请求成功。
{
"data" : "ST****"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
服务器未能处理请求。 |
错误码
请参见错误码。
