调用该接口，可以获取指定工作流的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:* | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 否 | DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。 该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。 | 10000 |
| Id | long | 是 | 数据开发工作流唯一标识符 | 860438872620**** |
| IncludeScriptContent | boolean | 否 | 查询结果是否包含工作流内部节点的脚本内容（对于内容较多的节点，可能存在较长的网络传输延时）。 | false |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "F2BDD628-8A21-5BD1-B930-1A2D5989XXXX",
"WorkflowDefinition": {
"Id": 0,
"ProjectId": 0,
"Name": "OpenAPI test workflow Demo",
"Owner": "110755000425XXXX",
"CreateTime": 1708481905000,
"ModifyTime": 1708481905000,
"Spec": {
"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": 700006657495
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-02-18 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2025-02-18 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-01-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |