Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Obtaining the Address for Downloading an Agent
Updated on 2025-09-08 GMT+08:00

Obtaining the Address for Downloading an Agent

Function

This API is used to obtain the address for downloading an agent.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/pipelines/{pipeline_id}/{pipeline_run_id}/{job_run_id}/agent-runs/agent/download

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

pipeline_run_id

Yes

String

Definition:

Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

job_run_id

Yes

String

Definition:

Job running ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

arch

Yes

String

Definition:

CPU architecture of the executor.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version

Yes

String

Definition:

Agent version.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

ErrorInfo object

Definition:

Error message.

Value range:

N/A

result

Object

Definition:

Error result.

Value range:

N/A

status

String

Definition:

Status value.

Value range:

N/A

Table 4 ErrorInfo

Parameter

Type

Description

code

String

Definition:

Error code.

Value range:

N/A

message

String

Definition:

Error message.

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.