创建作业配置

最近更新时间:2026-03-27 02:32:10

我的收藏

1. 接口描述

接口请求域名: oceanus.tencentcloudapi.com 。

创建作业配置,一个作业最多有100个配置版本

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateJobConfig。
Version String 公共参数,本接口取值:2019-04-22。
Region String 公共参数,详见产品支持的 地域列表
JobId String

作业Id


示例值:cql-abcdefg
EntrypointClass String

主类


示例值:com.tencent.cloud.test.WordCount
ProgramArgs String

主类入参,需要区分下Sql作业配置,Jar作业配置,Python作业配置,具体参考下面的示例值


示例值:--conf Key=Value
Remark String

备注


示例值:example
ResourceRefs.N Array of ResourceRef

资源引用数组

DefaultParallelism Integer

作业默认并行度


示例值:2
Properties.N Array of Property

系统参数

AutoDelete Integer

1: 作业配置达到上限之后,自动删除可删除的最早版本


示例值:1
COSBucket String

作业使用的 COS 存储桶名


示例值:example-oceanus-1257058918
LogCollect Boolean

是否采集作业日志


示例值:true
JobManagerSpec Float

JobManager规格


示例值:0.5
TaskManagerSpec Float

TaskManager规格


示例值:0.5
ClsLogsetId String

CLS日志集ID


示例值:544002e3-299b-41d2-b18f-19194fb0660b
ClsTopicId String

CLS日志主题ID


示例值:544002e3-299b-41d2-b18f-19194fb0660b
LogCollectType Integer

日志采集类型 2:CLS;3:COS


示例值:2
PythonVersion String

pyflink作业运行时使用的python版本


示例值:Python-3.7
WorkSpaceId String

工作空间 SerialId


示例值:space-1327
LogLevel String

日志级别


示例值:INFO
AutoRecover Integer

Oceanus 平台恢复作业开关 1:开启 -1: 关闭


示例值:1
ClazzLevels.N Array of ClazzLevel

类日志级别

ExpertModeOn Boolean

是否打开专家模式


示例值:false
ExpertModeConfiguration ExpertModeConfiguration

专家模式的配置

TraceModeOn Boolean

trace链路


示例值:false
TraceModeConfiguration TraceModeConfiguration

trace链路配置

CheckpointRetainedNum Integer

checkpoint保留个数


示例值:1
JobGraph JobGraph

算子拓扑图

EsServerlessIndex String

es索引名称


示例值:"index-xxxxx"
EsServerlessSpace String

es索引空间


示例值:"space-xxxxx"
FlinkVersion String

flink版本


示例值:Flink-1.13
JobManagerCpu Float

JobManager cpu


示例值:1.0
JobManagerMem Float

JobManager 内存


示例值:1.0
JdkVersion String

jdk版本


示例值:8
TaskManagerCpu Float

TaskManager cpu


示例值:1.0
TaskManagerMem Float

TaskManager 内存


示例值:1.0
UseOldSystemConnector Integer

0=默认使用老的 1=使用新的


示例值:0
ProgramArgsAfterGzip String

压缩参数


示例值:压缩参数
CheckpointTimeoutSecond Integer

checkpoint 超时时间


示例值:36000
CheckpointIntervalSecond Integer

checkpoint 间隔时间


示例值:600
VariableReplaceMode Integer

变量替换模式

枚举值:

  • 0: 表变量替换
  • 1: SQL全局变量替换

默认值:1


示例值:1

3. 输出参数

参数名称 类型 描述
Version Integer

作业配置版本号


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

4. 示例

示例1 创建Python作业配置示例

创建python作业配置示例

输入示例

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

