Help Center> CodeArts Pipeline> API Reference> API> Pipeline Management> Obtaining the Pipeline Status/Obtaining Pipeline Execution Details

Updated on 2023-12-08 GMT+08:00

View PDF

Obtaining the Pipeline Status/Obtaining Pipeline Execution Details

Function

This interface is used to obtain the pipeline status or pipeline execution details. Only the pipeline data with execution records is returned.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
pipeline_id	Yes	String	Pipeline ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
pipeline_run_id	No	String	Pipeline running instance ID

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Pipeline running instance ID
pipeline_id	String	Pipeline ID
manifest_version	String	Pipeline version.
name	String	Pipeline name
description	String	Running Description
is_publish	Boolean	Indicates whether the pipeline is a change pipeline.
executor_id	String	Operator ID
executor_name	String	Operator Name
status	String	Status
trigger_type	String	Trigger Type
run_number	Integer	Running No.
start_time	Long	Start time
end_time	Long	End time.
stages	Array of StageRun objects	Phase information.
domain_id	String	TenantID
project_id	String	Project ID
region	String	Site
component_id	String	Component ID
language	String	Language.
sources	Array of RunPipelineSource objects	Running Source Information
artifacts	Array of PackageInfo objects	Pipeline Running Product
subject_id	String	Pipeline running instance ID
group_id	String	Group ID
group_name	String	Name
detail_url	String	Details Page Address
current_system_time	String	Specifies the current system time.

**Table 5** StageRun
Parameter	Type	Description
id	String	Phase ID
category	String	Type
name	String	Phase Name
identifier	String	Unique ID
run_always	Boolean	Whether to always run
parallel	String	Parallel or not.
is_select	Boolean	Selected or Not
sequence	Integer	SN
depends_on	Array of strings	Dependencies
condition	String	Operating Conditions
status	String	Status
start_time	Long	Start time
end_time	Long	End Time
pre	Array of StepRun objects	Phased Admission
post	Array of StepRun objects	Phase Exit
jobs	Array of JobRun objects	Task

**Table 6** JobRun
Parameter	Type	Description
id	String	Task ID
category	String	Task Type
sequence	Integer	SN
async	String	Asynchronous or Not
name	String	Task
identifier	String	Identifies a task.
depends_on	Array of strings	Depend
condition	String	Operating Conditions
resource	String	Execution Resource
is_select	Boolean	Selected or Not
timeout	String	Task Timeout Settings
last_dispatch_id	String	ID of the task delivered last time.
status	String	Status
message	String	Error Message
start_time	Long	Start time
end_time	Long	End Time
steps	Array of StepRun objects	Procedure
exec_id	String	Task execution ID.

**Table 7** StepRun
Parameter	Type	Description
name	String	Operation
task	String	Step Plug-in
business_type	String	Plug-in Service Type
inputs	Array of inputs objects	Input parameter
sequence	Integer	SN
official_task_version	String	Official Plug-in Version
identifier	String	A unique identifier
multi_step_editable	Integer	Whether the pipeline is editable
id	String	Step ID
endpoint_ids	String	Extension Points
last_dispatch_id	String	ID of the last delivery task.
status	String	Status
message	String	Error Message
start_time	Long	Start time
end_time	Long	End Time

**Table 8** inputs
Parameter	Type	Description
key	String	Input parameter name.
value	Object	Input parameter value.

**Table 9** RunPipelineSource
Parameter	Type	Description
type	String	Source Type
params	params object	Source Parameter

**Table 10** params
Parameter	Type	Description
git_type	String	Code Repository Type
git_url	String	HTTPS address of the code repository
ssh_git_url	String	SSH address of the code repository
web_url	String	Code Repository Page Address
repo_name	String	Code Repository Name
default_branch	String	Default Branch
endpoint_id	String	Extension Point ID
codehub_id	String	Repo code repository ID
alias	String	Code Repository Alias
build_params	build_params object	Image build parameters

