检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
身份认证 用户访问流水线的方式有多种,包括流水线用户界面、API,无论访问方式封装成何种形式,其本质都是通过流水线提供的REST风格的API接口进行请求。 流水线的接口需要经过认证请求后才可以访问成功。流水线支持两种认证方式: Token认证:通过Token认证调用请求,访问流水线服务用户界面默认使用Token认证。
Params参数 API接口请求体的Params参数。 Header参数 API接口请求体的Header参数。 远程搜索 开启后,可添加远程搜索字段,使用插件时在输入框中填写值,会使用所填的值作为远程搜索字段的值对接口进行重新调用。 Params参数:搜索字段的参数类型为API接口请求体的Params参数。
fixed:使用options内的值作为下拉选项。 api:通过接口请求,需配置apiOptions。 否 不填则为fixed。 apiOptions JSON体,包含api接口使用的各个参数 否 示例: '{"body":{"xxx":111},"header":{"yyy":222},"linkedFields":["key_001"]
获取项目ID 调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,您可以从地区和终端节点中获取。接口的认证鉴权请参见认证鉴权。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求UR
示例3:获取流水线状态 场景描述 本章将指导您通过API获取流水线状态。 API的调用方法请参见3-如何调用API。 约束限制 流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数获取流水线状态。 操作步骤 查询流水线任务执行状态。 接口信息 URI:POST
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。当调用出错时,HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。
示例1: 执行流水线 场景描述 本章将指导您通过API执行流水线任务。 API的调用方法请参见3-如何调用API。 约束限制 待执行流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数启动流水线。 操作步骤 执行流水线任务。 接口信息 URI:POST
示例2:停止流水线 场景描述 本章将指导您通过API根据流水线ID停止流水线任务。 API的调用方法请参见4.2.5如何调用AP。 约束限制 已有流水线,并且流水线正在执行中。 涉及接口 通过用户token、流水线id停止流水线。 操作步骤 查看项目下构建任务列表。 接口信息 URI:POST
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
获取流水线列表 功能介绍 获取流水线列表接口 调用方法 请参见如何调用API。 URI POST /v3/pipelines/list 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM
使用前必读 欢迎使用流水线(CodeArts Pipeline)。流水线提供可视化、可定制的持续交付流水线服务,实现缩短交付周期和提升交付质量的效果。 您可以使用本文档提供的API对流水线进行相关操作,如:启动流水线、停止流水线等。支持的全部操作请参见API概览。 在调用流水线的
配置流水线参数 流水线参数可以传递给各个任务使用,实现任务间数据流动的统一,只需要配置好流水线参数,即可完成构建、部署、接口测试等任务的数据拉通。流水线参数包括以下三种。 系统预定义参数:系统默认提供的参数,无需定义、不能删除、不能修改。 自定义参数:根据需要自定义添加,参数类型包括字符串类型、枚举类型、自增长类型。
API概览 表1 流水线接口概览 分类 接口 模板管理 包括查询模板列表、创建流水线模板、查询模板详情等接口。 流水线管理 包括启动流水线、批量获取流水线状态、获取流水线状态/获取流水线执行详情等接口。 分组管理 包括新建流水线分组、更新流水线分组、删除流水线分组等接口。 规则管理
什么是流水线 流水线(CodeArts Pipeline)提供可视化、可编排的CI/CD持续交付软件生产线,帮助企业快速转型,实现DevOps持续交付高效自动化,缩短应用TTM(Time to Market)交付周期,提升研发效率。 流水线本质上是一个可视化的自动化任务调度平台,
驳回人工审核 功能介绍 驳回人工审核 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请
批量获取流水线状态 功能介绍 批量获取流水线状态和阶段信息 调用方法 请参见如何调用API。 URI GET /v3/pipelines/status 表1 Query参数 参数 是否必选 参数类型 描述 pipeline_ids 是 String 要获取状态的流水线ID,用逗号隔开
更新规则 功能介绍 更新规则 调用方法 请参见如何调用API。 URI PUT /v2/{domain_id}/rules/{rule_id}/update 表1 路径参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID rule_id 是 String