{
    "JobId": "cql-68w5vlip",
    "EntrypointClass": "com.tencent.cloud.oceanus.wordcount.WordCount",
    "ProgramArgs": "",
    "Remark": "v1",
    "ResourceRefs": [
        {
            "ResourceId": "resource-lbi8h92t",
            "Version": 1,
            "Type": 1
        }
    ],
    "DefaultParallelism": 1,
    "Properties": [
        {
            "Key": "pipeline.max-parallelism",
            "Value": "2048"
        }
    ],
    "LogCollect": true,
    "ClsLogsetId": "10981e21-aee9-4a01-9ed9-eadf5956fe3c",
    "ClsTopicId": "544002e3-299b-41d2-b18f-19194fb0660b",
    "LogCollectType": 2,
    "PythonVersion": "Python-3.7",
    "WorkSpaceId": "space-1257058945ap-guangzhou",
    "LogLevel": "INFO",
    "AutoRecover": 1,
    "ClazzLevels": [],
    "ExpertModeOn": false,
    "ExpertModeConfiguration": {},
    "TraceModeOn": false,
    "TraceModeConfiguration": {},
    "CheckpointRetainedNum": 0,
    "JobGraph": {
        "Nodes": [],
        "Edges": []
    },
    "EsServerlessIndex": "",
    "EsServerlessSpace": "",
    "FlinkVersion": "Flink-1.13",
    "JobManagerCpu": 0,
    "JobManagerMem": 0,
    "TaskManagerCpu": 0,
    "TaskManagerMem": 0
}

输出示例

{
    "Response": {
        "RequestId": "8b4433c9-3efc-4afc-a2bd-78d682f5c3dd",
        "Version": 2
    }
}

示例2 创建SQL作业配置示例

创建SQL作业配置,
其中ProgramArgs参数包括了大量的入参,SqlCode 、Metadata 都采用了base64加密

输入示例

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

{
    "JobId": "cql-5kmc4o48",
    "ProgramArgs": "{\"CheckpointInterval\":600,\"Metadata\":\"eyJNZXRhZGF0YSI6eyJSZWZlcmVuY2VUYWJsZXMiOltdLCJWYXJpYWJsZXMiOltdfX0=\",\"SqlCode\":\"CkNSRUFURSBUQUJMRSBgRGF0YV9JbnB1dGAgKCAtLeatpemqpCAxIO+8muWIm+W7uuaVsOaNrua6kOihqO+8iFNvdXJjZe+8iSBEYXRhX0lucHV0CiAgICBhZ2UgQklHSU5ULAogICAgc2NvcmUgQklHSU5UCikgV0lUSCAoCiAgICAnY29ubmVjdG9yJyA9ICdkYXRhZ2VuJywKICAgICdyb3dzLXBlci1zZWNvbmQnPScxMDAnLCAgICAgICAgICAtLSDmr4/np5LkuqfnlJ/nmoTmlbDmja7mnaHmlbAKCiAgICAnZmllbGRzLmFnZS5raW5kJz0ncmFuZG9tJywgICAgICAgLS0g5peg55WM55qE6ZqP5py65pWwCiAgICAnZmllbGRzLmFnZS5taW4nPScxJywgICAgICAgICAgIC0tIOmaj+acuuaVsOeahOacgOWwj+WAvAogICAgJ2ZpZWxkcy5hZ2UubWF4Jz0nMTAwJywgICAgICAgICAtLSDpmo/mnLrmlbDnmoTmnIDlpKflgLwKCiAgICAnZmllbGRzLnNjb3JlLmtpbmQnPSdyYW5kb20nLCAgICAgICAgLS0g5peg55WM55qE6ZqP5py65pWwCiAgICAnZmllbGRzLnNjb3JlLm1pbic9JzEnLCAgICAgICAgICAgICAgLS0g6ZqP5py65pWw55qE5pyA5bCP5YC8CiAgICAnZmllbGRzLnNjb3JlLm1heCc9JzEwMDAnICAgICAgICAgICAgLS0g6ZqP5py65pWw55qE5pyA5aSn5YC8Cik7CgpDUkVBVEUgVEFCTEUgYERhdGFfT3V0cHV0YCAoIC0t5q2l6aqkIDIg77ya5Yib5bu65pWw5o2u57uT5p6c6KGo77yIU2lua++8iSBEYXRhX091dHB1dAogICAgYGF2Z19hZ2VgIEJJR0lOVCwKICAgIGBhdmdfc2NvcmVgIEJJR0lOVAopIFdJVEggKAogICAgJ2Nvbm5lY3RvcicgPSAnYmxhY2tob2xlJwopOwoKSU5TRVJUIElOVE8gYERhdGFfT3V0cHV0YCAgIC0t5q2l6aqkIDMg77yaIOWwhuaVsOaNrua6kOihqO+8iFNvdXJjZe+8iSBEYXRhX0lucHV0IOS4reeahCBhZ2Ug5ZKMIHNjb3JlIOWPluW5s+Wdh+aVsOS5i+WQjuWtmOWCqOS6juaVsOaNrue7k+aenOihqO+8iFNpbmvvvIkgRGF0YV9PdXRwdXQKU0VMRUNUIEFWRyhhZ2UpLCBBVkcoc2NvcmUpIEZST00gYERhdGFfSW5wdXRgOwo=\"}",
    "Remark": "v2",
    "ResourceRefs": [],
    "DefaultParallelism": 1,
    "Properties": [
        {
            "Key": "pipeline.max-parallelism",
            "Value": "2048"
        }
    ],
    "LogCollect": true,
    "ClsLogsetId": "10981e21-aee9-4a01-9ed9-eadf5956fe3c",
    "ClsTopicId": "544002e3-299b-41d2-b18f-19194fb0660b",
    "LogCollectType": 2,
    "WorkSpaceId": "space-1257058945ap-guangzhou",
    "LogLevel": "INFO",
    "AutoRecover": 1,
    "ClazzLevels": [],
    "ExpertModeOn": false,
    "ExpertModeConfiguration": {},
    "TraceModeOn": false,
    "TraceModeConfiguration": {},
    "CheckpointRetainedNum": 0,
    "JobGraph": {
        "Nodes": [],
        "Edges": []
    },
    "EsServerlessIndex": "",
    "EsServerlessSpace": "",
    "FlinkVersion": "Flink-1.16",
    "JobManagerCpu": 1,
    "JobManagerMem": 4,
    "TaskManagerCpu": 1,
    "TaskManagerMem": 4
}

