检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,您可以从地区和终端节点中获取。接口的认证鉴权请参见认证鉴权
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第三十九次正式发布,本次变更说明如下: 新增流水线管理相关接口。 新增扩展点管理相关接口。 启动流水线接口删除请求参数event_type。 2024-12-05
获取流水线列表/获取项目下流水线执行状况 功能介绍 获取流水线列表/获取项目下流水线执行状况 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/list 表1 路径参数 参数 是否必选 参数类型 描述 project_id
示例2:停止流水线 场景描述 本章将指导您通过API根据流水线ID停止流水线任务。 API的调用方法请参见4.2.5如何调用AP。 约束限制 已有流水线,并且流水线正在执行中。 涉及接口 通过用户token、流水线id停止流水线。 操作步骤 查看项目下构建任务列表。 接口信息 URI
示例1: 执行流水线 场景描述 本章将指导您通过API执行流水线任务。 API的调用方法请参见3-如何调用API。 约束限制 待执行流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数启动流水线。 操作步骤 执行流水线任务。 接口信息 URI:POST
示例3:获取流水线状态 场景描述 本章将指导您通过API获取流水线状态。 API的调用方法请参见3-如何调用API。 约束限制 流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数获取流水线状态。 操作步骤 查询流水线任务执行状态。 接口信息 URI
填写待下载的制品产物地址,格式为:${{jobs.build_job.artifacts.demo}},用于标识构建任务的产物。 jobs:固定目录,保持不变。 build_job:Build构建插件对应的任务ID,需要手动替换,如图3。
身份认证与访问控制 身份认证 用户访问流水线的方式有多种,包括流水线用户界面、API,无论访问方式封装成何种形式,其本质都是通过流水线提供的REST风格的API接口进行请求。 流水线的接口需要经过认证请求后才可以访问成功。流水线支持两种认证方式: Token认证:通过Token认证调用请求
validation 校验信息,是一个对象,包含requiredMessage、regex、regexMessage三个属性。
YAML化流水线通常由触发方式on、参数env、任务jobs等组成,详见YAML语法规范。 YAML文件示例 为了让您快速理解YAML化流水线,以下通过流水线串联编译构建任务、代码检查任务、部署任务,并在编译构建任务中引用流水线参数的YAML文件为您介绍YAML整体结构。
# 获取构建产物下载地址 echo ${{ jobs.JOB_xZGhF.artifacts.demo.download_url }} # 获取构建产物所有信息 echo ${{ jobs.JOB_xZGhF.artifacts.demo }} 图3 执行Shell 执行流水线,执行成功后即可在日志中查看打印的产物信息
通过流水线生成标签名并通过上下文传递为代码仓库创建标签 流水线上下文存储了流水线运行的实例、变量、任务等信息,每个上下文都是一个包含各种属性的对象。
示例: 在执行条件中定义不管前置任务(任务ID为“job_1”)运行成功或失败,均执行当前任务,表达式语法如下: ${{ jobs.job_1.status == 'COMPLETED' || jobs.job_1.status == 'FAILED' }} 更多表达式编写请参考配置流水线执行条件表达式
配置流水线执行计划 流水线支持配置事件触发、定时任务、Webhook触发和并发策略四种执行计划。通过事件触发和定时任务,实现自动化执行;通过Webhook触发,用户可以通过任意第三方系统触发流水线执行;通过并发策略,可以更细粒度地为用户分配并发资源。 配置流水线事件触发 事件触发包括代码提交时触发
数据保护技术 流水线通过多种数据保护手段和特性,保证通过流水线的数据安全可靠。 表1 流水线的数据保护手段和特性 数据保护手段 简要说明 详细介绍 传输加密(HTTPS) 流水线所有API均采用HTTPS传输协议。 构造请求 个人数据保护 流水线通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露
新建CodeArts服务扩展点 操作场景 服务扩展点是CodeArts的一种扩展插件,为CodeArts提供连接第三方服务的能力。 当CodeArts中的一些任务需要连接到远程第三方服务,进行一些获取数据操作时,例如连接第三方GitHub仓库获取项目源码、连接第三方Jenkins服务执行
流水线插件概述 流水线内置了一系列常用的插件,覆盖构建、检查、部署、测试全领域,供用户在流水线编排时使用。同时提供一套标准的扩展插件接入方式,支持企业将已有工具链接入插件平台,或者基于自身业务需求快速开发、发布插件,并在企业内进行共享和复用,加速企业上云。通过打造可视化、低代码、开放的插件市场
发布管理概述 发布管理(CodeArts Release)是CodeArts提供的版本配套、自动化部署上线的E2E解决方案,支撑产品的版本级持续交付。通过发布管理可以保证发布团队在保持现有生产环境完整性的同时,高效交付业务所需的应用程序和升级。使用Codearts产品时,虚拟机部署一般使用
基于Kubernetes原生Service的场景完成微服务蓝绿发布 方案概述 应用场景 在进行服务发布的时候,通常会碰到这样的问题: 直接在生产环境发布后再进行测试,可能会带来较大风险,对线上用户造成影响。 测试环境虽然和生产环境高度一致,然而实际情况下,由于资源配置、网络环境等,