调用该接口,会在新版数据开发中创建一个数据开发节点。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | long | 是 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 | 123456 |
ContainerId | long | 否 | 当你需要将节点创建在一个容器内部时,你需要指定这个参数。该参数为一个容器的唯一标识,这个容器可以是一个 Workflow 或者一个容器节点。 注意 该参数填写后,FlowSpec 中定义的 path 字段将无效 | 23451286945488XXXX |
Scene | string | 是 | 节点创建的场景,决定节点创建在手动节点区域还是数据开发区域。DataworksManualWorkflow 只在填写了 ContainerId 且 Container 为手动工作流时才能使用。 可选值:
| DATAWORKS_PROJECT |
Spec | string | 是 | { "title": "CycleWorkflow Schema", "description": "定义周期性工作流及其节点配置的 JSON Schema", "type": "object", "required": ["version", "kind", "spec"], "properties": { "version": { "type": "string", "const": "1.1.0", "description": "Schema 版本号,当前固定值 1.1.0" }, "kind": { "type": "string", "enum": ["Workflow", "Node"], "description": "资源类型,标识工作流的具体类型" }, "spec": { "type": "object", "description": "工作流核心配置规范", "required": ["nodes"], "properties": { "nodes": { "type": "array", "description": "工作流节点列表", "items": { "type": "object", "required": ["name", "script"], "properties": { "recurrence": { "type": "string", "enum": ["Normal", "Pause", "Skip", "NoneAuto"], "description": "节点执行策略:Normal-正常执行, Pause-暂停执行, Skip-跳过执行, NoneAuto-非自动执行" }, "id": { "type": "string", "description": "节点唯一标识符" }, "timeout": { "type": "integer", "minimum": 0, "description": "执行超时时间(单位:秒)" }, "instanceMode": { "type": "string", "enum": ["T+1", "Immediately"], "description": "实例生成模式:T+1-次日生成, Immediately-立即生成" }, "rerunMode": { "type": "string", "enum": ["Allowed", "Denied", "FailureAllowed"], "description": "重跑策略:Allowed-允许重跑, Denied-禁止重跑, FailureAllowed-失败时允许重跑" }, "rerunTimes": { "type": "integer", "minimum": 0, "description": "最大重跑次数" }, "rerunInterval": { "type": "integer", "minimum": 0, "description": "重跑间隔时间(单位:秒)" }, "datasource": { "type": "object", "description": "数据源配置", "required": ["name", "type"], "properties": { "name": { "type": "string", "description": "数据源名称" }, "type": { "type": "string", "enum": ["odps"], "description": "数据源类型(当前仅支持 odps)" } } }, "script": { "type": "object", "description": "节点执行脚本配置", "required": ["path", "runtime"], "properties": { "language": { "type": "string", "description": "脚本语言类型" }, "path": { "type": "string", "description": "脚本存储路径,末尾与节点名称相同,不需要有后缀" }, "runtime": { "type": "object", "description": "运行时环境配置", "required": ["command"], "properties": { "command": { "type": "string", "enum": ["ODPS_SQL"], "description": "执行命令" }, "cu": { "type": "string", "description": "计算资源单位配置" } } } } }, "trigger": { "type": "object", "description": "节点触发策略配置", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["Scheduler", "Manual", "Streaming", "None"], "description": "触发类型:Scheduler-定时调度, Manual-手动触发, Streaming-流式触发, None-无触发" }, "cron": { "type": "string", "description": "Cron 表达式(仅适用于 Scheduler 类型)" }, "startTime": { "type": "string", "format": "yyyy-MM-dd hh:mm:ss", "description": "调度开始时间" }, "endTime": { "type": "string", "format": "yyyy-MM-dd hh:mm:ss", "description": "调度结束时间" } } }, "runtimeResource": { "type": "object", "description": "运行时资源配置", "required": ["resourceGroup"], "properties": { "resourceGroup": { "type": "string", "description": "资源组名称" } } }, "name": { "type": "string", "description": "节点名称" }, "owner": { "type": "string", "description": "节点负责人" }, "inputs": { "type": "object", "description": "节点输入配置", "properties": { "nodeOutputs": { "type": "array", "description": "输入依赖列表", "items": { "type": "object", "required": ["data"], "properties": { "data": { "type": "string", "description": "输入依赖标识" }, "refTableName": { "type": "string", "description": "关联数据表名称(当 artifactType 为 Table 时必填)" }, "isDefault": { "type": "boolean", "description": "是否默认输入项" } } } } } }, "outputs": { "type": "object", "description": "节点输入配置", "properties": { "nodeOutputs": { "type": "array", "description": "输入依赖列表", "items": { "type": "object", "required": ["data"], "properties": { "data": { "type": "string", "description": "输入依赖标识" }, "refTableName": { "type": "string", "description": "关联数据表名称(当 artifactType 为 Table 时必填)" }, "isDefault": { "type": "boolean", "description": "是否默认输入项" } } } } } } } } } } } } } | { "version":"1.1.0", "kind":"Node", "spec":{ "nodes":[ { "script":{ "path":"mcp/mcp_odps_sql", "runtime":{ "command":"ODPS_SQL" } }, "name":"mcp_odps_sql" } ] } } |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "AFBB799F-8578-51C5-A766-E922EDB8XXXX",
"Id": 0
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-01-13 | API 内部配置变更,不影响调用 | 查看变更详情 |
2025-01-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |