On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

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

Querying the Running Changes in a Pipeline

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

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	Pipeline run
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
component_id	No	String	Microservice ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of QueryPipelineRunChangeRequestsResp objects	Response body.

**Table 4** QueryPipelineRunChangeRequestsResp
Parameter	Type	Description
id	String	Change ID.
component_id	String	Microservice ID.
status	String	Change status.
title	String	Change title.
creator_id	String	Change creator ID.
creator_name	String	Change creator name.
create_time	String	Change creation time.
repos	Array of strings	Code repository associated with the change.

Example Requests

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

Example Responses

Status code: 200

Response body.

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