GetSemanticJobDetail - 查询语义任务运行详情

更新时间:
复制 MD 格式

使用 RunSemanticJob 或 ListSemanticJobRuns 返回的 ExecutorJobId 查询执行器状态与运行配置。

接口说明

使用场景

查询某次语义任务运行在执行器侧的详细状态和运行信息,用于轮询执行进度或排查运行失败。

调用流程

  1. 调用 RunSemanticJobListSemanticJobRuns 获取 ExecutorJobId

  2. 使用任务定义返回的 ProjectId 作为本接口的 ProjectId

  3. 根据 Data 中的执行器详情判断当前状态;任务仍在运行时可继续轮询本接口。

关联操作

需要日志时调用 GetSemanticJobLog;需要停止运行时调用 KillSemanticJob

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ExecutorJobId

string

执行器任务标识,使用 RunSemanticJob 响应的 Data.ExecutorJobId 或 ListSemanticJobRuns 记录中的 ExecutorJobId。

exec-job-demo

ProjectId

integer

任务所属 DataWorks 工作空间 ID,使用 CreateSemanticJob 响应或 ListSemanticJobs 列表项的 ProjectId。

100

请根据各请求字段的说明构造调用参数。

返回参数

名称

类型

描述

示例值

object

查询执行器运行详情的标准响应。Data 是指定 ExecutorJobId 当前返回的执行器详情。

RequestId

string

请求 ID。用于定位日志和排查问题。

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

请求是否成功

Data

object

执行器返回的任务详情,用于判断运行状态并查看实际生效的运行配置。

ExecutorJobId

string

执行器任务标识。

exec-job-demo

FileType

integer

执行器节点类型编码;语义任务使用 Shell 节点编码 6。

6

ProjectId

integer

执行器任务关联的 DataWorks 工作空间 ID。

100

Datasource

string

执行器任务使用的数据源标识。

maxcompute

CodeParameters

string

执行器返回的代码参数信息,用于排查本次运行配置。

--limit 100

Env

string

执行器返回的运行环境标识。

PROD

CustomerName

string

执行器任务的客户标识。

meta_semantic

CurrentSqlIndex

integer

执行器当前处理的 SQL 片段索引。

0

ExecTypes

array

执行器返回的执行类型编码列表。

integer

执行器返回的执行类型编码列表。

6

Statuses

array

执行器返回的状态编码列表;用于判断任务当前或最终状态。

integer

执行器返回的任务状态编码列表;成功状态包含 3。

3

AdvanceSettings

object

执行器返回的高级运行设置。

ResourceUrls

array<object>

执行器任务关联的资源地址列表。

object

执行器返回的资源地址列表。

ResourceGroupId

string

实际执行该任务的资源组标识。

rg-demo

响应字段含义和后续调用关系请参阅各字段说明。

示例

正常返回示例

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": true,
  "Data": {
    "ExecutorJobId": "exec-job-demo",
    "FileType": 6,
    "ProjectId": 100,
    "Datasource": "maxcompute",
    "CodeParameters": "--limit 100",
    "Env": "PROD",
    "CustomerName": "meta_semantic",
    "CurrentSqlIndex": 0,
    "ExecTypes": [
      6
    ],
    "Statuses": [
      3
    ],
    "AdvanceSettings": {
      "test": "test",
      "test2": 1
    },
    "ResourceUrls": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "ResourceGroupId": "rg-demo"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情