**Table 11** build_params
Parameter	Type	Description
action	String	Combination Request Event Type
build_type	String	Branch-based or Tag-based Running
commit_id	String	Code Repository Submission ID
event_type	String	Running Event Type
merge_id	String	Combination Request ID
message	String	Code Repository Submission Information
source_branch	String	Source Branch
tag	String	Label
target_branch	String	Target Branch
codehub_id	String	Repo code repository ID
source_codehub_id	String	Source Repo Code Repository ID
source_codehub_url	String	Source Repo Code Repository Address
source_codehub_http_url	String	HTTP address of the source Repo code repository

**Table 12** PackageInfo
Parameter	Type	Description
name	String	Product Name
packageType	String	Product Type
version	String	Product Version
downloadUrl	String	Product Download Address

Example Requests

GET https://{endpoint}/v5/54f90b75fc1447b1b65e8d3a9f77923d/api/pipelines/e5460d1d403146a1935c2d4b68ef506c/pipeline-runs/detail

Example Responses

Status code: 200

{
  "id" : "25adfa6784124cfc9b9274ceaecf9957",
  "pipeline_id" : "98b6ea1536374df883bcc3b129bca4e9",
  "manifest_version" : "3.0",
  "name" : "Sub-pipeline qqq",
  "description" : null,
  "is_publish" : false,
  "executor_id" : "847a5317086c41798469d0868535943a",
  "executor_name" : "Beta environment account",
  "status" : "COMPLETED",
  "trigger_type" : "Manual",
  "run_number" : 1,
  "start_time" : 1674207197000,
  "end_time" : 1674207197000,
  "stages" : [ {
    "id" : "aac8063fbf084eec9722c77ece6dd283",
    "category" : null,
    "name" : "Phase_1",
    "identifier" : "0",
    "run_always" : false,
    "parallel" : null,
    "is_select" : true,
    "sequence" : 0,
    "depends_on" : [ ],
    "condition" : null,
    "status" : "COMPLETED",
    "start_time" : 1674207197000,
    "end_time" : 1674207197000,
    "pre" : [ {
      "name" : null,
      "task" : "official_devcloud_autoTrigger",
      "business_type" : null,
      "inputs" : null,
      "sequence" : 0,
      "official_task_version" : null,
      "identifier" : null,
      "multi_step_editable" : 0,
      "id" : "5a03bdb6ad2848ac972ba21744627a8c",
      "endpoint_ids" : null,
      "last_dispatch_id" : "6b3fa4c664844f33abc02053ddd76f62",
      "status" : "COMPLETED",
      "message" : null,
      "start_time" : 1674207197000,
      "end_time" : 1674207197000
    } ],
    "post" : [ ],
    "jobs" : [ {
      "id" : "1cde6a3815164cd18d0fa4038f876e46",
      "category" : null,
      "sequence" : 0,
      "async" : null,
      "name" : "Creating a Task",
      "identifier" : "1674207161661b4a41d77-a478-4538-870b-ffb589c1af06",
      "depends_on" : [ ],
      "condition" : null,
      "resource" : null,
      "is_select" : true,
      "timeout" : "",
      "last_dispatch_id" : null,
      "status" : "COMPLETED",
      "message" : "not found steps",
      "start_time" : 1674207197000,
      "end_time" : 1674207197000,
      "steps" : [ ]
    } ]
  } ],
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "6428c2e2b4b64affa14ec80896695c49",
  "region" : "region01",
  "component_id" : "",
  "language" : "zh-cn",
  "sources" : [ {
    "type" : "code",
    "params" : {
      "git_type" : "codehub",
      "git_url" : "https://example.com/clsyz00001/aaaaa.git",
      "ssh_git_url" : "git@example.com:clsyz00001/aaaaa.git",
      "web_url" : "",
      "repo_name" : "aaaaa",
      "default_branch" : "master",
      "endpoint_id" : "",
      "codehub_id" : "2111677704",
      "alias" : "",
      "build_params" : {
        "action" : null,
        "build_type" : "branch",
        "commit_id" : "990ea057751d299f5575aac25bf97e88a60b461e",
        "event_type" : "Manual",
        "merge_id" : null,
        "message" : "Creating a Dockerfile",
        "source_branch" : null,
        "tag" : null,
        "target_branch" : "master",
        "codehub_id" : "2111677704"
      }
    }
  } ],
  "artifacts" : null,
  "subject_id" : "25adfa6784124cfc9b9274ceaecf9957"
}