更新时间:2025-08-19 GMT+08:00
分享

创建参数组

功能介绍

创建参数组

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/api/pipeline/variable/group/create

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

projectId

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

name

String

参数解释

参数组名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

描述详情。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

variables

Array of variables objects

参数解释

参数列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 variables

参数

是否必选

参数类型

描述

sequence

Integer

参数解释

参数序号。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

参数名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

type

String

参数解释

参数类型。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

value

String

参数解释

参数默认值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

参数描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_secret

Boolean

参数解释

是否私密参数。

约束限制

不涉及。

取值范围

  • true:是私密参数。

  • false:不是私密参数。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

pipeline_variable_group_id

String

参数解释

参数组ID。

取值范围

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

请求示例

POST https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/create

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

响应示例

状态码:200

响应体

{
  "pipeline_variable_group_id" : "66d40ba4e3da4505aaaf7e9de9860b6e"
}

状态码

状态码

描述

200

响应体

错误码

请参见错误码

相关文档