- 最新动态
- 功能总览
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 模板管理
-
流水线管理
- 启动流水线
- 批量获取流水线状态
- 获取流水线状态/获取流水线执行详情
- 获取流水线列表/获取项目下流水线执行状况
- 删除流水线
- 查询流水线详情
- 修改流水线信息
- 停止流水线
- 获取流水线执行记录
- 基于模板创建流水线
- 创建流水线
- 重试运行流水线
- 通过人工审核
- 获取流水线运行需要的自定义参数
- 驳回人工审核
- 查询流水线日志
- 获取流水线步骤执行输出
- 查询流水线上的构建产物
- 批量删除流水线
- 禁用流水线
- 批量设置流水线标签
- 启用流水线
- 批量运行流水线
- 查询流水线任务日志
- 延时任务通过
- 延时任务拒绝
- 延时1小时
- 手动卡点通过
- 手动卡点拒绝
- 解除挂起
- 查询批量执行流水线结果
- 交换分组顺序
- 流水线官方消息通知查询
- 流水线官方消息通知更新
- 流水线消息通知开关
- 流水线第三方消息通知查询
- 流水线第三方消息通知更新
- 查询流水线的角色权限
- 查询流水线的用户权限
- 修改流水线的角色权限
- 修改流水线的用户权限
- 查询流水线是否启用二级权限
- 修改流水线是否启用二级权限
- 批量设置流水线实例二级权限
- 取消某次流水线排队
- 查询当前流水线排队中的记录
- 查询流水线的旧版运行记录
- 查询流水线运行使用的参数
- 回退执行流水线
- 获取step跳转链接
- 查询流水线运行的变更
- 查询流水线可用的系统参数
- 查询流水线触发失败记录
- 查询流水线修改历史
- 创建参数组
- 修改参数组
- 删除参数组
- 流水线绑定参数组
- 查询参数组详情
- 查询流水线关联的参数组
- 查询参数组列表
- 获取通用Webhook信息
- 分组管理
- 规则管理
- 租户级策略管理
- 项目级策略管理
- 扩展插件管理
- 扩展点管理
- 流水线标签管理
- 变更管理
- 微服务管理
- 模板管理（旧版，待下线）
- 流水线管理（旧版，待下线）
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
回退执行流水线
功能介绍
回退执行流水线
调用方法
请参见如何调用API。
URI
POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipelineRunId}/rollback-run
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： CodeArts项目ID。 约束限制： 不涉及。 取值范围： 32位字符。 默认取值： 不涉及。 |
|
pipeline_id |
是 |
String |
参数解释： 流水线ID。 约束限制： 不涉及。 取值范围： 32位字符。 默认取值： 不涉及。 |
|
pipelineRunId |
是 |
String |
流水线运行实例ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
sources |
是 |
Array of sources objects |
流水线源 |
|
description |
否 |
String |
运行描述 |
|
variables |
否 |
Array of variables objects |
运行参数 |
|
choose_jobs |
是 |
Array of strings |
选择运行的任务 |
|
choose_stages |
是 |
Array of strings |
选择运行的阶段 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
git_type |
是 |
String |
GIT仓库类型 |
|
codehub_id |
是 |
String |
CODEHUB仓库ID |
|
default_branch |
是 |
String |
默认分支 |
|
git_url |
是 |
String |
GIT仓库下载链接 |
|
alias |
否 |
String |
仓库别名 |
|
endpoint_id |
否 |
String |
扩展点ID |
|
build_params |
是 |
build_params object |
构建参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
build_type |
是 |
String |
构建类型 |
|
event_type |
是 |
String |
事件类型 |
|
target_branch |
是 |
String |
目标分支 |
|
tag |
否 |
String |
标签名称 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数名称 |
|
sequence |
否 |
Integer |
参数序号 |
|
type |
否 |
String |
参数类型 |
|
value |
否 |
String |
参数值 |
|
is_secret |
否 |
Boolean |
是否私密 |
|
description |
否 |
String |
描述 |
|
is_runtime |
否 |
Boolean |
是否运行时设置 |
|
limits |
否 |
Array of strings |
参数限制 |
|
is_reset |
否 |
Boolean |
是否重置 |
|
latest_value |
否 |
String |
最后一次运行的值 |
|
required |
否 |
Boolean |
是否必输 |
|
variableGroupName |
否 |
String |
参数组名称 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
pipeline_run_id |
String |
参数解释： 流水线运行实例ID。 取值范围： 32位字符，仅由数字和字母组成。 |
请求示例
POST https://(endpoint)/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/d7013d2402ff4cc88489ee5af324e049/pipeline-runs/6d65dd0bc411451b8fb70e8535eda3d8/rollback-run
{
"sources" : [ {
"type" : "code",
"params" : {
"git_type" : "codehub",
"codehub_id" : "123456",
"default_branch" : "master",
"git_url" : "https://0001.git",
"alias" : "",
"endpoint_id" : "",
"build_params" : {
"build_type" : "branch",
"event_type" : "Manual",
"target_branch" : "master",
"tag" : null
}
}
} ],
"description" : "",
"variables" : [ {
"name" : "1",
"sequence" : 1,
"type" : "string",
"value" : "1",
"is_secret" : false,
"description" : "",
"is_runtime" : false,
"limits" : [ ],
"is_reset" : false,
"latest_value" : "",
"required" : true,
"variableGroupName" : null
}, {
"name" : "2",
"sequence" : 2,
"type" : "string",
"value" : "2",
"is_secret" : false,
"description" : "",
"is_runtime" : false,
"limits" : [ ],
"is_reset" : false,
"latest_value" : "",
"required" : true,
"variableGroupName" : null
} ],
"choose_jobs" : [ "Task_1" ],
"choose_stages" : [ "state_4" ]
}响应示例
状态码：200
响应体
{
"pipeline_run_id" : "d5e642b122fd453dbaff21d90dee5ac1"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
响应体 |
错误码
请参见错误码。
