1. 接口描述
接口请求域名： oceanus.tencentcloudapi.com 。
新建作业接口，一个 AppId 最多允许创建1000个作业
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateJob。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Name | 是 | String | 作业名称，允许输入长度小于50个字符的中文、英文、数字、-（横线）、（下划线）、.（点），且符号必须半角字符。注意作业名不能和现有作业同名 示例值：jobnew |
| JobType | 是 | Integer | 作业的类型，1 表示 SQL 作业，2 表示 JAR 作业 示例值：2 |
| ClusterType | 是 | Integer | 集群的类型，1 表示共享集群，2 表示独享集群 示例值：2 |
| ClusterId | 否 | String | 当 ClusterType=2 时，必选，用来指定该作业提交的独享集群 ID 示例值：cluster-xxxxxxxx |
| CuMem | 否 | Integer | 设置每 CU 的内存规格，单位为 GB，支持 2、4、8、16（需申请开通白名单后使用）。默认为 4，即 1 CU 对应 4 GB 的运行内存 示例值：4 |
| Remark | 否 | String | 作业的备注信息，可以随意设置 示例值：测试作业 |
| FolderId | 否 | String | 作业名所属文件夹ID，根目录为"root" 示例值：folder-xxxxxxxx |
| FlinkVersion | 否 | String | 作业运行的Flink版本 示例值：Flink-1.11 |
| WorkSpaceId | 否 | String | 工作空间 SerialId 示例值：space-1327 |
| Tags.N | 否 | Array of Tag | 作业标签 示例值：1 |
| Description | 否 | String | 作业描述 示例值：description of job |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 作业Id 示例值：cql-qlpn5o2a |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建作业
创建作业
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateJob
<公共请求参数>
{
"Name": "create_job_test",
"JobType": 1,
"ClusterType": 2,
"ClusterId": "cluster-5c42n3a5",
"WorkSpaceId": "space-53rqk422",
"Description": "some description"
}输出示例
{
"Response": {
"JobId": "cql-e92rhppb",
"RequestId": "9159e720-d61c-459f-862b-d630de3209dd"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 未授权操作。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DuplicatedJobName | 重复的作业名。 |
| FailedOperation.UserNotAuthenticated | 用户未实名验证。 |
| InternalError | 内部错误。 |
| InternalError.DB | 数据库异常。 |
| InternalError.LogicError | 内部错误。 |
| InvalidParameter.InvalidName | 名字不符合规范。 |
| InvalidParameterValue.ClusterId | 集群Id指定错误，为空或者不存在。 |
| InvalidParameterValue.CuMem | CU内存规格不匹配。 |
| InvalidParameterValue.JobName | Illegal JobName。 |
| InvalidParameterValue.JobNameExisted | 作业名称已存在。 |
| InvalidParameterValue.JobTypeCombineWithClusterType | 集群模式与作业类型不匹配。 |
| InvalidParameterValue.UnSupportedComposite | 不支持的复合类型。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.Job | Job个数超过限额。 |
| ResourceNotFound.ClusterId | 集群不存在。 |
| ResourceUnavailable.Cluster | 集群处于非运行状态。 |
| ResourceUnavailable.ClusterGroupStatus | 群集组状态错误。 |
| ResourceUnavailable.ReqCuMem | 共享群集只允许CuMem=4。 |
| UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |
