文档

RunCycleDagNodes - 创建补数据工作流

更新时间:

调用RunCycleDagNodes创建补数据工作流。

接口说明

补数据相关内容,详情请参见补数据

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*get
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectEnvstring

工作空间的环境,PROD 表示生产环境,DEV 表示开发环境。

PROD
StartBizDatestring

补数据的起始业务日期。格式为 yyyy-MM-dd 00:00:00。

2020-05-20 00:00:00
Namestring

工作流的名称。

xm_test
RootNodeIdlong

补数据的起始节点 ID。您可以通过调用 ListNodes 接口获取节点 ID。

1234
ExcludeNodeIdsstring

无需补数据的节点 ID 列表,在这个列表中的节点会生成空跑实例,空跑实例被调度后会直接运行成功,不会执行脚本内容。

1234,123465
BizBeginTimestring

任务的开始时间。仅小时调度任务需要设置该参数,格式为 HH:mm:ss,取值范围为 00:00:00~23:59:59。

00:00:00
BizEndTimestring

任务的结束时间。仅小时调度任务需要设置该参数,格式为 HH:mm:ss,取值范围为 00:00:00~23:59:59。

01:00:00
Parallelismboolean

是否可以同时对多个节点进行补数据操作。

false
EndBizDatestring

补数据的结束业务日期。格式为 yyyy-MM-dd 00:00:00。

2020-05-21 00:00:00
NodeParamsstring

配置为一个 JSON 字符串,Key 为节点 ID,Value 为参数的实际取值。

{"74324":"a=123 b=456"}
IncludeNodeIdsstring

补数据的节点 ID。对多个节点补数据时,多个节点 ID 使用逗号(,)分隔。您可以通过调用 ListNodes 接口获取节点 ID。

74324,74325
StartFutureInstanceImmediatelyboolean

是否立刻运行未来调度时间的实例,如果设置为 true,则大于当前时间的实例会立刻运行,否则会等待调度时间

false
ConcurrentRunsinteger

任务并行数。取值范围 2~10。

5
AlertTypestring

告警类型。取值范围:

  • SUCCESS:成功告警。
  • FAILURE:失败告警。
  • SUCCESS_FAILURE:成功或失败皆告警。
FAILURE
AlertNoticeTypestring

告警通知方式。取值范围:

  • SMS:短信。
  • MAIL:邮件。
  • SMS_MAIL:短信与邮件。
SMS

返回参数

名称类型描述示例值
object

返回实体。

HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求的 ID。用于定位日志,排查问题。

>E6F0DBDD-5AD****
ErrorMessagestring

错误信息。

The connection does not exist.
Successboolean

调用是否成功。

true
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Dataarray

周期任务补数据返回的 DagId,可以通过该 DagId 查到对应的实例。

long

工作流 ID 的列表。

111

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": ">E6F0DBDD-5AD****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": [
    111
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史