Help Center/CodeArts Build/API Reference/APIs/Build Task Management/Setting an Agency for Executing Multiple Tasks
Updated on 2026-03-31 GMT+08:00

Setting an Agency for Executing Multiple Tasks

Function

This API is used to set an agency for executing multiple tasks. Once configured, you can perform builds using this agent's identity.

Calling Method

For details, see Calling APIs.

URI

POST /v1/job/batch-agency

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

job_ids

Yes

Array of strings

Definition

A list of job_ids.

Constraints

N/A.

Range

Build task ID.

Default Value

N/A.

agency_urn

No

String

Definition

Agency URN. It can be obtained from IAM.

Constraints

N/A

Range

It is left blank by default.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition

API response status.

Range

success: The API call is successful.

fail: The API call failed.

error

Object

Definition

Error message.

Range

N/A.

result

String

Definition

Data returned after the API is successfully called.

Range

N/A.

Example Requests

POST https://{endpoint}/v1/job/batch-agency

{
  "job_ids" : [ "436ab57485c94629b60d5c5fb02cb037", "34b1146d863044b6ade25d527169330d" ],
  "agency_urn" : "iam::60021bab32fd450aa2cb89226f425e06:agency:build_admin_trust"
}

Example Responses

Status code: 200

OK

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.