Querying the Pipeline List_Managing Pipelines_Historical APIs_API Reference

Function

This API is used to view the pipeline list.

URI

GET /cpepipeline/v2/pipelines

Request

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Default value: application/json;charset=utf8.
X-Auth-Token	Yes	String	API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Obtaining a User Token Through Password Authentication.

Response

**Table 2** Response parameter
Parameter	Type	Description
[Array elements]	Array of objects	Pipeline list. For details, see Table 3.

**Table 3** pipelines
Parameter	Type	Description
id	String	Pipeline ID.
name	String	Pipeline name.
description	String	Pipeline description.
createdTime	Integer	Pipeline creation time.
updatedTime	Integer	Pipeline update time.
version	Integer	Pipeline version.
configMode	String	Pipeline creation type.
creator	Integer	Pipeline creator.
modelVersion	Integer	Pipeline model version.
status	String	Pipeline status.
lastTriggerAt	Integer	Last pipeline execution time.
enterpriseProjectId	String	Enterprise project ID.
enterpriseProject	String	Enterprise project name.
extendInfo	Object	Extension information. For details, see Table 4.

**Table 4** extendInfo
Parameter	Type	Description
latestPipelineState	Object	Last execution status of the pipeline. For details, see Table 5.

**Table 5** latestPipelineState
Parameter	Type	Description
id	Integer	Pipeline execution ID.
pipelineId	String	Pipeline ID.
version	Integer	Pipeline execution version.
status	Integer	Pipeline execution status.
stageStates	Array of objects	Status of the last execution stage. For details, see Table 6.

**Table 6** stageStates
Parameter	Type	Description
name	String	Stage name.
approvalStatus	Integer	Approval status.
status	Integer	Status.
taskStates	Array of objects	Status of the last task execution. For details, see Table 7.

**Table 7** taskStates
Parameter	Type	Description
name	String	Task name.
displayName	Integer	Display name.
progress	Integer	Execution progress.
status	Integer	Status.
orderIndex	Integer	Execution sequence.

Example Request

None

Example Response

[
    {
        "id": "c4f1a0cb-49d7-4e62-b4d0-a922f638c867",
        "name": "vvasd",
        "description": "",
        "createdTime": 1753083611515,
        "updatedTime": 1753083611515,
        "version": 1,
        "configMode": "ui",
        "creator": "zhangyuhao",
        "modelVersion": 1,
        "status": 1,
        "lastTriggerAt": 0,
        "enterpriseProjectId": "0",
        "enterpriseProject": null,
        "extendInfo": {
            "latestPipelineState": {
                "id": 0,
                "pipelineId": "c4f1a0cb-49d7-4e62-b4d0-a922f638c867",
                "version": 1,
                "status": 1,
                "stageStates": [
                    {
                        "name": "Artifacts",
                        "approvalStatus": 0,
                        "status": 1,
                        "taskStates": [
                            {
                                "name": "ghy-test-comp-0626-3-62e353",
                                "displayName": "Empty",
                                "progress": 0,
                                "status": 1,
                                "orderIndex": 0
                            }
                        ]
                    },
                    {
                        "name": "Environments",
                        "approvalStatus": 0,
                        "status": 1,
                        "taskStates": []
                    }
                ]
            }
        }
    }
]

Status Codes

Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

Error Codes

See ServiceStage Error Codes.

Querying the Pipeline List

Function

URI

Request

Response

Example Request

Example Response

Status Codes

Error Codes

What is your overall rating for this page?