- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 模板管理
-
流水线管理
- 启动流水线
- 批量获取流水线状态
- 获取流水线状态/获取流水线执行详情
- 获取流水线列表/获取项目下流水线执行状况
- 删除流水线
- 查询流水线详情
- 修改流水线信息
- 停止流水线
- 获取流水线执行记录
- 基于模板创建流水线
- 创建流水线
- 重试运行流水线
- 通过人工审核
- 获取流水线运行需要的自定义参数
- 驳回人工审核
- 查询流水线日志
- 获取流水线步骤执行输出
- 查询流水线上的构建产物
- 批量删除流水线
- 禁用流水线
- 批量设置流水线标签
- 启用流水线
- 批量运行流水线
- 查询流水线任务日志
- 延时任务通过
- 延时任务拒绝
- 延时1小时
- 手动卡点通过
- 手动卡点拒绝
- 解除挂起
- 查询批量执行流水线结果
- 交换分组顺序
- 流水线官方消息通知查询
- 流水线官方消息通知更新
- 流水线消息通知开关
- 流水线第三方消息通知查询
- 流水线第三方消息通知更新
- 查询流水线的角色权限
- 查询流水线的用户权限
- 修改流水线的角色权限
- 修改流水线的用户权限
- 查询流水线是否启用二级权限
- 修改流水线是否启用二级权限
- 批量设置流水线实例二级权限
- 取消某次流水线排队
- 查询当前流水线排队中的记录
- 查询流水线的旧版运行记录
- 查询流水线运行使用的参数
- 回退执行流水线
- 获取step跳转链接
- 查询流水线运行的变更
- 查询流水线可用的系统参数
- 查询流水线触发失败记录
- 查询流水线修改历史
- 创建参数组
- 修改参数组
- 删除参数组
- 流水线绑定参数组
- 查询参数组详情
- 查询流水线关联的参数组
- 查询参数组列表
- 获取通用Webhook信息
- 分组管理
- 规则管理
- 租户级策略管理
- 项目级策略管理
- 扩展插件管理
- 扩展点管理
- 流水线标签管理
- 变更管理
- 微服务管理
- 模板管理（旧版，待下线）
- 流水线管理（旧版，待下线）
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
获取流水线运行需要的自定义参数
功能介绍
获取流水线运行需要的自定义参数
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-runtime-vars
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： CodeArts项目ID。 约束限制： 不涉及。 取值范围： 32位字符。 默认取值： 不涉及。 |
|
pipeline_id |
是 |
String |
参数解释： 流水线ID。 约束限制： 不涉及。 取值范围： 32位字符。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量 |
|
limit |
否 |
Integer |
每次查询的条目数量 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
X-Language |
否 |
String |
语言类型 中文：zh-cn 英文：en-us，默认en-us |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
offset |
Integer |
偏移 |
|
limit |
Integer |
大小 |
|
total |
Integer |
记录总数 |
|
variables |
Array of PipelineVariable objects |
流水线自定义参数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释： 参数名称。 取值范围： 不涉及。 |
|
sequence |
Integer |
参数解释： 序号。 取值范围： [1, 2147483647]。 |
|
type |
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 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
