Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Obtaining Custom Executors

Updated on 2026-08-10 GMT+08:00

Obtaining Custom Executors

Function

This API is used to query information about the custom executor resource pool configured by a user. You can use this API to obtain the name and type of the created executor resource pool. The resource pool can be filtered by name.

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:get	Read	task *	-	-	-
codeartscheck:task:get	Read	-	codeartscheck:ProjectId	-	-

URI

GET /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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	No	Integer	Definition: Page number, starting from 1. Constraints: N/A Value range: ≥1 Default value: 1
page_size	No	Integer	Definition: Page size. Constraints: N/A Value range: 1–50 Default value: 50
search	No	String	Definition: Name of the custom executor resource pool to be queried. Constraints: N/A. Value range: 1 to 50 characters. Default value: N/A.

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** 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	ResourcePoolsResult object	Definition: Agent pool details.
status	String	Definition: API response status. Value range: success: successful response. error: response failed.

**Table 5** ResourcePoolsResult
Parameter	Type	Description
resourcePoolId	String	Definition: ID of an enabled agent pool. Leave this parameter blank when using built-in executors. Value range: 1 to 32 characters.
resourcePoolName	String	Definition: Name of an enabled agent pool. Leave this parameter blank when using built-in executors. Value range: 1 to 50 characters.
resourcePools	Array of ResourcePoolsItemResponse objects	Definition: Available agent pools. Value range: N/A
resourceType	String	Definition: Agent pool type. Value range: custom: custom agent pool. default: built-in agent pool.
resource_pool_type	String	Definition: Enabled agent pool type. Value range: default: built-in agent pool. exclusive: dedicated agent pool. self-hosted: self-hosted agent pool.
total	Integer	Definition: Total number. Value range: ≥0

**Table 6** ResourcePoolsItemResponse
Parameter	Type	Description
id	String	Definition Resource pool ID. Range 1 to 32 characters.
isSelected	Boolean	Definition: Whether the agent pool is enabled. Value range: true: The agent pool is enabled. false: The agent pool is not enabled.
name	String	Definition Resource pool name. Range The value contains 1 to 50 characters.
resource_type	String	Definition: Agent pool type. Value range: default: built-in agent pool. exclusive: dedicated agent pool. self-hosted: self-hosted agent pool.
type	String	Definition: Agent pool type. Value range: Mac Windows_VM VM Docker default
disabled	Boolean	Definition Whether a resource pool is disabled. Range true: disabled false: enabled
immutable	Boolean	Definition Whether a resource pool is unchangeable. Range true: unchangeable false: changeable

Status code: 400

**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

Status code: 401

**Table 8** 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

Query custom executors of a specified task_id.

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

Example Responses

Status code: 200

Request succeeded.

{
  "httpStatus" : "OK",
  "result" : {
    "resourcePoolId" : "ab2exxxxc0ec4beb99b91629xxxxd380",
    "resourcePoolName" : "new_engine_4u8g",
    "resourcePools" : [ {
      "id" : "ab2exxxxc0ec4beb99b91629xxxxd380",
      "isSelected" : true,
      "name" : "new_engine_4u8g",
      "type" : "DOCKER"
    }, {
      "id" : "11223344xxxxxxxx11223344xxxxxxx1",
      "isSelected" : false,
      "name" : "Win7Custom",
      "type" : "WINDOWS_VM"
    } ],
    "resourceType" : "custom",
    "resource_pool_type" : "default",
    "total" : 2
  },
  "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

Previous topic: Task Management

Next topic: Updating the Executors of a Task