检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 编译构建API概览 分类 接口 任务相关API接口 描述当前CodeArts Build的接口信息。 历史API接口(待下线) 描述待下线的接口信息。
获取构建任务详情 查询任务状态 流水线查看构建任务信息 文件管理删除权限 文件管理查询权限 获取任务构建记录列表 详情页获取构建参数 获取构建记录的有向无环图
获取构建记录的有向无环图 功能介绍 获取构建记录的有向无环图 调用方法 请参见如何调用API。 URI GET /v1/record/{build_flow_record_id}/flow-graph 表1 路径参数 参数 是否必选 参数类型 描述 build_flow_record_id
如何调用API 构造请求 认证鉴权 返回结果
历史API接口(待下线) 下载构建日志(待下线) 获取构建记录的有向无环图(待下线) 获取构建记录信息(待下线) 停止构建任务(待下线)
获取构建记录的有向无环图(待下线) 功能介绍 获取构建记录的有向无环图(待下线) 调用方法 请参见如何调用API。 URI GET /v3/{build_flow_record_id}/flow-graph 表1 路径参数 参数 是否必选 参数类型 描述 build_flow_record_id
应用示例 示例1:执行构建任务并查看任务是否为运行状态 示例2:根据项目ID查看项目下构建任务列表
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请
使用前必读 欢迎使用编译构建服务(CodeArts Build)。编译构建服务为开发者提供配置简单的混合语言构建平台,实现编译构建云端化,支撑企业实现持续交付,缩短交付周期,提升交付效率。支持编译构建任务一键创建、配置和执行,实现获取代码、构建、打包等活动自动化,实时监控构建状态
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求UR
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 CB.00060200 参数不合法 参数不合法 请检查并确认参数值是否合法 400 CB.00060201 任务ID参数不合法 任务ID参数不合法
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
查看仓库 功能介绍 查看仓库 调用方法 请参见如何调用API。 URI GET /v1/report/{job_id}/repositories 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID; 编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串。
除构建模板、创建构建任务、查询通知、更新通知、取消通知、获取构建任务详情 新增以下待下线API: 下载构建日志(待下线)、获取构建记录的有向无环图(待下线)、获取构建记录信息(待下线)、停止构建任务(待下线) 2023-10-19 新增“获取构建记录信息”接口。 新增“停止构建任务”接口。
上传文件 功能介绍 上传文件 调用方法 请参见如何调用API。 URI POST /v2/keystore/upload 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 file 是 File 文件 privacy 是 String 同意隐私声明,允许使用用户敏感信息进行相关业务操作。
取消通知 功能介绍 取消通知 调用方法 请参见如何调用API。 URI POST /v3/jobs/notice/{job_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 参数解释: 填写构建任务ID。获取方法:在构建任务详
删除任务 功能介绍 删除任务 调用方法 请参见如何调用API。 URI DELETE /v1/job/{job_id}/delete 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 任务ID 请求参数 无 响应参数 状态码: 200 表2 响应Body参数
附录 状态码 错误码 获取项目ID 获取账号ID
禁用任务 功能介绍 禁用任务 调用方法 请参见如何调用API。 URI POST /v1/job/{job_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID; 编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串。