更新时间:2025-08-19 GMT+08:00
分享

查询流水线详情

功能介绍

查询流水线详情

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

pipeline_id

String

参数解释

流水线ID,可以通过查询流水线列表接口获取,其中pipelines.pipelineId即为流水线ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

流水线ID,可以通过查询流水线列表接口,其中pipelines.pipelineId即为流水线ID。

取值范围

32位字符,仅由数字和字母组成。

name

String

参数解释

流水线名称。

取值范围

仅包含中文、大小写英文字母、数字、'-'和'_',且长度为[1,128]个字符。

description

String

参数解释

对流水线的补充描述。

取值范围

不超过1024字符。

manifest_version

String

参数解释

流水线版本,默认为3.0。

取值范围

不涉及。

region

String

参数解释

当前环境所属局点。

取值范围

不涉及。

domain_id

String

参数解释

所属租户ID。

取值范围

32位字符,仅由数字和字母组成。

project_id

String

参数解释

项目ID。

取值范围

32位字符,仅由数字和字母组成。

component_id

String

参数解释

所属微服务ID。可以通过查询微服务列表接口获取,其中data.id即为微服务ID。

取值范围

不涉及。

is_publish

Boolean

参数解释

是否为变更流水线。

取值范围

  • true:是变更流水线。

  • false:不是变更流水线。

creator_id

String

参数解释

流水线创建人ID。

取值范围

32位字符,仅由数字和字母组成。

creator_name

String

参数解释

流水线创建人名称。

取值范围

不涉及。

updater_id

String

参数解释

流水线上次更新人ID。

取值范围

32位字符,仅由数字和字母组成。

create_time

Long

参数解释

流水线创建时间。

取值范围

不涉及。

update_time

Long

参数解释

流水线更新时间。

取值范围

不涉及。

is_collect

Boolean

参数解释

流水线是否被当前用户收藏。

取值范围

  • true:流水线已被收藏。

  • false:流水线未被收藏。

sources

Array of PipelineSource objects

参数解释

流水线源列表。

取值范围

不涉及。

variables

Array of PipelineVariable objects

参数解释

流水线自定义参数。

取值范围

不涉及。

schedules

Array of PipelineSchedule objects

参数解释

流水线定时任务设置。

取值范围

不涉及。

triggers

Array of PipelineTrigger objects

参数解释

流水线事件触发设置。

取值范围

不涉及。

group_id

String

参数解释

流水线所属分组ID。

取值范围

不涉及。

definition

String

参数解释

流水线定义JSON。

取值范围

不涉及。

表4 PipelineSource

参数

参数类型

描述

type

String

参数解释

流水线源类型。

取值范围

不涉及。

params

PipelineSourceParam object

参数解释

流水线源参数。

取值范围

不涉及。

表5 PipelineSourceParam

参数

参数类型

描述

alias

String

参数解释

代码/制品源参数 - 代码仓/制品源别名。

取值范围

别名仅支持输入大小写英文字母、数字、“_”,至多128个字符。

git_type

String

参数解释

git代码仓类型。

取值范围

  • codehub。

  • gitee。

  • github。

  • gitcode。

  • gitlab。

codehub_id

String

参数解释

Repo代码仓ID。

取值范围

不涉及。

endpoint_id

String

参数解释

扩展点id。

取值范围

不涉及。

default_branch

String

参数解释

默认分支。

取值范围

不涉及。

git_url

String

参数解释

git链接。

取值范围

不涉及。

ssh_git_url

String

参数解释

ssh_git链接。

取值范围

不涉及。

web_url

String

参数解释

网页url。

取值范围

不涉及。

repo_name

String

参数解释

流水线源名称。

取值范围

不涉及。

artifact_type

String

参数解释

制品源类型。

取值范围

仅包含[generic,docker]。

artifact_type_name

String

参数解释

制品源类型名。

取值范围

不涉及。

branch_filter

String

参数解释

过滤分支。

取值范围

不涉及。

directory

String

参数解释

制品源所在目录。

取值范围

不涉及。

directory_id

String

参数解释

目录ID。

取值范围

不涉及。

organization

String

参数解释

Docker组织。

取值范围

不涉及。

package_name

String

参数解释

软件包名称。

取值范围

不涉及。

version

String

参数解释

制品源版本。

取值范围

不涉及。

version_strategy

String

参数解释

获取制品源版本的策略。

取值范围

仅包含[latest,specificVersion]。

source_system

String

参数解释

制品源名称。

取值范围

不涉及。

表6 PipelineVariable

参数

参数类型

描述

name

String

参数解释

自定义参数名称。

取值范围

仅支持大小写英文字母、数字、“_”,不超过128个字符。

sequence

Integer

参数解释

序号。

取值范围

[1, 2147483647]。

type

String

参数解释

自定义参数的类型。

取值范围

不涉及。

value

String

参数解释

自定义参数的默认值。

取值范围

不涉及。

is_secret

Boolean

参数解释

是否为私密参数。

取值范围

  • true:是私密参数。

  • false:不是私密参数。

description

String

参数解释

自定义参数描述。

取值范围

不涉及。

is_runtime

Boolean

参数解释

是否运行时设置。

取值范围

  • true:运行时设置。

  • false:非运行时设置。

limits

Array of strings

参数解释

限定枚举值列表。

取值范围

不涉及。

is_reset

Boolean

参数解释

自增长参数是否被重置。

取值范围

  • true:被重置。

  • false:不被重置。

latest_value

String

参数解释

自增长参数最新值。

取值范围

不涉及。

表7 PipelineSchedule

参数

参数类型

描述

uuid

String

参数解释

定时任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

type

String

参数解释

任务类型。

约束限制

不涉及。

取值范围

