文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 更新任务使用的执行机
更新时间：2025-08-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新任务使用的执行机

功能介绍

更新任务使用的执行机

调用方法

请参见如何调用API。

URI

PUT /v1/tasks/{task_id}/resource-pool

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

X-Language

否

String

参数解释：

语言，决定响应以哪种语言返回。

约束限制：

不涉及。

取值范围：

  • zh-cn，中文。

  • en-us，英文。

默认取值：

zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

resourceType

是

String

使用资源池：custom；使用内置执行机：default

resourcePools

否

Array of ResourcePool objects

执行机信息，使用内置执行机时空传
表4 ResourcePool

参数

是否必选

参数类型

描述

id

是

String

资源池id

name

否

String

资源池名称

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

httpStatus

String

响应状态

result

String

响应信息

status

String

响应状态

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

更新任务使用的执行机

PUT https://{endpoint}/v1/tasks/{task_id}/resource-pool

{
  "resourceType" : "custom",
  "resourcePools" : [ {
    "id" : "e8fc38d6exxxxfd39f39xxxx0c5f4a45",
    "name" : "new_engine_4u8g"
  } ]
}

响应示例

状态码：200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : "update resource pool success",
  "status" : "success"
}

状态码：400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙，请稍后再试"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档