文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 查询流水线可用的系统参数 - ListPipelineSystemVars
更新时间：2026-09-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询流水线可用的系统参数 - ListPipelineSystemVars

功能介绍

查询流水线可用的系统参数

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-system-vars

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ListPipelineSystemVarsResp objects

参数解释：

响应体详情。

取值范围：

不涉及。
表3 ListPipelineSystemVarsResp

参数

参数类型

描述

name

String

参数解释：

参数名称。

取值范围：

不涉及。

value

String

参数解释：

参数值。

取值范围：

不涉及。

type

String

参数解释：

参数类型。

取值范围：

不涉及。

description

String

参数解释：

参数描述。

取值范围：

不涉及。

isShow

Boolean

参数解释：

是否展示。

取值范围：

  • true：展示。

  • false：不展示。

ordinal

Integer

参数解释：

参数序号。

取值范围：

不涉及。

isAlias

Boolean

参数解释：

参数别名。

取值范围：

不涉及。

kind

String

参数解释：

参数上下文类型。

取值范围：

不涉及。

contextName

String

参数解释：

上下文名称。

取值范围：

不涉及。

sourceIdentifier

String

参数解释：

参数标识符。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/0747d5a7099e45f69dc1d099945909a9/list-system-vars

响应示例

状态码：200

[ {
  "name" : "PROJECT_ID",
  "value" : null,
  "type" : "string",
  "description" : "当前流水线所属项目ID",
  "isShow" : true,
  "ordinal" : 0,
  "isAlias" : false,
  "kind" : null,
  "contextName" : null,
  "sourceIdentifier" : null
} ]

状态码

状态码

描述

200

响应体

错误码

请参见错误码。

父主题： 流水线管理