Obtaining Pipeline Details
Function
This API is used to obtain pipeline execution details.
Calling Method
For details, see Calling APIs.
URI
GET /v3/pipelines/{pipeline_id}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 only digits and letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
build_id |
No |
String |
Definition: Pipeline execution ID. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
X-Language |
No |
String |
Definition: Language type. Constraints: N/A Value range:
Default value: en-us. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
workflow |
PipelineWorkflowDetail object |
Pipeline workflow details. |
states |
Array of PipelineStateDetail objects |
Pipeline basic information. |
Parameter |
Type |
Description |
---|---|---|
pipeline_id |
String |
Pipeline ID. |
pipeline_name |
String |
Pipeline name. |
project_id |
String |
ID of the project to which the pipeline belongs. |
project_name |
String |
Name of the project to which the pipeline belongs. |
build_id |
String |
Pipeline execution ID. |
status |
String |
Pipeline status. The value can be waiting, running, verifying, suspending, or completed. |
outcome |
String |
Pipeline execution result. The value can be success, error, or aborted. |
start_time |
String |
Execution start time. |
end_time |
String |
Execution end time. |
elapsed_time |
String |
Execution duration, in milliseconds. |
execute_type |
String |
Triggering mode. The options are as follows: MR: triggered by an MR event; Push: triggered by code commit; CreateTag: triggered by tag creation; Issue: triggered by a repository issue event; Note: triggered by a repository note event; Manual: manually triggered; Scheduler: triggered by a scheduled task; RollBack: rollback execution; Unsuspended: suspension cancellation. |
executor_id |
String |
Executor ID. |
executor |
String |
Executor. |
detail_url |
String |
URL of the pipeline details. |
parameters |
Array of PipelineParameterDetail objects |
Pipeline parameters. |
source |
Array of PipelineSourceDetail objects |
Source code information. |
artifact_sources |
Array of PipelineArtifactDetail objects |
Artifact source information. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Parameter name. |
value |
String |
Parameter value. |
type |
String |
Parameter type. The value can be text, enum, autoGrowth, or hostGroup. |
is_system |
Boolean |
Whether it is a system parameter. |
is_runtime |
Boolean |
Whether to enable the runtime setting. |
is_secret |
Boolean |
Whether it is a private parameter. |
Parameter |
Type |
Description |
---|---|---|
scm_type |
String |
Repository type. The value can be Repo, Gitee, GitHub, or general_Git. |
endpoint_id |
String |
Code source endpoint. |
repo_id |
String |
Code repository ID. |
repo_name |
String |
Code repository name. |
repo_owner |
String |
Owner. |
display_name |
String |
Name of the code repository. |
git_url |
String |
Code repository address. |
default_branch |
String |
Default branch. |
build_params |
Build parameter details. |
Parameter |
Type |
Description |
---|---|---|
tag |
String |
Build tag. |
commit_id |
String |
Build commit ID. |
event_type |
String |
Triggering mode. The options are as follows: MR: triggered by an MR event; Push: triggered by code commit; CreateTag: triggered by tag creation; Issue: triggered by a repository issue event; Note: triggered by a repository note event; Manual: manually triggered; Scheduler: triggered by a scheduled task; RollBack: rollback execution; Unsuspended: suspension cancellation. |
build_type |
String |
Code repository build type. The value can be branch or tag. |
message |
String |
Information about the execution in the code repository. |
action |
String |
action |
merge_id |
String |
merge_id |
source_branch |
String |
Source branch. If the execution is not triggered by an MR, the value is null. |
target_branch |
String |
Target branch. If the execution is not triggered by an MR, the value is the branch selected for this execution. |
Parameter |
Type |
Description |
---|---|---|
source_system |
String |
Pipeline source type. The value is CloudArtifact, indicating the artifact source. |
artifact_type |
String |
Artifact source type. The options can be generic(software release repo), docker (Docker repository). |
artifact_type_name |
String |
Artifact source name. |
alias |
String |
Deployment source alias. |
properties |
Object |
Deployment source configuration. |
build_params |
Build parameters of the artifact source. |
Parameter |
Type |
Description |
---|---|---|
execute_version |
String |
Artifact source version. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Stage ID. |
name |
String |
Stage name. |
type |
String |
Node type. The value is stage. |
dsl_method |
String |
Stage type, such as initial and source. |
is_manual_execution |
Boolean |
Whether to manually execute. |
start_time |
String |
Execution start time. |
end_time |
String |
Execution end time. |
elapsed_time |
String |
Execution duration, in seconds. |
status |
String |
Execution status. The value can be waiting, running, verifying, suspending, or completed. |
outcome |
String |
Execution result. The value can be success, error, or aborted. |
execution_mode |
String |
Execution mode. The value can be serial or parallel. |
children |
Array of PipelineTaskDetail objects |
Job details. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Job ID. |
name |
String |
Job name. |
type |
String |
Node type, which can be stage or job. |
dsl_method |
String |
Job type. |
start_time |
String |
Execution start time. |
end_time |
String |
Execution end time. |
elapsed_time |
String |
Execution duration, in seconds. |
status |
String |
Execution status. The value can be waiting, running, verifying, suspending, or completed. |
outcome |
String |
Execution result. The value can be success, error, or aborted. |
third_task_id |
String |
Third-party job ID. |
third_task_name |
String |
Third-party job name. |
project_id |
String |
ID of the project to which the job belongs. |
third_task_build_number |
String |
Job build ID. |
third_task_daily_build_number |
String |
Job build ID. This parameter is available only for build jobs. |
detail_url |
String |
Job details link. |
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot