获取任务基本信息

获取指定任务的详细信息。

请求地址：/openapi/v1/workflow/detail

请求方法：GET

请求参数

参数	类型	是否必选	说明	示例
workflowId	String	是	任务 ID。	"ex-dd6xemv3mnca"

返回参数

参数	类型	说明	示例
success	Boolean	请求是否成功。	true
requestId	String	请求 ID。	"Ih9n1PMZ-cihckWKncjgs9DUdeff7LMM"
data	Object	任务详情。	无
name	String	任务名称。	"test task"
createTime	String	任务创建时间。	"2025-10-22 07:15:50Z"
module	String	任务类型： sqlTask：SQL 任务 dataExport：数据导出任务	sqlTask
submitterId	String	任务提交人 ID。	"1030799091781335"
status	String	任务状态： notStarted：待启动 preChecking：预检查中 preCheckSkip：跳过预检查 preCheckSuccess：预检查通过 preCheckFailed：预检查失败 ruleChecking：规则检查中 ruleCheckSuccess：规则检查通过 ruleCheckFailed：规则检查失败 toApprove：待审批 approved：审批成功 approveRejected：审批被拒绝 running：执行中 waiting：等待调度 scheduling：调度中 suspended：已暂停 stopped：已终止 success：成功 failed：失败 finished：终止 canceled：撤回 executeCanceled：撤销执行 skipped：跳过	notStarted
statusDesc	String	任务状态描述。	"待启动"
executeTime	String	任务执行时间。	"2025-10-22 07:16:10Z"
datasourceId	String	任务关联数据源 ID。	"ds-ddduea45j638"
dbName	String	任务关联数据库名称。	"ght"
dbGroupId	String	任务关联库分组 ID。	"group1"
schemaName	String	任务关联 Schema 名称。	"public"
bizData	Object	任务详情。根据 module 参数返回不同的内容。具体请参见本文的 bizData 返回参数（SQL 任务）或 bizData 返回参数（数据导出）	无
errorCode	String	错误码。	无
message	String	异常信息。	无

bizData 返回参数（SQL 任务）

参数	类型	说明	示例
sqlText	String	SQL文本，上传的是 SQL 文件的情况下，该字段为文件 ID。	"ds-dbiddumxp4h"
sqlInputType	String	SQL 类型： text：SQL 文本。 file：SQL 文件。	"text"
executorType	String	执行人类型： creator：提交人执行。 approver：审批人执行。 auto：自动执行。 <执行人名称>：直接显示具体执行人的名称。	"ght"
estimatedAffectedRows	Integer	预估影响行数。	1
rollbackText	String	回滚文本。	"insert into date_time_test1 (datetime_col) values (now());"
rollbackTextType	String	回滚文本类型： text：SQL 文本。 file：SQL 文件。	"text"

bizData 返回参数（数据导出）

参数	类型	说明	示例
reason	String	导出原因。	"test"
charset	String	导出文件字符集。	"utf8"
executorType	String	执行人类型： creator：提交人执行。 approver：审批人执行。 auto：自动执行。 <执行人名称>：直接显示具体执行人的名称。	"creator"
sqlStatement	String	具体的导出 SQL 语句，导出类型为 sql 时返回。	"db.all_type.find()"
sqlExtOption	Array	导出额外选项。 compress：将多个 INSERT 语句压缩成一个较大的 INSERT 语句，可显著提高插入数据的效率。	"compress"
type	String	导出类型： sql：导出为 SQL 语句。 database：导出库。 table：导出表。	"sql"
contentType	String	导出内容： data：仅数据。 structure：仅结构。 dataAndStructure：数据和结构。	"data"
fileType	String	导出文件类型： sql：导出为 SQL 文件。 excel：导出为 Excel 文件。 csv：导出为 CSV 文件。	"sql"

调用成功示例

SQL 任务

{
    "success": true,
    "requestId": "Ih9n1PMZ-cihckWKncjgs9DUdeff7LMM",
    "data": {
        "createTime": "2025-10-22 07:15:50Z",
        "module": "sqlTask",
        "submitterId": "1030799091781335",
        "status": "success",
        "statusDesc": "",
        "executeTime": "2025-10-22 07:16:10Z",
        "datasourceId": "ds-ddduea45j638",
        "dbName": "ght",
        "bizData": {
            "sqlText": "insert into date_time_test1 (datetime_col) values (now());",
            "executorType": "creator",
            "estimatedAffectedRows": 1,
            "sqlInputType": "text"
        }
    }
}

数据导出

{
    "success": true,
    "requestId": "By6m0RZC-BHGBbVWnCABf9OFdIEc1QQH",
    "data": {
        "createTime": "2025-09-24 09:34:13Z",
        "module": "dataExport",
        "submitterId": "1030799091781335",
        "status": "finished",
        "statusDesc": "",
        "executeTime": "2025-09-24 09:34:27Z",
        "datasourceId": "ds-dbiid6umxp4h",
        "dbName": "ght",
        "bizData": {
            "reason": "11",
            "charset": "utf8",
            "executorType": "creator",
            "sqlStatement": "select version();",
            "sqlExtOption": ["compress"],
            "type": "sql",
            "contentType": "data",
            "fileType": "sql"
        }
    }
}