-
响应示例 状态码:200 请求成功。 {
"count" : 1,
"next_maker" : "ST****",
"scheduled_tasks" : [ {
"approve_status" : "PASSED",
"associated_task_name" : "test_scheduled_task",
"associated_task_name_en" : "",
"associated_task_type" : "CUSTOMIZATION",
"created_by" : "****",
"created_time" : 1745396111000,
"created_user_name" : "****",
"enabled" : true,
"enterprise_project_id" : "0",
"execution_count" : 1,
"id" : "****",
"last_execution_status" : "FINISHED",
"last_execution_time" : 1745396135000,
"modified_time" : 1745396111000,
"name" : "****",
"region_id" : "cn-north-4",
"risk_level" : "LOW",
"scheduled_type" : "ONCE",
"task_type" : "RUNBOOK",
"update_by" : "****"
} ]
}
-
响应参数 状态码:200 表2 响应Body参数 参数 参数类型 描述 count Long 定时运维任务的总数量。 next_maker String 用于分页查询的下次起始点。 scheduled_tasks Array of ScheduledTaskBasicInfo objects 定时运维任务列表。 表3 ScheduledTaskBasicInfo 参数 参数类型 描述 id String 任务ID。 enterprise_project_id String 企业项目ID。 name String 任务名称。 scheduled_type String 任务执行策略。 task_type String 引用任务类型。 associated_task_type String 任务关联任务的属性(公共/自定义)。 risk_level String 任务风险等级。 created_by String 任务创建人。 update_by String 任务修改人。 created_user_name String 任务创建人昵称。 reviewer String 任务审批人。 reviewer_user_name String 任务审批人昵称。 approve_status Object 任务审批状态。 last_execution_time Long 任务最近执行时间时间戳。 last_execution_status String 任务最近执行状态。 execution_count Integer 任务执行次数。 enabled Boolean 任务是否启用。 created_time Long 任务创建时间。 modified_time Long 任务更新时间。 region_id String 任务所属区域。 associated_task_name String 任务关联的脚本/作业名称。 associated_task_name_en String 任务关联脚本/作业名称(英文)。 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
-
URI GET /v1/schedule/task 表1 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID。 约束:请选择企业管理中存在的项目ID。 默认值:不涉及。 task_id 否 String 任务ID。 取值范围:以“ST”开头长度26的字符串。 默认值:不涉及。 task_name 否 String 任务名称,与task_id对应。 scheduled_type 否 String 定时任务执行策略。 取值范围: PERIODIC:周期执行。 ONCE:单次执行。 CRON:按CRON表达式执行。 默认值:不涉及。 task_type 否 String 定时任务类型。 取值范围: SCRIPT:脚本。 RUNBOOK:作业。 默认值:不涉及。 associated_task_type 否 String 关联任务的类型。 取值范围: CUSTOMIZATION:自定义脚本/作业。 COMMUNAL:公共脚本/作业。 默认值:不涉及。 risk_level 否 String 定时任务的风险等级。 取值范围: HIGH:高风险。 MEDIUM:中风险。 LOW:低风险。 默认值:不涉及。 created_by 否 String 定时任务创建人的
IAM 用户ID。 约束:请选择在人员管理中存在的用户ID。 默认值:不涉及。 reviewer 否 String 定时任务审批人的IAM用户ID。 约束:请选择在人员管理中存在的用户ID。 默认值:不涉及。 reviewer_user_name 否 String 审批人昵称,与reviewer对应。 approve_status 否 String 定时任务的的审批状态。 取值范围: PASSED:正常。 PENDING:待审批。 REJECTED:驳回。 默认值:不涉及。 last_execution_status 否 String 定时任务的最近执行状态。 取值范围: READY:待执行。 PRO
CES SING:执行中。 ABNORMAL:异常。 PAUSED:已暂停。 CANCELED:已取消。 FINISHED:成功。 默认值:不涉及。 last_execution_start_time 否 Long 定时任务最近执行时间的查询开始时间的时间戳。 取值范围:毫秒级UTC时间戳。 默认值:不涉及。 last_execution_end_time 否 Long 定时任务最近执行时间的查询结束时间的时间戳。 取值范围:毫秒级UTC时间戳。 默认值:不涉及。 marker 否 String 用于分页查询。 取值范围:上一次查询的最后一条记录ID。 默认值:不涉及。 region_id 否 String 区域。 约束:请参考
统一身份认证 服务选择存在的区域。 默认值:不涉及。 resource_id 否 String 资源ID,默认为空。 offset 否 Integer 用于分页查询,偏移指针。 默认值:不涉及。 limit 否 Integer 用于分页查询,查询数量。 默认值:不涉及。
-
请求示例 创建一个单次执行的定时任务,关联任务类型为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\":\"E
CS \",\"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 请求成功。 {
"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\\\":\\\"H
CSS \\\",\\\"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"
}
-
请求示例 修改定时任务的风险等级为低风险、执行策略为单次执行、关联任务类型为Script、人工审核和消息通知均不开启。 PUT https://{Endpoint}/v1/schedule/task/ST****
{
"name" : "scheduled_task_name",
"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" : "script_name",
"input_param" : {
"success_rate" : "100",
"timeout" : "300",
"execute_user" : "root",
"project_id" : "****",
"script_params" : "[{\"paramName\":\"parm\",\"paramValue\":\"****\",\"paramOrder\":1}]"
},
"target_instances" : [ {
"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,
"batch_strategy" : "NONE"
} ],
"runbook_instance_mode" : "SAME",
"trigger_time" : {
"time_zone" : "Asia/Shanghai",
"policy" : "ONCE",
"single_scheduled_time" : 1746866130000
},
"risk_level" : "LOW",
"enable_approve" : false,
"enable_message_notification" : false
}
-
响应参数 状态码:200 表9 响应Body参数 参数 参数类型 描述 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 消息通知格式。 表10 TriggerTime 参数 参数类型 描述 time_zone String 时区。 取值范围:时区字符串。 默认值:Asia/Shanghai(东八区)。 policy String 定时任务执行策略。 取值范围: PERIODIC:周期执行。 ONCE:单次执行。 CRON:按CRON表达式执行。 默认值: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时间戳。 默认值:不涉及。 表11 MessageNotification 参数 参数类型 描述 policy String 当启用消息通知时,需要指定对应的通知策略。 取值范围: START_EXECUTION:开始执行。 EXECUTION_FAILED:执行失败。 EXECUTION_SUCCEEDED:执行成功。 默认值:不涉及。 notification_endpoint_type String 通知对象类型。 取值范围: USER:个人。 ONCALL:排班。 默认值:ONCALL。 schedule_scene_id String 当通知对象类型为排班时,需要指定对应的排班场景ID。 约束:若不存在,请参考创建排班创建场景ID。 默认值:不涉及。 schedule_role_id String 当通知对象类型为排班时,需要指定对应的排班角色ID。 约束:请确保选择的角色ID已在所选排班场景中存在。 默认值:不涉及。 recipients String 当通知对象类型为个人时,需要指定对应的消息通知人ID。 约束:请确保选择的通知人ID已在人员管理中存在。 默认值:不涉及。 protocol String 通知渠道,请确保当前渠道已被订阅,参考人员管理中的用户订阅。 取值范围: DEFAULT:默认。 NONE:不通知。
SMS :短信。 EMAIL:邮箱。 DINGDING:钉钉。 LARK:飞书。 CALLNOTIFY:语音。 WECHAT:企业微信。 默认值:DEFAULT,将任选一种您已订阅的通知渠道,若未订阅任何通知渠道,将无法接收通知。 状态码:400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
-
事件状态 事件单涉及的状态如表4所示。 表4 事件状态 status KEY 中文名称 incident_draft 草稿 INCIDENT_STATUS_TRIGGERED 未受理 INCIDENT_STATUS_ACKNOWLEDGED 已受理 INCIDENT_STATUS_REJECTED 被驳回 INCIDENT_STATUS_RESOLVED 已解决待验证 INCIDENT_STATUS_COMPLETED 已完成
-
事件类别 事件单涉及的类别如表2所示。 表2 事件类别 KEY 中文名称 inc_type_p_security_issues 安全问题 inc_type_p_function_issues 功能问题 inc_type_p_reliability_issues 性能/可靠性问题 inc_type_p_config_issues 配置问题 inc_type_p_middleware_issues 中间件问题 inc_type_p_hardware_issues 硬件问题 inc_type_p_networking_issues 网络问题 inc_type_p_shelter_issues 机房问题 inc_type_p_monitoring_issues 监控问题 inc_type_p_consulting_issues 业务咨询类 inc_type_p_suppliers_issues 供应商问题 inc_type_p_ohter_issues 其他 inc_type_p_change_issues 变更操作问题
-
响应示例 状态码: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 表2 响应Body参数 参数 参数类型 描述 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 消息通知格式。 表3 TriggerTime 参数 参数类型 描述 time_zone String 时区。 取值范围:时区字符串。 默认值:Asia/Shanghai(东八区)。 policy String 定时任务执行策略。 取值范围: PERIODIC:周期执行。 ONCE:单次执行。 CRON:按CRON表达式执行。 默认值: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时间戳。 默认值:不涉及。 表4 MessageNotification 参数 参数类型 描述 policy String 当启用消息通知时,需要指定对应的通知策略。 取值范围: START_EXECUTION:开始执行。 EXECUTION_FAILED:执行失败。 EXECUTION_SUCCEEDED:执行成功。 默认值:不涉及。 notification_endpoint_type String 通知对象类型。 取值范围: USER:个人。 ONCALL:排班。 默认值:ONCALL。 schedule_scene_id String 当通知对象类型为排班时,需要指定对应的排班场景ID。 约束:若不存在,请参考创建排班创建场景ID。 默认值:不涉及。 schedule_role_id String 当通知对象类型为排班时,需要指定对应的排班角色ID。 约束:请确保选择的角色ID已在所选排班场景中存在。 默认值:不涉及。 recipients String 当通知对象类型为个人时,需要指定对应的消息通知人ID。 约束:请确保选择的通知人ID已在人员管理中存在。 默认值:不涉及。 protocol String 通知渠道,请确保当前渠道已被订阅,参考人员管理中的用户订阅。 取值范围: DEFAULT:默认。 NONE:不通知。 SMS:短信。 EMAIL:邮箱。 DINGDING:钉钉。 LARK:飞书。 CALLNOTIFY:语音。 WECHAT:企业微信。 默认值:DEFAULT,将任选一种您已订阅的通知渠道,若未订阅任何通知渠道,将无法接收通知。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
-
请求示例 免审批变更单创建,携带Action字段。 POST https://{Endpoint}/v1/external/change/create
{
"title": "coc:change:CodeArtsServiceUpgrade10007",
"change_notes": "coc:change:CodeArtsServiceUpgrade10005",
"change_scene_id": "GOCMLL01001",
"change_type": "change_type_conventional",
"level": "change_level_030",
"actions": "coc:change:CodeArtsServiceUpgrade",
"current_cloud_service_id": "6577d822b90cb779d5765318",
"change_scopes": [
{
"region": "***",
"resource_biz_id": "66bd7b468a80993d5650b77a",
"app_name": "cdr0031"
}
],
"change_plans": [
{
"executors": "bae47db0f86c48318ea65f10bd8aa417",
"expected_start_time": 1745305517577,
"expected_end_time": 1745308803281"target_value": "***"
}
]
}
-
响应参数 状态码:200 表4 响应Body参数列表 名称 类型 是否必选 描述 provider_code String 否 服务标识。 缺省值:049 最小长度:0 最大长度:256 error_code String 否 请求响应代码,范围:0000~9999,正常时取值:0。 缺省值:0 最小长度:0 最大长度:256 error_msg String 否 请求响应描述。 最小长度:0 最大长度:256
-
请求参数 表1 请求body参数 名称 类型 是否必选 描述 title String 是 变更标题。 最小长度:1 最大长度:255 默认取值:不涉及 change_notes String 是 变更描述。 最小长度:1 最大长度:1000 默认取值:不涉及 change_type String 是 变更类型。 最小长度:1 最大长度:255 取值: change_type_conventional:常规变更 change_type_urgentu:紧急变更 默认取值:不涉及 level String 是 变更级别。 最小长度:1 最大长度:255 取值: change_level_010 A change_level_020 B change_level_030 C change_level_040 D 默认取值:不涉及 change_scheme String 否 变更模式。 最小长度:1 最大长度: 255 取值: change_scheme_runbook:作业 change_scheme_guides:变更指导书 默认取值:不涉及 change_guides String 否 变更指导书ID。 最小长度:0 最大长度: 255 默认取值:不涉及 change_scene_id String 是 变更场景。 最小长度:1 最大长度:255 取值:取配置页面【流程管理】下“变更场景”TAB页中列表属性ID列的值,示例:GOCMLL06 默认取值:不涉及 current_cloud_service_id String 是 归属应用。 最小长度:1 最大长度:255 默认取值:不涉及 location_id String 否 变更区域。 最小长度:1 最大长度:255 默认取值:不涉及 actions String 否 Action。 最小长度:0 最大长度:255 取值:取页面【变更管控】列表中的Action ID,用于对特殊Action有特殊逻辑场景。 默认取值:不涉及 is_start_process Boolean 否 是否启动流程。 枚举值: true false 默认取值:false change_scopes Arrays of ChangeScopeInfo 是 变更范围。 数组长度:1 - 100 默认取值:不涉及 change_plans Arrays of ChangePlansInfo 是 变更计划。 数组长度:1 - 100 默认取值:不涉及 表2 ChangeScopeInfo属性 名称 类型 是否必选 描述 app_name String 是 变更应用。 最小长度:1 最大长度:255 默认取值:不涉及 target_type String 否 子单类型,固定值:change_scope 默认取值:不涉及 region String 是 变更区域。 最小长度:1 最大长度:255 默认取值:不涉及 resource_biz_id String 是 应用ID。 最小长度:1 最大长度:255 默认取值:不涉及 表3 ChangePlansInfo属性: 名称 类型 是否必选 描述 target_type String 否 子单类型,固定值:child_ticket。 最小长度:0 最大长度:255 默认取值:不涉及 target_value String 是 变更区域。 最小长度:1 最大长度:255 默认取值:不涉及 expected_start_time Long 是 计划开始时间,时间戳。 最小值:0 最大值:999999999 默认取值:不涉及 expected_end_time Long 是 计划结束时间,时间戳。 最小值:0 最大值:999999999 默认取值:不涉及 executors String 是 实施人。 最小长度:1 最大长度:255 默认取值:不涉及 cooperators String 是 配合人。 最小长度:1 最大长度:255 默认取值:不涉及
-
响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 data JobScriptBatchDetailModel object 展示批次详情返回体。 表5 JobScriptBatchDetailModel 参数 参数类型 描述 batch_index Integer 批次索引,从1开始。 total_instances Integer 批次内执行实例数量。 execute_instances Array of ExectionInstanceModel objects 执行实例列表,分页。 表6 ExectionInstanceModel 参数 参数类型 描述 id Long 主键id。 target_instance ResourceInstance object 目标实例。 gmt_created Long 创建时间。 gmt_finished Long 完成时间。 execute_costs Long 耗时时间,单位:秒。 status String 实例执行状态。 READY:准备。 PROCESSING:处理。 ABNORMAL:异常。 CANCELED:取消。 FINISHED:完成。 ROLLBACKED:回滚。 message String 实例执行日志。 表7 ResourceInstance 参数 参数类型 描述 resource_id String 实例唯一id。 provider String 资源提供者:ECS。单个脚本工单, 每个实例的provider是一致的。 region_id String 机器所属region的ID。 type String 资源提供者下资源类型,不传默认为CLOUDSERVER。 CLOUDSERVER:CLOUDSERVER类型。 custom_attributes Array of Customttribute objects 支持用户自定义5个key_value形式的属性。 约束条件: key值长度为10 。 value长度为20 。 map长度最大为5。 agent_sn String agent纳管id。该参数即将废弃,请勿使用。 agent_status String agent纳管状态。该参数即将废弃,请勿使用。 properties ResourceInstanceProp object 主机附加属性。该参数即将废弃,请勿使用。 表8 Customttribute 参数 参数类型 描述 key String 自定义属性key。 value String 自定义属性的value。 表9 ResourceInstanceProp 参数 参数类型 描述 host_name String 主机名。 fixed_ip String 内网ip。 floating_ip String 弹性公网ip。 region_id String 区域。 zone_id String 可用区。 application String CMDB应用,CMDB应用视图才有值。类似管理面的云服务。 group String CMDB分组,CMDB应用视图才有值。类似管理面的schema。 project_id String 实例的project_id。