文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 获取流水线运行需要的自定义参数 - ListRuntimeVars
更新时间:2026-09-24 GMT+08:00

获取流水线运行需要的自定义参数 - ListRuntimeVars

功能介绍

获取流水线运行需要的自定义参数

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

pipeline_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

偏移量。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

不涉及。

limit

否

Integer

参数解释:

每次查询的条目数量。

约束限制:

不涉及。

取值范围:

大于等于0。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

否

String

参数解释:

语言类型。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文。

  • en-us:英文。

默认取值:

en-us。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

offset

Integer

参数解释:

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

取值范围:

offset大于等于0。

limit

Integer

参数解释:

每次查询的条目数量。

取值范围:

大于等于0。

total

Integer

参数解释:

记录总数。

取值范围:

大于等于0。

variables

Array of PipelineVariable objects

参数解释:

流水线自定义参数。

取值范围:

不涉及。

表5 PipelineVariable

参数

参数类型

描述

name

String

参数解释:

自定义参数名称。

取值范围:

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

sequence

Integer

参数解释:

序号。

取值范围:

[1, 2147483647]。

type

String

参数解释:

自定义参数的类型。

取值范围:

  • autoIncrement:自增长参数。

  • enum:枚举参数。

  • string:字符串参数。

value

String

参数解释:

自定义参数的默认值。

取值范围:

不涉及。

is_secret

Boolean

参数解释:

是否为私密参数。

取值范围:

  • true:是私密参数。

  • false:不是私密参数。

description

String

参数解释:

自定义参数描述。

取值范围:

不涉及。

is_runtime

Boolean

参数解释:

是否运行时设置。

取值范围:

  • true:运行时设置。

  • false:非运行时设置。

limits

Array of strings

参数解释:

限定枚举值列表。

取值范围:

不涉及。

is_reset

Boolean

参数解释:

自增长参数是否被重置。

取值范围:

  • true:被重置。

  • false:不被重置。

latest_value

String

参数解释:

自增长参数最新值。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v5/6428c2e2b4b64affa14ec80896695c49/api/pipelines/633839ac12a2465ba86dfc5cd212ee1a/list-runtime-vars

响应示例

状态码:200

{
  "offset" : 1,
  "limit" : 10,
  "total" : 0,
  "variables" : [ {
    "name" : "name",
    "sequence" : 1,
    "type" : "string",
    "is_strict" : false,
    "value" : "zs",
    "is_secret" : false,
    "description" : "",
    "is_runtime" : false,
    "limits" : [ ],
    "is_reset" : false,
    "latest_value" : ""
  }, {
    "name" : "age",
    "sequence" : 2,
    "type" : "string",
    "is_strict" : false,
    "value" : "18",
    "is_secret" : false,
    "description" : "",
    "is_runtime" : false,
    "limits" : [ ],
    "is_reset" : false,
    "latest_value" : ""
  } ]
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。