流计算 Oceanus 创建作业配置-API 文档-文档中心-腾讯云

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	主类入参示例值：--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
ClsTopicId	否	String	CLS日志主题ID 示例值：xxx
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索引名称
EsServerlessSpace	否	String	es索引空间

3. 输出参数

参数名称	类型	描述
Version	Integer	作业配置版本号示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建作业配置示例

创建一个作业配置

输入示例

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。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

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.NoPermissionAccess	权限拦截,没有进入权限。

创建作业配置

本页目录：