Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying the Running Changes in a Pipeline

Updated on 2025-09-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Running Changes in a Pipeline

Function

This API is used to query the running changes in a pipeline.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/query-change-requests

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
pipelineRunId	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
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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
component_id	No	String	Definition: Pipeline microservice ID. Obtain the ID by calling the API for querying microservices. data.id indicates the microservice 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 3** Response body parameters
Parameter	Type	Description
[items]	Array of QueryPipelineRunChangeRequestsResp objects	Definition: Response body details. Value range: N/A

**Table 4** QueryPipelineRunChangeRequestsResp
Parameter	Type	Description
id	String	Definition: Change ID. Value range: The value consists of 32 characters, including digits and letters.
component_id	String	Definition: Microservice ID. Value range: The value consists of 32 characters, including digits and letters.
status	String	Definition: Change status. Value range: N/A
title	String	Definition: Change title. Value range: N/A
creator_id	String	Definition: Change creator ID. Value range: The value consists of 32 characters, including digits and letters.
creator_name	String	Definition: Change creator name. Value range: N/A
create_time	String	Definition: Time when the change was created. Value range: N/A
repos	Array of strings	Definition: Code repository associated with the change. Value range: N/A

Example Requests

GET http://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/771d3f5473404676872467e230289ebe/pipeline-runs/76711eae71644c38a235b77365d57845/query-change-requests?component_id=c1de96a98c084a0b8631f9e6ac8967b0

Example Responses

Status code: 200

[ {
  "id" : "211847a825754f2eadfa326c77fd4e9e",
  "component_id" : "c1de96a98c084a0b8631f9e6ac8967b0",
  "status" : "revoked",
  "title" : "0328",
  "creator_id" : "05d8ca972f114765a8984795a8aa4d41",
  "creator_name" : "123",
  "create_time" : "1711613423",
  "repos" : [ ]
} ]