文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 模板管理/ 获取流水线模板列表 - PipelineTemplatesList
更新时间:2026-09-18 GMT+08:00

获取流水线模板列表 - PipelineTemplatesList

功能介绍

获取流水线模板列表接口

调用方法

请参见如何调用API。

URI

POST /v3/pipeline/templates/list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

否

String

参数解释:

语言类型。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文。

  • en-us:英文。

默认取值:

en-us。

表2 请求Body参数

参数

是否必选

参数类型

描述

is_system

否

Boolean

参数解释:

是否系统模板。

约束限制:

不涉及。

取值范围:

  • true:是系统模板

  • false:不是系统模板。

默认取值:

不涉及。

template_name

否

String

参数解释:

模板名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

offset

否

Long

参数解释:

偏移量,表示从此偏移量开始查询。

约束限制:

不涉及。

取值范围:

offset大于等于0。

默认取值:

默认为0。

limit

否

Long

参数解释:

每次查询的条目数量。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

默认为10。

sort_key

否

String

参数解释:

用于排序的字段,非必选。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

sort_dir

否

String

参数解释:

排序类型,非必选。

约束限制:

不涉及。

取值范围:

  • asc:按排序字段升序。

  • desc:按排序字段降序

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

offset

Integer

参数解释:

起始偏移。

取值范围:

offset大于等于0。

limit

Integer

参数解释:

查询大小。

取值范围:

不涉及。

total

Integer

参数解释:

记录总数。

取值范围:

不涉及。

result

Array of PipelineTemplateSimpleVO objects

参数解释:

流水线模板列表,包含流水线模板的详细信息。

取值范围:

不涉及。

表4 PipelineTemplateSimpleVO

参数

参数类型

描述

watched

Boolean

参数解释:

模板对用户是否可见。

取值范围:

  • true:模板对用户可见。

  • false:模板对用户不可见。

id

String

参数解释:

模板ID。

取值范围:

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

name

String

参数解释:

模板名称。

取值范围:

不涉及。

user_id

String

参数解释:

流水线模板创建者用户id。

取值范围:

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

user_name

String

参数解释:

流水线模板创建者用户名。

取值范围:

不涉及。

icon

String

参数解释:

模板图标。

取值范围:

不涉及。

manifest_version

String

参数解释:

版本。

取值范围:

默认3.0。

language

String

参数解释:

模板语言。

取值范围:

  • java。

  • python。

  • nodejs。

  • go。

  • net。

  • cpp。

  • php。

  • arkts。

  • other。

  • none。

description

String

参数解释:

模板描述。

取值范围:

不涉及。

is_system

Integer

参数解释:

是否系统模板。

取值范围:

  • 0:不是系统模板。

  • 1:是系统模板。

region

String

参数解释:

模板局点。

取值范围:

不涉及。

domain_id

String

参数解释:

模板所属租户ID,用户的domainId。

取值范围:

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

domain_name

String

参数解释:

流水线模板创建者租户名。

取值范围:

不涉及。

creator_id

String

参数解释:

模板创建人ID。

取值范围:

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

creator_name

String

参数解释:

模板创建人名称。

取值范围:

不涉及。

updater_id

String

参数解释:

模板更新人ID。

取值范围:

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

create_time

String

参数解释:

创建时间。

取值范围:

不涉及。

modify_time

String

参数解释:

更新时间。

取值范围:

不涉及。

is_collect

Boolean

参数解释:

是否收藏。

取值范围:

  • true:收藏。

  • false:不收藏。

is_show_source

Boolean

参数解释:

是否展示流水线源。

取值范围:

  • true:展示流水线源。

  • false:不展示流水线源。

stages

Array of stages objects

参数解释:

模板编排的阶段列表。

表5 stages

参数

参数类型

描述

name

String

参数解释:

阶段名称。

取值范围:

仅支持输入中文、大小写英文字母、数字、'-'、'_'、','、';'、':'、'.'、'/'、'('、')'、'('、')'及空格,其中空格不可在名称开头或结尾使用,且长度为[1,128]个字符。

sequence

Integer

参数解释:

阶段顺序。

取值范围:

大于等于0。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

请求示例

POST https://{endpoint}/v3/pipeline/templates/list

{
  "template_name" : "1",
  "is_system" : "true",
  "sort_key" : "template_name",
  "sort_dir" : "asc",
  "offset" : 1,
  "limit" : 20
}

响应示例

状态码:200

{
  "offset" : 10,
  "limit" : 2,
  "total" : 423,
  "result" : [ {
    "watched" : true,
    "icon" : "pure-tomato",
    "id" : "ed3a99ae76b346818d6b2d09422d166d",
    "name" : "template-20221201154239",
    "user_id" : "847a5317086c41798469d0868535943a",
    "user_name" : "beta环境账号",
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "domain_name" : "devcloud_devcloud_h00485561_01",
    "description" : "",
    "create_time" : "2022-12-01 15:43:00",
    "modify_time" : "2024-04-15 16:51:31",
    "is_system" : 0
  }, {
    "watched" : true,
    "icon" : "pure-mint",
    "id" : "8f5ed64c74464866b771d9c982648efb",
    "name" : "testttttt",
    "user_id" : "fbee1146498c465d851c1b8dd2a253c6",
    "user_name" : null,
    "domain_id" : "ce8df55870164338a72d7e828a966a2a",
    "domain_name" : "devcloud_devcloud_h00485561_01",
    "description" : "",
    "create_time" : "2022-12-01 09:04:56",
    "modify_time" : "2022-12-01 09:04:56",
    "is_system" : 0
  } ]
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。