RunSemanticJob - 运行语义任务 - 大数据开发治理平台 DataWorks

接口说明

功能说明

按 Name 加载一个已保存的语义任务定义，并向执行器提交一次新的分析运行。本接口不接收运行时的 Source、资源组或参考文件覆盖项：执行始终使用 CreateSemanticJob 保存的配置。

执行前校验

服务会校验任务存在性和访问权限，并重新校验已关联文件是否仍存在。对于通过 ReferenceFileIds 关联的文件，服务会在提交前解析为本次运行可读取的临时地址；因此上传后删除文件或填写无效文件 ID 会导致提交失败。

响应与后续操作

Data.JobRunId 标识本次语义任务运行，用于 DownloadSemanticResults 精确下载本次产物；Data.ExecutorJobId 标识执行器任务，用于 GetSemanticJobDetail、GetSemanticJobLog 和 KillSemanticJob。响应成功表示执行器已接受提交，不表示模型分析或结果文件已经完成。

费用说明

请确保在使用该接口前，已充分了解语意构建使用的模型调用的收费方式和价格

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:RunSemanticJob

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	是	待运行任务的名称，使用 CreateSemanticJob 响应的 Data.Name 或 ListSemanticJobs 列表项的 Name。任务的 Source、ResourceGroupId 和参考文件由创建时保存的定义决定。	semantic-job-demo

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

返回参数

名称	类型	描述	示例值
	object	提交语义任务运行的标准响应。Data 中的两个标识分别用于结果下载和执行器查询。
RequestId	string	请求 ID。用于定位日志和排查问题。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	请求是否成功
Data	object	本次提交的运行信息。提交成功不代表语义模型产物已生成；请先用详情接口确认状态，再下载结果。
JobRunId	string	本次运行的唯一标识；传给 DownloadSemanticResults 的 JobRunId 可获取该次运行的产物。	01H00000000000000000000000
ExecutorJobId	string	执行器任务标识；传给 GetSemanticJobDetail、GetSemanticJobLog 或 KillSemanticJob 的 ExecutorJobId。	exec-job-demo
CurrentSqlIndex	integer	提交响应中执行器返回的当前 SQL 片段索引。	0
ExecTypes	array	提交响应中执行器返回的执行类型编码列表。
	integer	执行器返回的执行类型编码列表。	6
Env	string	提交响应中执行器返回的运行环境标识。	PROD
Statuses	array	提交响应中执行器返回的状态编码列表；提交阶段的状态不表示结果已完成。
	integer	执行器返回的任务状态编码列表；成功状态包含 3。	3

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

示例

正常返回示例

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": true,
  "Data": {
    "JobRunId": "01H00000000000000000000000",
    "ExecutorJobId": "exec-job-demo",
    "CurrentSqlIndex": 0,
    "ExecTypes": [
      6
    ],
    "Env": "PROD",
    "Statuses": [
      3
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。