检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
} 其中,error_code表示错误码,error_msg表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 200 DEVCP.00014031 权限不足 无创建流水线权限
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
问题现象 流水线执行失败,提示测试套正在执行。 原因分析 流水线触发执行接口测试任务时,该接口测试的测试套处于执行状态,由于测试套不支持并发执行 ,因此会报此异常。 处理方法 可通过以下两种方法解决: 等接口测试任务执行完再执行流水线。 进入对应任务,停掉该任务后再执行流水线。 父主题:
获取项目ID 调用API获取项目ID 项目ID可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,您可以从地区和终端节点中获取。接口的认证鉴权请参见认证鉴权。
使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过
身份认证与访问控制 身份认证 用户访问流水线的方式有多种,包括流水线用户界面、API,无论访问方式封装成何种形式,其本质都是通过流水线提供的REST风格的API接口进行请求。 流水线的接口需要经过认证请求后才可以访问成功。流水线支持两种认证方式: Token认证:通过Token认
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口,您可以从接口的请求部分看到所需的请求参数及参数
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
获取流水线列表接口 调用方法 请参见如何调用API。 URI POST /v3/pipelines/list 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响
API概览 表1 流水线接口概览 分类 接口 模板管理 包括查询模板列表、创建流水线模板、查询模板详情等接口。 流水线管理 包括启动流水线、批量获取流水线状态、获取流水线状态/获取流水线执行详情等接口。 分组管理 包括新建流水线分组、更新流水线分组、删除流水线分组等接口。 规则管理
场景描述 本章将指导您通过API根据流水线ID停止流水线任务。 API的调用方法请参见4.2.5如何调用AP。 约束限制 已有流水线,并且流水线正在执行中。 涉及接口 通过用户token、流水线id停止流水线。 操作步骤 查看项目下构建任务列表。 接口信息 URI:POST /v3/pipelines/stop
示例3:获取流水线状态 场景描述 本章将指导您通过API获取流水线状态。 API的调用方法请参见3-如何调用API。 约束限制 流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数获取流水线状态。 操作步骤 查询流水线任务执行状态。 接口信息 URI:POST v3/
执行流水线 场景描述 本章将指导您通过API执行流水线任务。 API的调用方法请参见3-如何调用API。 约束限制 待执行流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数启动流水线。 操作步骤 执行流水线任务。 接口信息 URI:POST /v3/
第二十一次正式发布,本次变更说明如下: 查询模板列表接口请求参数更新。 2023-05-08 第二十次正式发布,本次变更说明如下: 优化接口参数描述。 2023-05-05 第十九次正式发布,本次变更说明如下: 新增规则管理相关接口。 新增基于模板创建流水线接口。 2023-04-21 第十八次正式发布,本次变更说明如下:
驳回人工审核 功能介绍 驳回人工审核 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/
String 模板类型 source 否 String 接口调用方 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
配置流水线参数 流水线参数可以传递给各个任务使用,实现任务间数据流动的统一,只需要配置好流水线参数,即可完成构建、部署、接口测试等任务的数据拉通。流水线参数包括以下三种。 系统预定义参数:系统默认提供的参数,无需定义、不能删除、不能修改。 自定义参数:根据需要自定义添加,参数类型包括字符串类型、枚举类型、自增长类型。
通过人工审核 功能介绍 通过人工审核 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/jobs/{job_run_id}/
获取项目下流水线执行状况 功能介绍 获取项目下流水线执行状况 调用方法 请参见如何调用API。 URI GET /v3/pipelines/build-result 表1 Query参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id start_date
检查流水线创建状态 功能介绍 检查流水线创建状态 调用方法 请参见如何调用API。 URI GET /v3/templates/{task_id}/status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 实例ID 请求参数 表2 请求Header参数