只支持fixed。

默认取值

不涉及。

name

String

参数解释

任务名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

enable

String

参数解释

是否启用。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

days_of_week

Array of integers

参数解释

一周内具体执行日。周日至周六对应1-7。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

time_zone

String

参数解释

时区。

约束限制

不涉及。

取值范围

  • "China Standard Time"。

  • "GMT Standard Time"。

  • "South Africa Standard Time"。

  • "Russian Standard Time"。

  • "SE Asia Standard Time"。

  • "Singapore Standard Time"。

  • "Pacific SA Standard Time"。

  • "E. South America Standard Time"。

  • "Central Standard Time (Mexico)"。

  • "Egypt Standard Time"。

  • "Saudi Arabia Standard Time"。

默认取值

不涉及。

表8 PipelineTrigger

参数

参数类型

描述

pipeline_id

String

参数解释

流水线ID,可以通过查询流水线列表接口,其中pipelines.pipelineId即为流水线ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

git_url

String

参数解释

代码仓git链接。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

git_type

String

参数解释

git代码仓类型。

约束限制

不涉及。

取值范围

  • codehub。

  • gitee。

  • github。

  • gitcode。

  • gitlab。

默认取值

不涉及。

is_auto_commit

Boolean

参数解释

是否自动提交。gitee仓库特有,webhook触发流水线后,自动添加评论。

约束限制

不涉及。

取值范围

  • true:是自动提交。

  • false:不是自动提交。

默认取值

不涉及。

events

Array of CodeEvent objects

参数解释

触发事件列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

hook_id

String

参数解释

系统生成的回调ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

repo_id

String

参数解释

Repo仓库ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

endpoint_id

String

参数解释

代码源扩展点ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

callback_url

String

参数解释

回调链接,注册Webhook时生成。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

security_token

String

参数解释

用户token,注册Webhook时生成。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表9 CodeEvent

参数

参数类型

描述

type

String

参数解释

事件类型。

约束限制

不涉及。

取值范围

  • merge_request:MR 触发。

  • push:代码Push触发。

  • tag_push:标签触发。

  • issue:Gitee仓库ISSUE触发。

  • note:Gitee仓库评论触发。

默认取值

不涉及。

enable

Boolean

参数解释

代码仓是否可用。

约束限制

不涉及。

取值范围

  • true:代码仓可用。

  • false:代码仓不可用。

默认取值

不涉及。

请求示例

GET https://{endpoint}/v5/6428c2e2b4b64affa14ec80896695c49/api/pipelines/633839ac12a2465ba86dfc5cd212ee1a

响应示例

状态码:200

OK

{
  "id" : "9777b6f14dca47ab8e411512b8301698",
  "name" : "新建流水线-20230222110358",
  "description" : "",
  "manifest_version" : "3.0",
  "region" : "{region}",
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "project_id" : "f83ef803e04e4fe8834ddaf18ffd9d8f",
  "component_id" : "",
  "is_publish" : false,
  "creator_id" : "847a5317086c41798469d0868535943a",
  "creator_name" : "beta环境账号",
  "updater_id" : "847a5317086c41798469d0868535943a",
  "create_time" : 1676116509000,
  "update_time" : 1690785914000,
  "is_collect" : true,
  "sources" : [ ],
  "variables" : [ ],
  "schedules" : [ {
    "uuid" : "38e10252a4ea48c594f744bb4fc1411c",
    "type" : "fixed",
    "name" : "定时任务_1",
    "enable" : true,
    "days_of_week" : [ 2, 3, 4, 5, 6 ],
    "time_zone" : "China Standard Time"
  } ],
  "triggers" : [ ],
  "group_id" : null,
  "definition" : "{\"stages\":[{\"name\":\"阶段_1\",\"sequence\":\"0\",\"jobs\":[{\"id\":\"\",\"stage_id\":1677035050256,\"identifier\":\"167703505025720bcc960-2929-457f-91e5-9099556cc478\",\"name\":\"延时执行\",\"depends_on\":[],\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[{\"name\":\"延时执行\",\"task\":\"official_devcloud_delay\",\"sequence\":0,\"inputs\":[{\"key\":\"timer_type\",\"value\":\"delay\"},{\"key\":\"delay_time\",\"value\":10},{\"key\":\"scheduled_time\",\"value\":\"\"},{\"key\":\"time_zone\",\"value\":\"China Standard Time\"}],\"business_type\":\"Normal\",\"runtime_attribution\":\"agentless\",\"identifier\":\"1677035056887f508df54-eff9-4f47-b67d-0629917599e9\",\"multi_step_editable\":0,\"official_task_version\":\"0.0.3\"}],\"exec_type\":\"AGENTLESS_JOB\",\"sequence\":0,\"pipeline_id\":\"62bc8c36ab1a4ef9831df98e88c33c69\"}],\"identifier\":\"0\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false,\"pipeline_id\":\"62bc8c36ab1a4ef9831df98e88c33c69\"}]}"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion;
import com.huaweicloud.sdk.codeartspipeline.v2.*;
import com.huaweicloud.sdk.codeartspipeline.v2.model.*;


public class ShowPipelineDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowPipelineDetailRequest request = new ShowPipelineDetailRequest();
        request.withProjectId("{project_id}");
        request.withPipelineId("{pipeline_id}");
        try {
            ShowPipelineDetailResponse response = client.showPipelineDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartspipeline.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsPipelineClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowPipelineDetailRequest()
        request.project_id = "{project_id}"
        request.pipeline_id = "{pipeline_id}"
        response = client.show_pipeline_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowPipelineDetailRequest{}
	request.ProjectId = "{project_id}"
	request.PipelineId = "{pipeline_id}"
	response, err := client.ShowPipelineDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档