Help Center/ CodeArts Pipeline/ API Reference/ API/ GitCode Pipeline/ Querying GitCode Pipeline Logs
Updated on 2025-09-08 GMT+08:00

Querying GitCode Pipeline Logs

Function

This API is used to query GitCode pipeline logs.

Calling Method

For details, see Calling APIs.

URI

POST /v6/{domain_id}/api/pac/pipelines/actions/{pipeline_id}/{pipeline_run_id}/{job_run_id}/logs

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

job_run_id

Yes

String

Definition:

Job run ID. Obtain the ID by calling the API for obtaining the pipeline execution details. JobRun.id indicates job run ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Definition:

Offset where the query starts.

Constraints:

N/A

Value range:

The offset value must be no less than 0.

Default value:

N/A

limit

No

Long

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

The value is no less than 0.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

has_more

Boolean

Definition:

Whether there are more logs.

Value range:

  • true: There are more logs.

  • false: There are no more logs.

end_offset

Integer

Definition:

Log end offset.

Value range:

N/A

start_offset

Integer

Definition:

Log start offset.

Value range:

N/A

log

String

Definition:

Log details.

Value range:

N/A

location

String

Definition:

Location of a log.

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.