帮你快速理解、总结文档立即下载
文档中心>数据湖计算 DLC>API 文档>AI DLC 作业管理相关接口>AI DLC 创建作业

AI DLC 创建作业

最近更新时间：2026-09-25 02:00:48
我的收藏

本页目录：

1. 接口描述

接口请求域名： dlc.tencentcloudapi.com 。

创建并提交作业 Action。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateJob。
Version 是 String 公共参数，本接口取值：2021-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
JobName 否 String

作业名称，长度 ≤256；可省略，省略时服务端回退为 JobId。


示例值：string
CheckpointLocation 否 String

流作业 checkpoint 路径（如 cosn://bucket/path/checkpoint）。MinorType=SPARK_STREAM 时必填；同一作业的多次运行必须复用同一路径，变更等于重置消费进度。


示例值：string
MajorType 否 String

引擎大类，非必传，缺省 SPARK；当前仅支持 SPARK。


示例值：SPARK
MinorType 否 String

作业子类型，决定入口形态：SPARK_SQL（SQL 作业，Entrypoint.Statement 必填）/ SPARK_BATCH（批处理作业，Entrypoint.EntryFile 必填）/ SPARK_STREAM（流作业，EntryFile 与 CheckpointLocation 必填）。


示例值：SPARK_SQL
FlowId 否 String

工作流实例关联 ID（长度 ≤64）：同一工作流/会话的多条 SQL 作业传相同 FlowId，可共享同一 Spark 会话、复用已就绪引擎。MinorType=SPARK_SQL 时必填；FlowId 非空时必须同时传 ExecutionId。WAREHOUSE 模式下 FlowId 即会话句柄（一个 FlowId 只对应一个会话）：会话过期或已销毁后须换新 FlowId，否则返回 FailedOperation.FlowIdNotExists。


示例值：string
ExecutionId 否 String

工作流内部执行标识（长度 ≤64），同一 FlowId 下每次提交须唯一（如自增序号/UUID）。用于重复提交防重：同一账号下命中未删除的同 (FlowId, ExecutionId) 作业时返回 FailedOperation.FlowExecutionConflict。FlowId 非空时必填（SPARK_SQL 因 FlowId 必填而必填）。


示例值：string
RunMode 否 String

运行模式，必填。WAREHOUSE / JOB.


示例值：WAREHOUSE
WarehouseId 否 String

计算仓库 ID。RunMode=WAREHOUSE 时必填（仓库需处于 RUNNING，或 STOPPED 且 AutoStart 开启（提交后冷启动拉起））；RunMode=JOB 时必须为空。


示例值：string
RuntimeCode 否 String

运行时/镜像编码（可选值见 DescribeSparkRuntimes）。RunMode=JOB 时必填；RunMode=WAREHOUSE 时忽略。


示例值：string
SysCatalogVersion 否 String

内置 Catalog 版本码（取值为 DescribeSysCatalogList 返回的目录子类型）。RunMode=JOB 时条件必填：未传时若可用（enabled）SysCatalog 唯一则自动选中，多个/零个报错；RunMode=WAREHOUSE 时禁止传。


示例值：string
PartitionCode 否 String

资源分区代码，仅 RunMode=JOB 可传（QueueName 非空时必填）；RunMode=WAREHOUSE 时禁止传。


示例值：string
QueueName 否 String

队列名称，必须与 PartitionCode 成对使用（RunMode=JOB 下可选）；RunMode=WAREHOUSE 下被仓库反查值覆盖，无需传。


示例值：string
CustomProperties 否 String

自定义 Spark conf（JSON 字符串，亦接受多行 key=value 文本，归一化为 JSON 存储、出参恒为 JSON），作为 SPARK_CUSTOM 配置通道落库，两种运行模式均生效。


示例值：string
EnvVars.N 否 Array of KVPair

环境变量（KEY=VALUE）列表。仅 RunMode=JOB 可传；RunMode=WAREHOUSE 时禁止传。

3. 输出参数

参数名称 类型 描述
JobId String

作业唯一标识符（ID）。


示例值：string
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建作业

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateJob
<公共请求参数>

{
    "JobName": "spark-sql-demo",
    "MinorType": "SPARK_SQL",
    "FlowId": "flow-2a9c4e",
    "ExecutionId": "exec-6f1b83",
    "RunMode": "WAREHOUSE",
    "WarehouseId": "wh-8f21c3"
}

输出示例

{
    "Response": {
        "JobId": "job-9f3a2b1c",
        "RequestId": "f4a1c9b2-7d3e-4a58-9c62-1e8b5d7a2f43"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.ApiCallFailed 调用下游计费接口失败，资源销毁通知未送达
FailedOperation.FlowExecutionConflict 工作流执行Id已存在
FailedOperation.FlowIdNotExists 工作流不存在
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied.ServiceNotActivated 服务未开通
ResourceInsufficient 资源不足。
ResourceNotFound.Partition 资源包Partition不存在
ResourceNotFound.Queue 资源队列不存在
ResourceNotFound.Warehouse 计算引擎不存在
ResourceUnavailable.Partition 资源包partition不可用。
ResourceUnavailable.Warehouse 计算引擎不可用
UnauthorizedOperation 未授权操作。
UnsupportedOperation.SingleTenantTccCatalog 当前账号绑定的是独享（单租户）TCCatalog 实例，暂不支持提交 Spark 作业。
中国站