运行作业

最近更新时间:2024-03-12 01:42:38

我的收藏

1. 接口描述

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

批量启动或者恢复作业,批量操作数量上限20

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunJobs。
Version String 公共参数,本接口取值:2019-04-22。
Region String 公共参数,详见产品支持的 地域列表
RunJobDescriptions.N Array of RunJobDescription 批量启动作业的描述信息
WorkSpaceId String 工作空间 SerialId
示例值:space-1237

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 运行作业示例

输入示例

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

{
    "RunJobDescriptions": [
        {
            "RunType": 0,
            "JobConfigVersion": 1,
            "StartMode": "xx",
            "JobId": "xx",
            "SavepointId": "cql-asdf5678",
            "SavepointPath": "cosn://xxxx"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "18e0bde4-3922-42ca-8bfd-a36eaa035da4"
    }
}

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 操作失败。
InternalError.COSClient COS 服务访问错误。
InternalError.DB 数据库异常。
InternalError.FailedToUpdateJob 无法更新作业错误。
InternalError.LogicError 内部错误。
InternalError.StsNewClient 内部错误。
InvalidParameter.InvalidClusterId 无效集群id。
InvalidParameter.InvalidRegion 无效Region。
InvalidParameterValue.InvalidStartMode 无效启动模式。
InvalidParameterValue.JobIdValueError 作业id的参数无效。
InvalidParameterValue.RunJobDescriptionsCount 批量运行作业个数超过上限。
InvalidParameterValue.RunType RunType错误。
ResourceInUse.InstanceInProcess 集群有其他操作。
ResourceInsufficient.CU CU资源不足。
ResourceNotFound 资源不存在。
ResourceNotFound.COSBucket COS Bucket 未找到或无权限访问。
ResourceNotFound.ClusterId 集群不存在。
ResourceNotFound.Job 作业不存在。
ResourceNotFound.JobConfig 作业配置版本不存在。
ResourceNotFound.Resource 程序包不存在。
ResourceUnavailable 资源不可用。
ResourceUnavailable.JobResourceConfigNotReady 作业资源配置未就绪。
ResourceUnavailable.NoRunningJobInstancesFoundForJobId 找不到JobId的正在运行的作业实例。
UnsupportedOperation.NoPermissionAccess 权限拦截,没有进入权限。
UnsupportedOperation.UnsupportedStartMode 不支持的启动模式。