调用该接口，可以获取指定工作流的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dataworks:* |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
integer |
否 |
DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 |
10000 |
| Id |
string |
是 |
数据开发工作流唯一标识符。 重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。 |
860438872620**** |
| IncludeScriptContent |
boolean |
否 |
查询结果是否包含工作流内部节点的脚本内容（对于内容较多的节点，可能存在较长的网络传输延时）。 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求的 ID。用于定位日志，排查问题。 |
F2BDD628-8A21-5BD1-B930-1A2D5989XXXX |
| WorkflowDefinition |
object |
数据开发工作流的详细信息 |
|
| ProjectId |
integer |
数据开发工作流所在工作空间的 ID。 |
307XXX |
| Name |
string |
数据开发工作流名称 |
OpenAPI test workflow Demo |
| Owner |
string |
数据开发工作流的责任人 |
110755000425XXXX |
| CreateTime |
integer |
数据开发工作流的创建时间戳 |
1708481905000 |
| ModifyTime |
integer |
数据开发工作流的最近更新时间戳 |
1708481905000 |
| Spec |
string |
描述这个工作流的 FlowSpec 信息，具体规范详见 FlowSpec 。 |
{ "metadata": { "tenantId": "52425742456XXXX", "projectId": "307XXXX", "uuid": "463497880880954XXXX" }, "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPI_Test_Workflow_Demo", "id": "463497880880954XXXX", "type": "CycleWorkflow", "owner": "110755000425XXXX", "workflows": [ { "script": { "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo", "runtime": { "command": "WORKFLOW" }, "id": "698002781368644XXXX" }, "id": "463497880880954XXXX", "trigger": { "type": "Scheduler", "id": "652567824470354XXXX", "cron": "00 02 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "OpenAPI_Test_Workflow_Demo", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXX@test.XXXX.com", "tenantId": "52425742456XXXX", "project": { "mode": "STANDARD", "projectId": "307303", "projectIdentifier": "lwttest_standard", "projectName": "XXXX", "projectOwnerId": "110755000425XXXX", "simple": false, "tenantId": "52425742456XXXX" }, "projectId": "307XXXX" }, "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "463497880880954XXXX", "artifactType": "NodeOutput", "refTableName": "OpenAPI_Test_Workflow_Demo", "isDefault": true } ] }, "nodes": [], "dependencies": [] } ] } } |
| WorkflowId |
integer |
发布后在调度侧的工作流 ID |
700006657495 |
| Id |
string |
数据开发工作流唯一标识符。 重要 该字段在 SDK8.0.0 版本之前为 Long 类型，SDK8.0.0 版本及之后为 String 类型。该变更不影响 SDK 正常使用，参数仍会按 SDK 中定义的类型返回。只有在跨 8.0.0 版本的 SDK 升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。 |
463497880880954XXXX |
示例
正常返回示例
JSON格式
{
"RequestId": "F2BDD628-8A21-5BD1-B930-1A2D5989XXXX",
"WorkflowDefinition": {
"ProjectId": 0,
"Name": "OpenAPI test workflow Demo",
"Owner": "110755000425XXXX",
"CreateTime": 1708481905000,
"ModifyTime": 1708481905000,
"Spec": "{\n \"metadata\": {\n \"tenantId\": \"52425742456XXXX\",\n \"projectId\": \"307XXXX\",\n \"uuid\": \"463497880880954XXXX\"\n },\n \"kind\": \"CycleWorkflow\",\n \"version\": \"1.1.0\",\n \"spec\": {\n \"name\": \"OpenAPI_Test_Workflow_Demo\",\n \"id\": \"463497880880954XXXX\",\n \"type\": \"CycleWorkflow\",\n \"owner\": \"110755000425XXXX\",\n \"workflows\": [\n {\n \"script\": {\n \"path\": \"XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo\",\n \"runtime\": {\n \"command\": \"WORKFLOW\"\n },\n \"id\": \"698002781368644XXXX\"\n },\n \"id\": \"463497880880954XXXX\",\n \"trigger\": {\n \"type\": \"Scheduler\",\n \"id\": \"652567824470354XXXX\",\n \"cron\": \"00 02 00 * * ?\",\n \"startTime\": \"1970-01-01 00:00:00\",\n \"endTime\": \"9999-01-01 00:00:00\",\n \"timezone\": \"Asia/Shanghai\",\n \"delaySeconds\": 0\n },\n \"strategy\": {\n \"timeout\": 0,\n \"instanceMode\": \"T+1\",\n \"rerunMode\": \"Allowed\",\n \"rerunTimes\": 3,\n \"rerunInterval\": 180000,\n \"failureStrategy\": \"Break\"\n },\n \"name\": \"OpenAPI_Test_Workflow_Demo\",\n \"owner\": \"110755000425XXXX\",\n \"metadata\": {\n \"owner\": \"110755000425XXXX\",\n \"ownerName\": \"XXXX@test.XXXX.com\",\n \"tenantId\": \"52425742456XXXX\",\n \"project\": {\n \"mode\": \"STANDARD\",\n \"projectId\": \"307303\",\n \"projectIdentifier\": \"lwttest_standard\",\n \"projectName\": \"XXXX\",\n \"projectOwnerId\": \"110755000425XXXX\",\n \"simple\": false,\n \"tenantId\": \"52425742456XXXX\"\n },\n \"projectId\": \"307XXXX\"\n },\n \"inputs\": {},\n \"outputs\": {\n \"nodeOutputs\": [\n {\n \"data\": \"463497880880954XXXX\",\n \"artifactType\": \"NodeOutput\",\n \"refTableName\": \"OpenAPI_Test_Workflow_Demo\",\n \"isDefault\": true\n }\n ]\n },\n \"nodes\": [],\n \"dependencies\": []\n }\n ]\n }\n}",
"WorkflowId": 700006657495,
"Id": "463497880880954XXXX"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。