手动业务流程必须已在环境界面提交发布,之后运维中心才会显示对应手动业务流程,您才可以使用该接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dataworks:* | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectEnv | string | 是 | 调度运维中心的环境标识。PROD 表示生产环境,DEV 表示开发环境。 | PROD或者DEV |
ProjectName | string | 是 | 手动业务流程所属的工作空间英文名称。 | test_workspace |
FlowName | string | 是 | 手动业务流程的名称。 | test_workflow |
BizDate | string | 否 | 业务日期的值为小于等于当前日期-1 天。例如,今天是 2020 年 11 月 11 日,则业务日期需要是 2020 年 11 月 10 日的 00:00:00 或者该日期之前的日期。业务日期的时分秒信息均填写 00。 StartBizDate 与 EndBizDate 参数配合使用,当前参数与 StartBizDate 和 EndBizDate 参数只能配置一个。 | 2020-11-11 00:00:00 |
NodeParameters | string | 否 | 传递手动业务流程执行时的节点参数信息,一个 JSON 格式: { "<手动业务流程内部的某个节点 ID>": "节点的调度参数信息,和数据开发调度配置里面的参数格式保持一致", "<手动业务流程内部的某个节点 ID>": "节点的调度参数信息,和数据开发调度配置里面的参数格式保持一致" } | {"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"} |
DagParameters | string | 否 | 该参数会同步至本次 Dag 的所有实例中。如果内部节点(支持的节点类型)的调度参数引用了 DagParameters 中的业务流程参数,则节点的对应参数值会被替换为 DagParameter 中的业务流程参数。 | {"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"} |
IncludeNodeIds | string | 否 | 如果需要运行手动业务流程里的部分节点,可输入相应节点 ID。多个节点 ID 使用逗号(,)分隔。 | 74324,74325 |
ExcludeNodeIds | string | 否 | 如果不需要运行业务流程里的部分节点,可输入相应节点 ID。此处输入的节点运行时会生成空跑实例,空跑实例被调度后会直接运行成功,不会执行脚本内容。多个节点 ID 使用逗号(,)分隔。 ExcludeNodeIds 参数需要与 IncludeNodeIds 参数同时使用,ExcludeNodeIds 参数的配置才会生效。 | 123,456 |
ProjectId | long | 否 | 项目 ID | 123 |
StartBizDate | string | 否 | 获取业务开始日期,格式为 yyyy-MM-dd HH:mm:ss。 StartBizDate 与 EndBizDate 参数配合使用,并且当前参数与 BizDate 参数只能配置一个。 | 2020-02-02 00:00:00 |
EndBizDate | string | 否 | 获取业务结束日期,格式为 yyyy-MM-dd HH:mm:ss。 StartBizDate 与 EndBizDate 参数配合使用,并且当前参数与 BizDate 参数只能配置一个。 | 2020-02-03 00:00:00 |
返回参数
示例
正常返回示例
JSON
格式
{
"DagId": 700000123123141,
"RequestId": "AASFDFSDFG-DFSDF-DFSDFD-SDFSDF"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-25 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-04-12 | OpenAPI 入参发生变更 | 查看变更详情 |