文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 模板管理/ 查询模板详情
更新时间：2025-08-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询模板详情

功能介绍

查询模板详情

调用方法

请参见如何调用API。

URI

GET /v5/{tenant_id}/api/pipeline-templates/{template_id}

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

是

String

参数解释：

租户ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

template_id

是

String

参数解释：

模板ID，模板的唯一标识，通过查询模板列表接口获取，templates.id即为模板ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释：

模板ID。

取值范围：

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

name

String

参数解释：

模板名称。

取值范围：

不涉及。

icon

String

参数解释：

模板图标。

取值范围：

不涉及。

manifest_version

String

参数解释：

版本。

取值范围：

默认3.0。

language

String

参数解释：

模板语言。

取值范围：

  • java。

  • python。

  • nodejs。

  • go。

  • net。

  • cpp。

  • php。

  • other。

  • none。

description

String

参数解释：

模板描述。

取值范围：

不涉及。

is_system

Boolean

参数解释：

是否系统模板。

取值范围：

  • true：是系统模板。

  • false：不是系统模板。

region

String

参数解释：

模板局点。

取值范围：

不涉及。

domain_id

String

参数解释：

模板所属租户ID。

取值范围：

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

variables

Array of CustomVariable objects

参数解释：

自定义参数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

creator_id

String

参数解释：

模板创建人ID。

取值范围：

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

updater_id

String

参数解释：

模板更新人ID。

取值范围：

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

create_time

Integer

参数解释：

创建时间。

取值范围：

不涉及。

update_time

Integer

参数解释：

更新时间。

取值范围：

不涉及。

is_collect

String

参数解释：

是否收藏。

取值范围：

  • true：收藏。

  • false：不收藏。

is_show_source

Boolean

参数解释：

是否展示流水线源。

取值范围：

  • true：展示流水线源。

  • false：不展示流水线源。

definition

String

参数解释：

模板编排json，包含stages。

取值范围：

不涉及。
表3 CustomVariable

参数

参数类型

描述

pipeline_id

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

name

String

参数解释：

自定义参数名称。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

sequence

Integer

参数解释：

参数序号，从1开始。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

String

参数解释：

自定义参数类型。

约束限制：

不涉及。

取值范围：

  • autoIncrement：自增长参数。

  • enum：枚举参数。

  • string：字符串参数。

默认取值：

不涉及。

value

String

参数解释：

自定义参数默认值。

约束限制：

不涉及。

取值范围：

最长8192字符。

默认取值：

不涉及。

is_secret

Boolean

参数解释：

是否私密参数。

约束限制：

不涉及。

取值范围：

  • true：是私密参数。

  • false：不是私密参数。

默认取值：

false。

description

String

参数解释：

参数描述。

约束限制：

不涉及。

取值范围：

最长1024字符。

默认取值：

不涉及。

is_runtime

Boolean

参数解释：

是否运行时设置参数。

约束限制：

不涉及。

取值范围：

  • true：是运行时设置参数。

  • false：不是运行时设置参数。

默认取值：

false。

limits

Array of objects

参数解释：

枚举值列表。

约束限制：

不涉及。

取值范围：

每个枚举值不超过1024字符。

默认取值：

不涉及。

is_reset

Boolean

参数解释：

是否重置。自增长参数被编辑，则使用编辑后的值，否则进行末位数字递增。

约束限制：

不涉及。

取值范围：

  • true：使用编辑后的参数值。

  • false：使用自增长参数。

默认取值：

false。

latest_value

String

参数解释：

最近一次运行的参数值。

约束限制：

不涉及。

取值范围：

最长8192字符。

默认取值：

不涉及。

runtime_value

String

参数解释：

流水线运行时设置参数的传入值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

查询流水线模板详情

GET https://{endpoint}/v5/a5f63758220947b7821e70ae2734c01d/api/pipeline-templates/deb18013bb6c4659b160b15fd7468644

响应示例

状态码：200

OK

{
  "id" : "deb18013bb6c4659b160b15fd7468644",
  "name" : "新建流水线模板-20230112115711",
  "icon" : null,
  "manifest_version" : "3.0",
  "language" : "none",
  "description" : "",
  "is_system" : false,
  "region" : "{region}",
  "domain_id" : "70ffec613024477bbaf266128bd9778d",
  "variables" : [ ],
  "creator_id" : "5ffd41c9df9d4506862ce27e209bb106",
  "updater_id" : "5ffd41c9df9d4506862ce27e209bb106",
  "create_time" : 1673495851000,
  "update_time" : 1673495851000,
  "is_collect" : null,
  "is_show_source" : true,
  "definition" : "{\"stages\":[{\"name\":\"阶段_1\",\"sequence\":\"0\",\"jobs\":[{\"stage_id\":1673495831907,\"identifier\":\"16734958501367554c26c-561b-4831-a906-e88316c8e674\",\"name\":\"新建任务\",\"depends_on\":[],\"timeout\":\"\",\"timeout_unit\":\"\",\"steps\":[],\"exec_type\":\"AGENTLESS_JOB\",\"sequence\":0}],\"identifier\":\"0\",\"pre\":[{\"task\":\"official_devcloud_autoTrigger\",\"sequence\":0}],\"post\":null,\"depends_on\":[],\"run_always\":false}]}"
}

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 模板管理

相关文档