1. 接口描述
接口请求域名: oceanus.tencentcloudapi.com 。
更新作业属性,仅允许以下3种操作,不支持组合操作:
(1) 更新作业名称
(2) 更新作业备注
(3) 更新作业最大并行度
变更前提:WorkerCuNum<=MaxParallelism
如果MaxParallelism变小,不重启作业,待下一次重启生效
如果MaxParallelism变大,则要求入参RestartAllowed必须为True
假设作业运行状态,则先停止作业,再启动作业,中间状态丢失
假设作业暂停状态,则将作业更改为停止状态,中间状态丢失
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyJob。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
JobId | 是 | String | 作业Id 示例值:cql-6iaginqp |
Name | 否 | String | 作业名称,支持长度小于50的中文/英文/数字/”-”/”_”/”.”,不能重名 示例值:test |
Remark | 否 | String | 描述 示例值:测试 |
TargetFolderId | 否 | String | 拖拽文件需传入此参数 示例值:folder-xxxxxxxx |
WorkSpaceId | 否 | String | 工作空间 SerialId 示例值:space-1237 |
Description | 否 | String | 作业描述 示例值:description |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新作业
更新作业
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyJob
<公共请求参数>
{
"JobId": "cql-glegwraz",
"Name": "modify_test",
"WorkSpaceId": "space-53rqk422"
}
输出示例
{
"Response": {
"RequestId": "db5c46b4-b927-4a24-963d-a24e333cc78f"
}
}
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 | 重复的作业名。 |
InternalError.JobInstanceNotFound | 作业实例没找到。 |
InternalError.SystemError | 系统错误。 |
InvalidParameterValue.JobName | Illegal JobName。 |
ResourceNotFound.Job | 作业不存在。 |
UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |