Help Center/ CodeArts Pipeline/ API Reference/ API/ GitCode Pipeline/ Querying the Running Details of a GitCode Pipeline
Updated on 2025-09-08 GMT+08:00

Querying the Running Details of a GitCode Pipeline

Function

This API is used to query the running details of a GitCode pipeline.

Calling Method

For details, see Calling APIs.

URI

GET /v6/{domain_id}/api/pac/pipelines/actions/{pipeline_id}/{pipeline_run_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant 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 only digits and letters.

Default value:

N/A

pipeline_run_id

Yes

String

Definition:

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

Constraints:

N/A

Value range:

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

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

pipelineId

String

Definition:

Pipeline ID.

Value range:

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

pipelineName

String

Definition:

Pipeline name.

Value range:

N/A

pipelineRunId

String

Definition:

Pipeline running ID.

Value range:

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

pipelineRunName

String

Definition:

Pipeline running name.

Value range:

N/A

startTime

String

Definition:

Start time of pipeline running.

Value range:

N/A

endTime

String

Definition:

End time of pipeline running.

Value range:

N/A

status

String

Definition:

Pipeline running status.

Value range:

N/A

triggerType

String

Definition:

Pipeline trigger type.

Value range:

N/A

actor

String

Definition:

User who executes the pipeline.

Value range:

N/A

runNumber

String

Definition:

Pipeline running ID.

Value range:

N/A

commitId

String

Definition:

Code commit ID.

Value range:

N/A

jobs

Array of PipelineRunJobInfo objects

Definition:

Pipeline running job details.

Value range:

N/A

Table 3 PipelineRunJobInfo

Parameter

Type

Description

name

String

Definition:

Job name.

Value range:

N/A

id

String

Definition:

Job ID.

Value range:

N/A

identifier

String

Definition:

Unique identifier of a job.

Value range:

N/A

condition

String

Definition:

Condition expression.

Value range:

N/A

status

String

Definition:

Job status.

Value range:

N/A

startTime

String

Definition:

Job start time.

Value range:

N/A

endTime

String

Definition:

Job end time.

Value range:

N/A

steps

Array of PipelineRunStepInfo objects

Definition:

Job steps.

Value range:

N/A

Table 4 PipelineRunStepInfo

Parameter

Type

Description

name

String

Definition:

Step name.

Value range:

N/A

id

String

Definition:

Step ID.

Value range:

N/A

task

String

Definition:

Task name in a step.

Value range:

N/A

status

String

Definition:

Step status.

Value range:

N/A

startTime

String

Definition:

Step start time.

Value range:

N/A

endTime

String

Definition:

Step end time.

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.