Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Updating the Executors of a Task
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating the Executors of a Task

Function

This API is used to update the executor resource pool used by the task. The resource pool can be the default resource pool, dedicated resource pool, or custom resource pool.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, which is the return value of the API used to create a check task. Each check task, its brach tasks, and incremental tasks created through APIs have a unique task ID. Obtain the ID by calling the API used to query the task list. id indicates the task ID.

Constraints:

N/A.

Value range:

1 to 32 characters.

Default value:

N/A.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

The length is the value of [1-100000].

Default Value

N/A

X-Language

No

String

Definition:

Language of the response.

Constraints:

N/A

Value range:

  • zh-cn: Chinese.

  • en-us: English.

Default value:

zh-cn

Content-Type

No

String

Definition:

Media type and encoding format.

Constraints:

N/A

Value range:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resource_pool_type

No

String

Definition

Type of the enabled resource pool.

Constraints

N/A

Range

  • default: built-in

  • exclusive: dedicated

  • self-hosted: self-hosted

Default Value

N/A

resourcePools

No

Array of ResourcePool objects

Definition:

Agent pool information.

Constraints:

This parameter is mandatory when a custom agent pool or dedicated agent pool is used. This parameter is optional when a built-in agent pool is used.

Value range:

N/A

Default value:

N/A
Table 4 ResourcePool

Parameter

Mandatory

Type

Description

resource_type

No

String

Definition

Resource pool type.

Constraints

1 to 32 characters.

Range

  • default: built-in

  • exclusive: dedicated

  • self-hosted: self-hosted

Default Value

N/A

id

Yes

String

Definition :

Agent pool ID. Obtain the ID by calling the API used to obtain the custom executor list.

Constraints:

N/A.

Value range:

1 to 32 characters.

Default value:

N/A.

name

No

String

Definition :

Agent pool name. Obtain the name by calling the API used to obtain the custom executor list.

Constraints:

N/A.

Value range:

1 to 50 characters.

Default value:

N/A.

isSelected

No

Boolean

Definition

Whether a resource pool is enabled.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

type

No

String

Definition

Resource pool type.

Constraints

N/A

Range

  • MAC

  • WINDOWS_VM

  • VM

  • DOCKER

  • default

Default Value

N/A

disabled

No

Boolean

Definition

Whether a resource pool is disabled.

Constraints

N/A

Range

  • true: disabled

  • false: enabled

Default Value

false

immutable

No

Boolean

Definition

Whether a resource pool is unchangeable.

Constraints

N/A

Range

  • true: unchangeable

  • false: changeable

Default Value

false

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

result

String

Definition:

Response message.

Value range:

N/A

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Update the executor used by a task.

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

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

Example Responses

Status code: 200

Request succeeded.

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

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management