# 查询ScheduledTask - ShowScheduledTask #### 功能介绍 根据ID查询定时运维任务详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ShowScheduledTask)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:schedule:get | Read | schedule \* | - | - | - | | coc:schedule:get | Read | - | g:EnterpriseProjectId | - | - | #### URI GET /v1/schedule/task/{task_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 是 | String | **参数解释：** 定时任务ID。 **约束限制：** 真实存在的任意任务。 **取值范围：** 以"ST"开头长度26的字符串。 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 定时任务ID。 **取值范围：** 以"ST"开头长度26的字符串。 | | enterprise_project_id | String | **参数解释：** 定时任务关联的企业项目ID。 **取值范围：** 在[企业管理](https://support.huaweicloud.com/usermanual-em/eps_13_0001.html#section6)中存在的ID。 | | name | String | **参数解释：** 定时任务名称。 **取值范围：** 由中文、字母、数字、中划线、下划线组成，长度在3\~100之间。 | | agency_name | String | **参数解释：** 定时任务关联的委托名称。 **取值范围：** 在[统一身份认证服务](https://support.huaweicloud.com/usermanual-iam/iam_06_0002.html)中已创建的委托。 | | trigger_time | [TriggerTime] object | **参数解释：** 定时任务执行策略。 **取值范围：** 请参考TriggerTime的具体取值约束。 | | version_no | String | **参数解释：** 版本号。 **取值范围：** 长度在1\~50之间的字符串。 | | task_type | Object | **参数解释：** 定时任务关联任务类型（脚本/作业）。 **取值范围：** - SCRIPT：脚本。 - RUNBOOK：作业。 | | associated_task_id | String | **参数解释：** 定时任务关联任务ID（脚本ID/作业ID）。 **取值范围：** 在"脚本管理"或"作业管理"中存在的任务ID。 | | associated_task_name | String | **参数解释：** 定时任务关联任务名称（脚本名称/作业名称）。 **取值范围：** 在"脚本管理"或"作业管理"中存在的任务名称。 | | associated_task_name_en | String | **参数解释：** 关联任务名称（英文）（脚本名称/作业名称）。 **取值范围：** 在"脚本管理"或"作业管理"中存在的任务英文名称。 | | associated_task_type | String | **参数解释：** 定时任务关联任务的属性（公共/自定义）。 **取值范围：** - CUSTOMIZATION：自定义脚本/作业。 - COMMUNAL：公共脚本/作业。 | | runbook_instance_mode | String | **参数解释：** 定时任务的目标实例模式。 **取值范围：** - SAME：所有作业步骤关联相同的实例资源。 - DIFF：每个作业步骤下的每个任务独立关联实例资源。 | | risk_level | String | **参数解释：** 定时任务的风险等级。 **取值范围：** - HIGH：高风险。 - MEDIUM：中风险。 - LOW：低风险。 | | input_param | String | **参数解释：** 定时任务的执行参数。 **取值范围：** json字符串，其中最多50个键值对，每个值的值长度为0\~16777215的字符串，请与脚本或作业的执行参数保持一致。如脚本，需指定对应的执行用户、超时时间、执行入参等。 | | enable_approve | Boolean | **参数解释：** 定时任务是否开启入库人工审核。 **取值范围：** 布尔值。 | | reviewer_notification | [MessageNotification] object | **参数解释：** 审核人通知信息。 **取值范围：** 请参考MessageNotification的具体取值约束。 | | created_user_name | String | **参数解释：** 定时任务的创建人昵称。 **取值范围：** 不涉及。 | | reviewer_user_name | String | **参数解释：** 定时任务的审核人昵称。 **取值范围：** 不涉及。 | | approve_status | Object | **参数解释：** 定时任务的审批状态。 **取值范围：** - PASSED：正常。 - PENDING：待审批。 - REJECTED：驳回。 | | approve_comments | String | **参数解释：** 定时任务的审批意见。 **取值范围：** 不涉及。 | | target_instances | String | **参数解释：** 定时任务的目标节点，值为json串。 **取值范围：** 不涉及。 | | enable_message_notification | Boolean | **参数解释：** 是否启用消息通知。 **取值范围：** 不涉及。 | | message_notification | [MessageNotification] object | **参数解释：** 定时任务消息通知格式。 **取值范围：** 请参考的MessageNotification的具体取值约束。 | 表3TriggerTime | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 ? \* \*；如希望定时任务在每周一\~周五的10:30执行，即0 30 10 ? \* 2-6，其中末尾数字的取值范围在1\~7，周日为1、周六为7、中间2\~6依次为周一\~周五。 **默认取值：** 不涉及。 | | scheduled_close_time | Long | **参数解释：** 定时任务执行截止时间。 **约束限制：** 当定时任务执行策略为PERIODIC和CRON时，则该值必填，即定时任务规则截止日期的时间戳。 **取值范围：** 毫秒级UTC时间戳。 **默认取值：** 不涉及。 | 表4MessageNotification | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy | String | **参数解释：** 通知策略。 **约束限制：** 当启用消息通知时，该值必填，即需要指定对应的通知策略。 **取值范围：** - START_EXECUTION：开始执行。 - EXECUTION_FAILED：执行失败。 - EXECUTION_SUCCEEDED：执行成功。 **默认取值：** 不涉及。 | | notification_endpoint_type | String | **参数解释：** 通知对象类型。 **约束限制：** 不涉及。 **取值范围：** - USER：个人。 - ONCALL：排班。 **默认取值：** ONCALL。 | | schedule_scene_id | String | **参数解释：** 排班场景ID。 **约束限制：** - 当通知对象类型为排班时，该值必填，即需要指定对应的排班场景ID。 - 若不存在，请参考[创建排班](https://support.huaweicloud.com/usermanual-coc/coc_um_09_02_01_01.html)创建场景ID。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | schedule_role_id | String | **参数解释：** 排班角色ID。 **约束限制：** - 当通知对象类型为排班时，该值必填，即需要指定对应的排班角色ID。 - 请确保选择的角色ID已在所选排班场景中存在。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | recipients | String | **参数解释：** 通知人ID。 **约束限制：** - 当通知对象类型为个人时，需要指定对应的消息通知人ID。 - 请确保选择的通知人ID已在[人员管理](https://support.huaweicloud.com/usermanual-coc/coc_um_09_01_02.html)中存在。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | protocol | String | **参数解释：** 通知渠道。 **约束限制：** 请确保当前渠道已被订阅，参考[人员管理](https://support.huaweicloud.com/usermanual-coc/coc_um_09_01_02.html)中的用户订阅。 **取值范围：** - DEFAULT：默认。 - NONE：不通知。 - SMS：短信。 - EMAIL：邮箱。 - DINGDING：钉钉。 - LARK：飞书。 - CALLNOTIFY：语音。 - WECHAT：企业微信。 **默认取值：** DEFAULT，将任选一种您已订阅的通知渠道，若未订阅任何通知渠道，将无法接收通知。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 服务器未能处理请求。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。