编译构建 CodeArts Build
编译构建 CodeArts Build
- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 编译构建服务(CodeArts Build)使用流程
- 购买并授权使用CodeArts Build
- 配置CodeArts Build项目级角色权限
- 新建构建任务
-
配置构建任务
- 构建任务基础配置
- 选择构建步骤
-
配置构建步骤
- 使用Maven构建
- 使用Android构建
- 使用Npm构建
- 使用Gradle构建
- 使用Yarn构建
- 使用gulp构建
- 使用Grunt构建
- 使用mono构建
- 使用PHP构建
- 使用SetupTool构建
- 使用PyInstaller构建
- 使用shell命令构建
- 使用Gnu-arm构建
- 使用Msbuild构建
- 使用CMake构建
- 使用Ant构建
- 使用Kotlin构建
- 使用Go语言构建
- 使用Ionic Android App构建
- 构建Android快应用
- 使用GFortran构建
- 使用Sbt构建
- 使用Grails构建
- 使用Bazel构建
- 使用Flutter构建
- 使用HarmonyOS构建
- 使用构建方舟编译器构建
- 通过Docker命令操作镜像
- 生成单元测试报告
- 自定义构建环境
- 使用自定义环境构建
- 下载软件发布库中的软件包
- 上传软件包到软件发布库
- 上传文件到OBS
- 配置构建任务参数
- 配置构建任务执行计划
- 配置构建任务角色权限
- 配置构建任务事件通知
- 执行构建任务
- 查看构建任务
- 加速构建任务
- 管理构建任务
- 查询审计日志
- 参考
- 旧版手册页面
-
最佳实践
- CodeArts Build最佳实践汇总
- 基于Maven构建产物制作Docker镜像并发布到镜像仓(内置执行机/图形化构建)
- 使用Maven构建上传软件包至私有依赖库(内置执行机/图形化构建)
- 使用Maven构建实现私有依赖包的上传及下载引用(内置执行机/图形化构建)
- 使用NPM构建上传软件包至软件发布库(内置执行机/图形化构建)
- 使用自定义执行机执行Maven构建(自定义执行机/图形化构建)
- 使用Maven构建上传软件包和推送镜像到SWR(内置执行机/代码化构建)
- 使用Maven构建执行多任务构建工程(内置执行机/代码化构建)
- 基于私有依赖库使用Maven构建并上传软件包(内置执行机/图形化构建)
- 使用自定义构建环境执行构建任务(内置执行机/图形化构建)
- 对C/C++构建工程进行构建加速(内置执行机/图形化构建)
- 使用Windows自定义执行机执行Maven构建(自定义执行机/图形化构建)
- HE2E DevOps实践:构建应用部分
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
任务相关API接口
- 根据开始时间和结束时间查看构建任务的构建历史列表
- 查看构建任务的构建历史列表
- KeyStore文件下载
- 查看任务运行状态
- 查看项目下用户的构建任务列表
- 执行构建任务
- 查询指定代码仓库最近一次成功的构建历史
- 获取构建历史详情信息接口
- 根据开始时间和结束时间查看构建任务的构建成功率
- 下载全量构建日志
- 下载构建步骤日志
- 获取构建记录信息
- 获取构建产物详情信息
- 停止构建任务v3
- 停止构建任务v1
- 删除构建任务
- 禁用构建任务
- 恢复构建任务
- 创建构建任务
- 更新构建任务
- 查询构建模板
- 创建构建模板
- 删除构建模板
- 查询通知
- 更新通知
- 取消通知
- 获取构建任务详情
- 下载构建实时日志
- 获取任务构建记录列表
- 获取任务构建记录列表v1
- 查内置执行机规格
- 获取构建任务的角色权限矩阵信息
- 是否已开启内网安全访问
- 获取用户权限
- 获取任务权限矩阵
- 当前用户所在项目所属租户的包周期每月时长是否超额
- 查看用户全部的构建任务列表
- 获取构建记录的构建脚本
- 查看项目下任务名是否存在
- 获取单元测试覆盖率报告列表
- 查询当前租户(计费)类型
- 查询账号是否联邦账号
- 禁用任务
- 查询构建成功率
- 获取单元测试覆盖率报告压缩包
- 查看构建任务构建信息
- 获取通知信息
- 查询租户状态
- 查看任务是否在构建
- 获取覆盖率接口
- 获取任务各阶段信息
- 获取指定工程的简要构建信息
- 构建历史页获取构建次数
- 保存模板使用记录
- 洞察构建时长
- 配置文件权限
- 添加文件权限
- 文件管理文件下载
- 删除文件管理文件
- 删除任务
- 编辑页获取参数类型的接口
- 获取当前用户的项目信息列表
- 查询租户下文件列表
- 获取编译构建默认参数
- 查询用户可使用文件
- 获取项目列表
- 获取指定工程的构建记录列表
- 查询指定构建记录详情
- 查询任务是否已禁用
- 查询官方模板
- 获取构建任务配置的对比差异
- 设置回收站中的任务保留时间
- 查看回收站中删除的构建任务列表
- 删除回收站中的任务
- 清空回收站中的任务
- 恢复回收站中的任务
- 更新文件信息
- 上传文件
- 检查webhook地址参数
- 获取dockerfileTemplate
- 获取镜像模板列表
- 获取当前项目默认角色权限矩阵信息
- 获取修改历史
- 复制任务名
- 获取该任务所有分支信息
- 查看系统预定义参数
- 查看仓库
- 获取租户任务总数和成功率接口
- 获取套餐资源id,影响临期,超期提示
- 获取套餐临期信息
- 检查任务数量是否上限
- 获取代码化构建默认模板
- 获取官方推荐模板
- 执行构建
- 创建构建任务
- 更新构建任务
- 复制构建任务
- 查询项目任务列表
- 根据条件查询特定模板
- 创建构建模板
- 删除构建模板
- 获取构建记录信息
- 获取构建任务详情
- 查询任务状态
- 流水线查看构建任务信息
- 文件管理删除权限
- 文件管理查询权限
- 获取任务构建记录列表
- 详情页获取构建参数
- 获取构建记录的有向无环图
- 应用示例
- 附录
- 历史API接口(待下线)
- 修订记录
- 场景代码示例
-
常见问题
- 通用构建问题
-
Maven构建
- 执行Maven构建时,提示未开通私有依赖仓
- 执行Maven构建时,提示license信息检查不通过
- 使用maven deploy命令上传包失败
- 执行Maven构建时,提示找不到pom文件
- 执行Maven构建时,提示找不到package/symbol
- 使用exec-maven-plugin插件实现Maven和npm混合编译
- 执行Maven构建时,多个子项目和父项目之间引用报错
- 如何配置及清理Maven构建缓存
- 如何查找Maven构建中正确的构建包路径
- 如何使用jib-maven-plugin插件构建Maven工程制作镜像
- 使用Maven构建时,代码更新后构建出来的包还是旧的
- 使用Maven构建时,Maven组件下载缓慢
- Android构建
- Gradle构建
- Msbuild构建
-
Npm构建
- 执行Npm构建时,报错提示JavaScript heap out of memory
- 执行Npm构建时,报错提示Unexpected end of JSON ...
- 执行Npm构建时,报错提示enoent ENOENT: no such file or directory
- 执行Npm构建时,报错提示Module not found: Error: Can't resolve ...
- 执行Npm构建失败,但不显示错误日志
- 执行Npm构建时,报错提示npm cb() never called
- 执行Npm构建时,报错提示gyp ERR! stack Error: EACCES: permission denied
- 执行Npm构建时,报错提示eslint: error 'CLODOP' is not defined
- 执行Npm构建时,报错提示node-sass下载失败
- 执行Npm构建时,报错提示error: could not write config file
- Npm构建耗时且安装依赖缓慢
- 执行Npm构建时,报错提示找不到依赖版本
- 镜像问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
认证鉴权
调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。
- Token认证:通过Token认证通用请求。
- AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。
Token认证
- Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。
- 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。
Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。
{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } }
获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。
GET https://iam.cn-north-1.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFJ....
您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。
AK/SK认证
- AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。
- AK/SK既可以使用永久访问密钥中的AK/SK,也可以使用临时访问密钥中的AK/SK,但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段,字段值为临时访问密钥的security_token。
AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。
- AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
- SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。
签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
您也可以通过这个视频教程了解AK/SK认证的使用:https://bbs.huaweicloud.com/videos/100697 。
父主题: 如何调用API