更新时间:2024-06-14 GMT+08:00

查询流水线详情

功能介绍

查询流水线详情

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

pipeline_id

String

流水线ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

流水线ID

name

String

流水线名称

description

String

描述

manifest_version

String

流水线版本

region

String

局点

domain_id

String

所属租户ID

project_id

String

所属项目ID

component_id

String

所属微服务ID

is_publish

Boolean

是否为变更流水线

creator_id

String

创建人ID

creator_name

String

创建人名称

updater_id

String

更新人ID

create_time

Long

更新人名称

update_time

Long

更新时间

is_collect

Boolean

是否被当前用户收藏

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

流水线定义

表4 PipelineSource

参数

参数类型

描述

type

String

流水线源类型

params

PipelineSourceParam object

流水线源参数

表5 PipelineSourceParam

参数

参数类型

描述

alias

String

代码/制品源参数 - 代码仓/制品源别名。别名仅支持输入大小写英文字母、数字、“_”,至多128个字符

git_type

String

代码源参数 - git类型

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

制品源参数 - 制品源名称,如CloudArtifact

表6 PipelineVariable

参数

参数类型

描述

name

String

参数名称

sequence

Integer

序号

type

String

类型

value

String

默认值

is_secret

Boolean

是否私密

description

String

描述

is_runtime

Boolean

是否运行时设置

limits

Array of strings

限定枚举值

is_reset

Boolean

自增长参数是否被重置

latest_value

String

自增长参数最新值

表7 PipelineSchedule

参数

参数类型

描述

uuid

String

任务ID

type

String

任务类型

name

String

任务名称

enable

String

是否可用

days_of_week

Array of integers

一周内具体时间

time_zone

String

时区

表8 PipelineTrigger

参数

参数类型

描述

pipeline_id

String

流水线ID

git_url

String

git链接

git_type

String

git类型

is_auto_commit

Boolean

是否自动提交

events

Array of CodeEvent objects

事件

hook_id

String

回调id

repo_id

String

仓库id

endpoint_id

String

扩展点id

callback_url

String

回调链接

security_token

String

用户token

表9 CodeEvent

参数

参数类型

描述

type

String

事件类型

enable

Boolean

是否可用

请求示例

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
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();
        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
# 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()
        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
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{}
	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

错误码

请参见错误码