文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 获取旧版流水线的所有自定义参数 - ListPipelineCustomVars
更新时间:2026-09-24 GMT+08:00

获取旧版流水线的所有自定义参数 - ListPipelineCustomVars

功能介绍

获取旧版流水线的所有自定义参数

调用方法

请参见如何调用API。

URI

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

表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参数

参数

参数类型

描述

[数组元素]

Array of customVarVOVO objects

参数解释:

自定义参数列表。

取值范围:

不涉及。

表4 customVarVOVO

参数

参数类型

描述

name

String

参数解释:

参数名。

取值范围:

不涉及。

sequence

Integer

参数解释:

参数编号。

取值范围:

不涉及。

type

String

参数解释:

参数类型。

取值范围:

不涉及。

value

String

参数解释:

参数值。

取值范围:

不涉及。

is_secret

Boolean

参数解释:

参数是否私密。

取值范围:

  • true:是私密参数。

  • false:不是私密参数。

description

String

参数解释:

参数描述。

取值范围:

不涉及。

is_runtime

Boolean

参数解释:

是否运行时设置。

取值范围:

  • true:是运行时设置。

  • false:不是运行时设置。

limits

Array of limits objects

参数解释:

限定枚举值列表。

取值范围:

不涉及。

is_reset

Boolean

参数解释:

自增长参数是否被重置。

取值范围:

  • true:被重置。

  • false:不被重置。

is_strict

Boolean

参数解释:

是否严格递增。

取值范围:

  • true:是。

  • false:否。

latest_value

String

参数解释:

自增长参数最新值。

取值范围:

不涉及。

required

Boolean

参数解释:

是否必填。

取值范围:

  • true:必填。

  • false:非必填。

表5 limits

参数

参数类型

描述

disable

String

参数解释:

枚举值。

取值范围:

不涉及。

name

String

参数解释:

枚举名称。

取值范围:

不涉及。

displayname

String

参数解释:

枚举别名。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v5/0b015e21d3054a3fb03839c43b7cd034/api/pipelines/12780316f8ca4d8c86bee1bcf24691be/list-pipeline-vars

响应示例

状态码:200

[ {
  "sequence" : 1,
  "name" : "aaa",
  "type" : "string",
  "value" : "aaa",
  "description" : "",
  "is_runtime" : false,
  "is_secret" : false,
  "is_reset" : false,
  "latest_value" : "",
  "limits" : [ ],
  "is_strict" : false
} ]

状态码

状态码

描述

200

OK

错误码

请参见错误码。