流水线 CodeArts Pipeline
流水线 CodeArts Pipeline
本产品内“
”的所有结果
本产品内“
”的所有结果
最新动态
产品介绍
什么是流水线
产品优势
应用场景
产品功能
安全
责任共担
身份认证与访问控制
数据保护技术
审计与日志
服务韧性
认证证书
约束与限制
基本概念
快速入门
通过流水线生成软件包并部署到主机
用户指南
流水线(CodeArts Pipeline)使用流程
开通并授权使用CodeArts Pipeline
访问CodeArts Pipeline首页
新建流水线
新建流水线
新建流水线（图形化）
新建流水线（YAML化）
配置流水线
编排流水线阶段
编排流水线任务
配置流水线插件
Build构建
Check代码检查
云原生发布
Deploy部署
TestPlan接口测试
子流水线
延时执行
人工审核
创建仓库标签
Jenkins任务
挂起流水线
执行镜像命令
第三方接口调用v2
配置流水线参数
配置流水线执行计划
配置流水线权限
配置流水线通知订阅
配置流水线委托权限
分组管理流水线
执行流水线
查看流水线
查看统计看板
配置微服务变更流水线
管理流水线扩展插件
流水线插件概述
流水线官方插件
图形化新建流水线自定义插件
代码化新建流水线自定义插件
执行镜像命令
添加创建仓库标签插件
添加第三方接口调用v2插件
管理CodeArts服务扩展点
查看审计日志
参考
流水线上下文
流水线上下文
配置流水线执行条件表达式
配置通过流水线上下文获取构建任务的产物信息
YAML语法规范
流水线触发方式on
流水线参数env
流水线任务jobs
发布管理(CodeArts Release)使用指南
发布管理概述
新建发布管理环境
配置发布管理环境变量
配置发布管理发布策略
配置发布管理环境的发布
查看发布管理发布结果
基于GitOps部署微服务
最佳实践
CodeArts Pipeline最佳实践汇总
通过微服务变更流水线修复项目BUG并快速发布
配置准出条件并对代码检查结果进行校验
通过流水线参数串联编译构建服务和部署服务
通过流水线自动为代码仓库创建标签
配置代码仓库合并请求流水线门禁
流水线级权限管理
HE2E DevOps实践之配置流水线
API参考
使用前必读
API概览
如何调用API
构造请求
认证鉴权
返回结果
API
模板管理
查询模板列表 - ListPipelineTemplates
获取流水线模板列表 - PipelineTemplatesList
创建流水线模板 - CreatePipelineTemplate
查询模板详情 - GetPipelineTemplateDetail
更新流水线模板 - UpdatePipelineTemplate
删除流水线模板 - DeletePipelineTemplate
收藏流水线模板 - CollectPipelineTemplate
流水线管理
启动流水线 - RunPipeline
批量获取有执行记录的流水线状态 - BatchShowPipelinesLatestStatus
获取流水线状态/获取流水线执行详情 - ShowPipelineRunDetail
获取流水线列表/获取项目下流水线执行状况 - ListPipelines
删除流水线 - DeletePipeline
查询流水线详情 - ShowPipelineDetail
修改流水线信息 - UpdatePipelineInfo
停止流水线 - StopPipelineRun
获取流水线执行记录 - ListPipelineRuns
基于模板创建流水线 - CreatePipelineByTemplateId
创建流水线 - CreatePipelineNew
重试运行流水线 - RetryPipelineRun
通过人工审核 - AcceptManualReview
获取流水线运行需要的自定义参数 - ListRuntimeVars
驳回人工审核 - RejectManualReview
查询流水线日志 - ShowPipelineLog
获取流水线步骤执行输出 - ShowStepOutputs
查询流水线上的构建产物 - ShowPipelineArtifacts
批量删除流水线 - BatchDeletePipeline
禁用流水线 - DisablePipeline
批量设置流水线标签 - BatchSetPipelineTag
启用流水线 - EnablePipeline
批量运行流水线 - BatchRunPipeline
查询流水线任务日志 - ShowPipelineExecLog
延时任务通过 - AcceptDelayJob
延时任务拒绝 - RejectDelayJob
延时1小时 - ContinueDelayJob
手动卡点通过 - AcceptCheckpoint
手动卡点拒绝 - RejectCheckpoint
解除挂起 - ResumePipeline
查询批量执行流水线结果 - ShowBatchRunResult
交换分组顺序 - ExchangePipelineGroup
流水线官方消息通知查询 - ShowPipelineOfficialNotice
流水线官方消息通知更新 - UpdatePipelineOfficialNotice
流水线消息通知开关 - SwitchPipelineNotice
流水线第三方消息通知查询 - ShowPipelineThirdPartyNotice
流水线第三方消息通知更新 - UpdatePipelineThirdPartyNotice
查询流水线的角色权限 - ShowPipelineRolePermission
查询流水线的用户权限 - ShowPipelineUserPermission
修改流水线的角色权限 - UpdatePipelineRolePermission
修改流水线的用户权限 - UpdatePipelineUserPermission
查询流水线是否启用二级权限 - ShowPipelinePermissionSwitch
修改流水线是否启用二级权限 - SwitchPipelinePermission
批量设置流水线实例二级权限 - BatchUpdatePipelinePermission
取消某次流水线排队 - CancelPipelineQueue
查询当前流水线排队中的记录 - ListPipelineQueue
查询流水线的旧版运行记录 - ListPipelineLegacyRuns
查询流水线运行使用的参数 - ListRunVariables
回退执行流水线 - RollbackRunPipeline
获取step跳转链接 - ShowStepJumpLink
查询流水线运行的变更 - ShowPipelineRunChangeRequests
查询流水线可用的系统参数 - ListPipelineSystemVars
查询流水线触发失败记录 - ListPipelineTriggerFailedRecords
查询流水线修改历史 - ListPipelineModifyHistory
创建参数组 - CreateVariableGroup
修改参数组 - UpdateVariableGroup
删除参数组 - DeleteVariableGroup
流水线绑定参数组 - BindVariableGroupToPipeline
查询参数组详情 - ShowVariableGroupDetail
查询流水线关联的参数组 - ListPipelineVariableGroup
查询参数组列表 - ListVariableGroups
获取通用Webhook信息 - ShowGenericWebHook
Webhook触发流水线 - TriggerWebhookPipeline
通用webhook触发流水线 - ExecuteGenericWebhook
修改通用webhook开关 - SwitchGenericWebhook
下载 agent 的地址 - AgentDownloadURL
旧版流水线的所有自定义参数 - ListPipelineCustomVars
查询项目下权限 - GetProjectPermission
查询用户的参数组权限 - QueryUserVariableGroupRights
新建流水线查询允许创建流水线的项目 - QueryRelatedProject
根据当前租户的套餐情况判断是否需要弹框 - GetTenantPopUpStatus
根据当前租户的套餐情况判断是否冻结 - GetTenantPackageIsFreeze
查询微服务下用户无删除权限的流水线 - QueryComponentPipelinesWithNoRight
查询流水线执行计划列表 - QueryExecutionPlanList
更新yaml流水线详情 - UpdateYamlPipeline
批量获取流水线版本 - QueryPipelinesManifestVersion
查询通用任务列表 - ListReusableJobs
运行yaml流水线 - RunPacPipeline
看板查询流水线总数 - ShowPipelineCount
看板查询流水线执行详情 - ListExecutionsOverview
看板查询流水线当前并发 - ShowConcurrency
分组管理
新建流水线分组 - CreatePipelineGroup
更新流水线分组 - UpdatePipelineGroup
删除流水线分组 - DeletePipelineGroup
查询流水线分组树 - ShowPipelineGroupTree
批量把流水线移动到分组下 - BatchMovePipelineToGroup
规则管理
获取单条规则详情 - ShowRule
分页获取规则列表 - ListRule
更新规则 - UpdateRule
删除规则 - DeleteRule
创建规则 - CreateRule
查询规则使用情况 - ShowRuleRelatedInfo
查询可创建规则的类型 - queryStrategyType
租户级策略管理
创建策略 - CreateStrategy
修改策略 - UpdateStrategy
获取策略详情 - ShowStrategy
获取策略列表 - ListStrategy
删除策略 - DeleteStrategy
开关策略 - SwitchStrategy
查询策略使用情况 - ShowStrategyRelatedInfo
查询策略关联信息 - ListStrategyChildren
项目级策略管理
获取项目级策略列表 - ListProjectStrategy
查询项目级策略详情 - ShowProjectStrategy
查询策略使用情况 - ShowProjectStrategyRelatedInfo
继承策略 - CreateInheritProjectStrategy
切换策略状态 - SwitchProjectStrategy
删除策略 - DeleteProjectStrategy
查询策略详情 - ShowProjectStrategyDetail
更新策略 - UpdateProjectStrategy
创建策略 - CreateProjectStrategy
扩展插件管理
创建插件版本 - CreatePluginVersion
创建插件草稿版本 - CreatePluginDraft
创建发布商 - CreatePublisher
更新插件草稿 - UpdatePluginDraft
发布插件草稿 - PublishPluginDraft
更新插件基本信息 - UpdatePluginBaseInfo
发布插件 - PublishPlugin
插件绑定发布商 - PublishPluginBind
更新插件图标 - UploadPluginIcon
更新发布商图标 - UploadPublisherIcon
删除插件草稿 - DeletePluginDraft
查询发布商列表 - ListPublisher
查询可用发布商 - ListAvailablePublisher
查询可选插件列表 - ListStagePlugins
查询基础插件列表 - ListBasePlugins
分页查询可选插件列表 - ListBasePluginsNewPost
查询插件列表 - ListPlugins
查询插件指标配置 - ShowPluginMetrics
查询插件输入配置 - ShowPluginInputs
查询插件输出配置 - ShowPluginOutputs
查询插件所有版本信息 - ListPLuginVersion
查询插件版本详情 - ShowPluginVersion
查询插件版本号 - ListPluginVersionNumber
删除发布商 - DeletePublisher
查询发布商详情 - ShowPublisher
创建基础插件 - CreateBasicPlugin
更新基础插件 - UpdateBasicPlugin
删除基础插件 - DeleteBasicPlugin
上传基础插件 - UploadBasicPlugin
查询基础插件详情 - ShowBasicPlugin
扩展点管理
查询插件列表 - ListModulesDetail
查询插件列表V1 - ListModulesDetailV1
查询扩展点列表 - ListEndpointsDetails
创建服务扩展点 - CreateEndpoint
查询插件详情 - ShowModule
获取Oauth2认证URL - ShowAuthUrl
更新扩展点 - UpdateEndpoint
查询扩展点 - ShowEndpoint
删除扩展点 - DeleteEndpoint
流水线标签管理
创建流水线标签 - CreatePipelineTag
查询流水线标签列表 - ListPipelineTags
更新流水线标签 - UpdatePipelineTag
删除流水线标签 - DeletePipelineTag
变更管理
创建变更 - CreateChangeRequest
查询变更详情 - ShowChangeRequestDetail
修改变更状态 - UpdateChangeRequestStatus
修改变更代码仓信息 - UpdateChangeRequestRepos
查询变更列表 - ListChangeRequests
查询流水线上的变更 - ListPipelineChangeRequests
查询发布中的变更 - ListReleasingChangeRequests
查询变更操作历史 - ShowChangeRequestOpLog
查询项目下变更创建人信息 - ShowChangeRequestCreatorInfo
查询变更关联的工作项 - ListChangeRequestWorkItems
更新变更关联的工作项 - UpdateChangeRequestWorkItems
微服务管理
查询是否收藏微服务 - ShowMicroserviceFollowInfo
取消收藏微服务 - UnfollowMicroservice
收藏微服务 - FollowMicroservice
更新微服务 - UpdateMicroservice
更新微服务代码仓 - UpdateMicroserviceRepo
查询微服务详情 - ShowMicroserviceDetail
查询微服务列表 - ListMicroservice
创建微服务 - CreateMicroservice
删除微服务 - DeleteMicroservice
模板管理（旧版，待下线）
查询模板列表 - ListTemplates
查询模板详情 - ShowTemplateDetail
流水线管理（旧版，待下线）
基于模板快速创建流水线及流水线内任务 - CreatePipelineByTemplate
检查流水线创建状态 - ShowInstanceStatus
启动流水线 - StartNewPipeline
停止流水线 - StopPipelineNew
批量获取流水线状态 - BatchShowPipelinesStatus
删除流水线 - RemovePipeline
获取流水线列表 - ListPipelineSimpleInfo
获取流水线状态 - ShowPipelineStatus
获取项目下流水线执行状况 - ListPipelineBuildResult
获取流水线详情 - ShowPipelineDetailV3
查询流水线执行记录 - ListPipelineBuildRecords
GitCode流水线
停止gitcode流水线 - StopActionsPipelineRun
查询gitcode流水线运行详情 - ShowActionsRunsDetail
删除gitcode流水线运行详情 - DeleteActionsRunPipeline
查询所有gitcode流水线 - ListActions
运行gitcode流水线 - RunActionsPipeline
查询gitcode流水线日志 - ShowActionsPipelineJobLog
重试运行gitcode流水线 - RetryRunActionsPipeline
查询gitcode流水线运行记录 - ListActionsPipelineRuns
更新gitcode流水线action - UpdateGitCodeWorkflowsWebhooks
查询gitcode流水线事件 - ListActionsEvents
查询gitcode流水线运行人 - ListActionsActors
查询gitcode流水线action列表 - ListActionsPipelineRunsByRunIds
查询gitcode流水线action详情 - ListActionsDetail
应用示例
示例1: 执行流水线
示例2：停止流水线
示例3：获取流水线状态
附录
状态码
错误码
获取项目ID
获取CodeArts项目ID
获取IAM项目ID
获取账号ID
修订记录
常见问题
功能使用
修改代码后能否自动触发流水线执行？
为什么提交代码时会触发执行没有监听代码提交事件的流水线？
常见报错解决方法
流水线执行失败，提示仓库不存在或仓库已被删除
流水线执行失败，提示测试套正在执行
流水线执行失败，提示任务不存在或者已被删除
流水线配置的定时任务未触发
流水线执行权限不够（执行按钮不可操作）
保存流水线时提示人工审核任务中配置了不属于当前项目的审核人
流水线执行失败，提示流水线不存在
变更流水线执行失败，提示authentication required
流水线执行失败，提示没有配置部署策略
编排流水线任务时，阶段下的任务在任务配置时，任务选择无法进行操作
执行流水线时，提示达到租户最大并发数，查询当时正在执行的流水线并未达到上限
视频帮助
通用参考
云服务等级协议（SLA）
白皮书资源
支持区域
系统权限