文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 修改参数组 - UpdateVariableGroup
更新时间：2026-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改参数组 - UpdateVariableGroup

功能介绍

根据参数组详情修改参数组

调用方法

请参见如何调用API。

URI

PUT /v5/{project_id}/api/pipeline/variable/group/update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

projectId

是

String

参数解释：

项目ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

name

是

String

参数解释：

参数组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

description

否

String

参数解释：

描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

variables

否

Array of variables objects

参数解释：

参数列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

id

是

String

参数解释：

参数组ID。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。
表3 variables

参数

是否必选

参数类型

描述

name

否

String

参数解释：

参数名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sequence

否

Integer

参数解释：

参数序号。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

type

否

String

参数解释：

参数类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

否

String

参数解释：

参数默认值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

is_secret

否

Boolean

参数解释：

是否私密。

约束限制：

不涉及。

取值范围：

  • true：是私密。

  • false：不是私密。

默认取值：

不涉及。

description

否

String

参数解释：

描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

success

Boolean

参数解释：

操作是否成功。

取值范围：

  • true：操作成功。

  • false：操作失败。

请求示例

PUT https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/update

{
  "projectId" : "e2e18230a85d4d6ab0b56cb6d2246c18",
  "name" : "2131",
  "description" : "",
  "variables" : [ {
    "name" : "123",
    "sequence" : 1,
    "type" : "string",
    "value" : "123",
    "is_secret" : false,
    "description" : "123"
  } ],
  "id" : "66d40ba4e3da4505aaaf7e9de9860b6e"
}

响应示例

状态码：200

{
  "success" : true
}

状态码

状态码

描述

200

响应体

错误码

请参见错误码。

父主题： 流水线管理