检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
批量获取流水线状态 功能介绍 批量获取流水线状态和阶段信息 调用方法 请参见如何调用API。 URI GET /v3/pipelines/status 表1 Query参数 参数 是否必选 参数类型 描述 pipeline_ids 是 String 要获取状态的流水线ID,用逗号隔开
流水线第三方消息通知查询 功能介绍 流水线第三方消息通知查询 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/message 表1 路径参数 参数 是否必选 参数类型
获取流水线列表 功能介绍 获取流水线列表接口 调用方法 请参见如何调用API。 URI POST /v3/pipelines/list 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户
附录 状态码 错误码 获取项目ID 获取账号ID
获取流水线运行需要的自定义参数 功能介绍 获取流水线运行需要的自定义参数 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/api/pipelines/{pipeline_id}/list-runtime-vars 表1 路径参数 参数 是否必选
获取项目下流水线执行状况 功能介绍 获取项目下流水线执行状况 调用方法 请参见如何调用API。 URI GET /v3/pipelines/build-result 表1 Query参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id start_date
应用示例 示例1: 执行流水线 示例2:停止流水线 示例3:获取流水线状态
获取流水线状态/获取流水线执行详情 功能介绍 获取流水线状态/获取流水线执行详情,仅返回有执行记录的流水线数据 调用方法 请参见如何调用API。 URI GET /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/detail
基于模板快速创建流水线及流水线内任务 功能介绍 基于模板快速创建流水线及流水线内任务 调用方法 请参见如何调用API。 URI POST /v3/templates/task 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String
使用前必读 欢迎使用流水线(CodeArts Pipeline)。流水线提供可视化、可定制的持续交付流水线服务,实现缩短交付周期和提升交付质量的效果。 您可以使用本文档提供的API对流水线进行相关操作,如:启动流水线、停止流水线等。支持的全部操作请参见API概览。 在调用流水线的API
示例3:获取流水线状态 场景描述 本章将指导您通过API获取流水线状态。 API的调用方法请参见3-如何调用API。 约束限制 流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数获取流水线状态。 操作步骤 查询流水线任务执行状态。 接口信息 URI
示例1: 执行流水线 场景描述 本章将指导您通过API执行流水线任务。 API的调用方法请参见3-如何调用API。 约束限制 待执行流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数启动流水线。 操作步骤 执行流水线任务。 接口信息 URI:POST
状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第三十九次正式发布,本次变更说明如下: 新增流水线管理相关接口。 新增扩展点管理相关接口。 启动流水线接口删除请求参数event_type。 2024-12-05
示例2:停止流水线 场景描述 本章将指导您通过API根据流水线ID停止流水线任务。 API的调用方法请参见4.2.5如何调用AP。 约束限制 已有流水线,并且流水线正在执行中。 涉及接口 通过用户token、流水线id停止流水线。 操作步骤 查看项目下构建任务列表。 接口信息 URI
获取流水线列表/获取项目下流水线执行状况 功能介绍 获取流水线列表/获取项目下流水线执行状况 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id
获取项目ID 调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,您可以从地区和终端节点中获取。接口的认证鉴权请参见认证鉴权
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
流水线执行失败,提示测试套正在执行 问题现象 流水线执行失败,提示测试套正在执行。 原因分析 流水线触发执行接口测试任务时,该接口测试的测试套处于执行状态,由于测试套不支持并发执行 ,因此会报此异常。 处理方法 可通过以下两种方法解决: 等接口测试任务执行完再执行流水线。 进入对应任务