链接复制成功！
查询ScheduledTask
功能介绍
根据ID查询定时运维任务详情。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/schedule/task/{task_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
任务ID。 取值范围：以“ST”开头长度26的字符串。 默认值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
定时任务执行策略。 取值范围： 默认值：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时间戳。 默认值：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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，将任选一种您已订阅的通知渠道，若未订阅任何通知渠道，将无法接收通知。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
根据ID查询定时运维任务详情。
GET https://{Endpoint}/v1/schedule/task/ST****响应示例
状态码：200
请求成功。
{
"approve_status" : "PASSED",
"associated_task_id" : "SC****",
"associated_task_name" : "script_name",
"associated_task_type" : "CUSTOMIZATION",
"created_user_name" : "****",
"enable_approve" : false,
"enable_message_notification" : false,
"enterprise_project_id" : "0",
"id" : "****",
"input_param" : "{\"success_rate\":\"100\",\"timeout\":\"300\",\"execute_user\":\"root\",\"project_id\":\"****\",\"script_params\":\"[{\\\"paramName\\\":\\\"parm\\\",\\\"paramValue\\\":\\\"****\\\",\\\"paramOrder\\\":1}]\"}",
"name" : "11111",
"risk_level" : "LOW",
"runbook_instance_mode" : "SAME",
"target_instances" : "[{\"id\":\"****\",\"schedule_id\":\"ST****\",\"target_selection\":\"MANUAL\",\"target_instances\":\"{\\\"batches\\\":[{\\\"batchIndex\\\":1,\\\"rotationStrategy\\\":\\\"CONTINUE\\\",\\\"targetInstances\\\":[{\\\"resourceId\\\":\\\"****\\\",\\\"regionId\\\":\\\"cn-north-4\\\",\\\"provider\\\":\\\"HCSS\\\",\\\"type\\\":\\\"L-INSTANCE\\\",\\\"agentSn\\\":\\\"****\\\",\\\"agentStatus\\\":\\\"ONLINE\\\",\\\"nodeId\\\":\\\"\\\",\\\"enterpriseProjectId\\\":\\\"0\\\",\\\"properties\\\":{\\\"hostName\\\":\\\"****\\\",\\\"fixedIp\\\":\\\"\\\",\\\"regionId\\\":\\\"cn-north-4\\\",\\\"projectId\\\":\\\"****\\\"}}]}],\\\"policy\\\":\\\"none\\\",\\\"all_rotation\\\":\\\"ALL_CONTINUE\\\"}\",\"order_no\":0}]",
"task_type" : "SCRIPT",
"trigger_time" : {
"policy" : "ONCE",
"single_scheduled_time" : 1746866130000,
"time_zone" : "Asia/Shanghai"
},
"version_no" : "1.0.0"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
服务器未能处理请求。 |
错误码
请参见错误码。