输出示例

{
    "Response": {
        "RequestId": "8f152cf4-9a43-40fa-a2ea-f28e74cd24ff",
        "Version": 3
    }
}

示例3 新建Jar作业配置示例

创建一个Jar作业配置

输入示例

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

{
    "ProgramArgs": "2000",
    "EntrypointClass": "com.tencent.flink.test.WordCount",
    "JobId": "cql-n8yaia0y"
}

输出示例

{
    "Response": {
        "Version": 2,
        "RequestId": "5f124d6f-b035-4d29-9467-dd62eccdbf23"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 未授权操作。
FailedOperation 操作失败。
FailedOperation.GrammarCheckFailure 语法检查失败。
FailedOperation.ParseSql SQL解析失败。
InternalError.COSClient COS 服务访问错误。
InternalError.DB 数据库异常。
InternalError.LogicError 内部错误。
InternalError.SqlCodeNotFound 未找到sqlcode错误。
InternalError.StsNewClient 内部错误。
InvalidParameter.IllegalMaxParallelism 非法的 MaxParallelism 参数。
InvalidParameter.InvalidRegion 无效Region。
InvalidParameter.JobConfigLogCollectParamError 创建作业配置错误。
InvalidParameter.MaxParallelismTooLarge MaxParallelism 过大。
InvalidParameter.MaxParallelismTooSmall MaxParallelism 不允许小于算子默认并行度。
InvalidParameter.UnsupportedFlinkConf Flink参数非法。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.JobTypeCombineWithEntrypointClass SQL作业不能指定EntrypointClass,JAR作业则必须指定。
LimitExceeded 超过配额限制。
LimitExceeded.JobConfig 作业配置超出限制。
ResourceNotFound 资源不存在。
ResourceNotFound.COSBucket COS Bucket 未找到或无权限访问。
ResourceNotFound.Job 作业不存在。
ResourceNotFound.JobId 找不到作业。
UnsupportedOperation.InvalidCheckpointIntervalError Checkpoint 时间间隔,错误。
UnsupportedOperation.MultiExternalCatalogUnsupported 引用了多个外部数据源,目前SQL作业只允许引用一个外部数据源。
UnsupportedOperation.MultiExternalEmrOrHiveCatalogUnsupported 不支持多EmrOrHive Catalog
UnsupportedOperation.NoPermissionAccess 权限拦截,没有进入权限。