Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Queuing Records in the Current Pipeline
Updated on 2025-03-25 GMT+08:00

Querying Queuing Records in the Current Pipeline

Function

This API is used to query the queuing records in the current pipeline.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/queued-pipeline

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

CodeArts project ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

pipeline_id

Yes

String

Parameter description:

Pipeline ID.

Constraints:

N/A.

Value Range:

The value contains 32 characters.

Default value:

N/A.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Long

Offset.

limit

Yes

Long

Number of records on each page.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

offset

Integer

Offset.

limit

Integer

Number of records on each page.

total

Integer

Total number.

queuedPipelines

Array of queuedPipelines objects

Queuing record list.

Table 4 queuedPipelines

Parameter

Type

Description

id

Integer

Queuing record ID.

pipeline_id

String

Pipeline ID.

pipeline_run_id

String

Pipeline run ID.

region

String

Region.

enqueue_time

Integer

Enqueuing time.

trigger_type

String

Trigger type.

creator_id

String

ID of the trigger person.

creator_name

String

Name of the trigger person.

status

String

Queuing status.

Example Requests

GET https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/c173d99dbbb54626b64cf5694c0a4e8e/queued-pipeline?offset=0&limit=10

Example Responses

Status code: 200

Response body.

{
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "queuedPipelines" : [ {
    "id" : 136,
    "pipeline_id" : "c173d99dbbb54626b64cf5694c0a4e8e",
    "pipeline_run_id" : "b5c22bc545144ea7bf761191821c8b36",
    "region" : null,
    "enqueue_time" : 1718951334000,
    "trigger_type" : "Manual",
    "creator_id" : "123456",
    "creator_name" : "123-5",
    "status" : "QUEUED"
  } ]
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.