更新作业-UpdateJob
功能介绍
更新作业
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
octopus:dataJob:update
Write
workspace *
-
-
-
URI
PUT /v1.0/{project_id}/data/jobs/{id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| id | 是 | Long | 参数解释: 作业ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| Content-Type | 是 | String | 参数解释: 内容类型。填application/json 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| action | 是 | String | 参数解释: 更新操作 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| resource_spec | 否 | String | 参数解释: 资源规格,示例:1Core_4GiB。具体获取方式可参考“查询可用资源规格“接口。重启作业时运行重新指定作业使用的资源规格。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| cluster_type | 否 | String | 参数解释: 集群类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| cluster_id | 否 | String | 参数解释: 集群ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
更新成功
无
请求示例
停止作业10
PUT https://{endpoint}/v1.0/{project_id}/data/jobs/10
{
"action" : "STOP"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新成功 |
| 400 | 请求参数错误 |
| 403 | 权限校验失败 |
| 404 | 找不到请求的资源 |
| 428 | 作业当前状态不支持该操作 |
| 500 | 系统内部错误 |
错误码
请参见错误码。