检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用AP
参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。
如何调用API 构造请求 认证鉴权 返回结果
获取构建记录信息 功能介绍 获取构建记录信息 调用方法 请参见如何调用API。 URI GET /v1/record/{job_id}/{build_no}/record-info 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID;
API概览 表1 编译构建API概览 分类 接口 任务相关API接口 描述当前CodeArts Build的接口信息。 历史API接口(待下线) 描述待下线的接口信息。
参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。
是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务接口获取 (响应消息头中X-Subject-Token的值)。 不支持租户全局token,请使用scope为project的region级token。 响应参数 状态码: 200 表3
参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。
获取任务权限矩阵 功能介绍 获取任务权限矩阵 调用方法 请参见如何调用API。 URI GET /v1/job/permission 表1 Query参数 参数 是否必选 参数类型 描述 project_id 是 String CodeArts项目ID,32位数字、小写字母组合。
检查webhook地址参数 获取dockerfileTemplate 获取镜像模板列表 获取当前项目默认角色权限矩阵信息 获取修改历史 复制任务名 获取该任务所有分支信息 查看系统预定义参数 查看仓库 获取租户任务总数和成功率接口 获取套餐资源id,影响临期,超期提示 获取套餐临期信息 检查任务数量是否上限
参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。
参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。
获取套餐临期信息 功能介绍 获取套餐临期信息 调用方法 请参见如何调用API。 URI POST /v2/resource/countdown 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 service_type 是 String 服务类型 resource_id
获取构建任务详情 功能介绍 获取构建任务详情 调用方法 请参见如何调用API。 URI GET /v1/job/{job_id}/config 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID; 编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串。
获取镜像模板列表 功能介绍 获取镜像模板列表 调用方法 请参见如何调用API。 URI GET /v1/image/templates 请求参数 无 响应参数 状态码: 200 表1 响应Body参数 参数 参数类型 描述 result result object 返回结果 error
获取dockerfileTemplate 功能介绍 获取dockerfileTemplate 调用方法 请参见如何调用API。 URI GET /v1/image/dockerfile-template 表1 Query参数 参数 是否必选 参数类型 描述 image_id 是 String
获取修改历史 功能介绍 获取修改历史 调用方法 请参见如何调用API。 URI GET /v1/job/{job_id}/history 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID; 编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串。
获取通知信息 功能介绍 获取通知信息 调用方法 请参见如何调用API。 URI GET /v1/job/{job_id}/notice 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID; 编辑构建任务时,浏览器URL末尾的32位数字、字母组合的字符串。
获取官方推荐模板 功能介绍 获取官方推荐模板 调用方法 请参见如何调用API。 URI POST /v1/template/recommend 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 git_url 否 String 代码仓地址 branch 否 String
是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务接口获取 (响应消息头中X-Subject-Token的值)。 不支持租户全局token,请使用scope为project的region级token。 响应参数 状态码: 200 表3