PreviewTaskParameters - 预览调度参数-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

根据传入的脚本参数、业务日期和调度配置，预览各周期的参数解析结果，无需提供任务 ID。

本接口仅进行模拟预览，不创建或运行真实任务。周、月调度返回的模拟周期不能作为实际触发日期的判断依据。
Bizdate 是起始业务日期，按服务地域时区归一到当天零点；TriggerTime 是对应模拟周期的定时触发时间。
$nodeid 等系统标识使用模拟上下文，其中 $nodeid 的预览值为 0，不代表真实任务。
每个周期通过 Success 表示解析结果。解析成功时返回 Parameters；解析失败时返回 ErrorMessage，不返回该周期的部分解析结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	是	项目 ID，必须属于当前调用租户。	100
ProjectEnv	string	否	项目环境。 Prod：生产 Dev：开发不传时默认为 Prod。	Prod
Parameters	string	是	脚本参数列表，长度不超过 65535 个字符。多个参数使用空格分隔，例如 para1=$bizdate para2=$[hh24]。允许传入空字符串。	para1=$bizdate para2=$[hh24]
Bizdate	integer	是	业务日期，使用 13 位 Unix 时间戳，单位为毫秒。	1792425600000
Cron	string	是	调度 CRON 表达式。	00 00 00 * * ?
StartTime	string	否	首个调度日的预览起始时间，格式为 HH:mm:ss。不传时默认为 00:00:00。仅对非日调度生效，用于过滤首个调度日内早于该时间的周期。	00:00:00
PreviewCount	integer	否	预览的调度周期数，取值范围为 1～10。不传时默认为 3。	3

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	22C97E95-F023-56B5-8852-B1A77A17XXXX
Items	array<object>	各周期的参数预览结果
	object	参数预览项
Bizdate	integer	该周期的业务日期，使用 13 位 Unix 时间戳，单位为毫秒。	1792425600000
TriggerTime	integer	模拟的定时触发时间，使用 13 位 Unix 时间戳，单位为毫秒。	1792512000000
Parameters	string	该周期解析后的完整脚本参数字符串，多个参数使用空格分隔。Success 为 true 时返回。	para1=20261020 para2=00
Success	boolean	该周期的调度参数是否解析成功。 true：解析成功。 false：解析失败。	true
ErrorMessage	string	该周期解析失败时的错误信息。Success 为 false 时返回，为 true 时不返回。	调度参数解析失败，请检查参数配置

Items 中每个元素对应一个预览周期，按模拟周期顺序返回。字段表中的示例分别说明各字段的取值，实际返回字段取决于该周期的解析结果。

解析成功的周期项示例：

{
  "Bizdate": 1792425600000,
  "TriggerTime": 1792512000000,
  "Parameters": "para1=20261020 para2=00",
  "Success": true
}

解析失败的周期项示例：

{
  "Bizdate": 1792425600000,
  "TriggerTime": 1792512000000,
  "Success": false,
  "ErrorMessage": "调度参数解析失败，请检查参数配置"
}

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Items": [
    {
      "Bizdate": 1792425600000,
      "TriggerTime": 1792512000000,
      "Parameters": "para1=20261020 para2=00",
      "Success": true,
      "ErrorMessage": "调度参数解析失败，请检查参数配置"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。