华为云用户手册

SDK获取和安装 安装PHP开发环境。 访问PHP官网，下载并按说明安装PHP开发环境。 华为云 PHP SDK 支持 PHP 5.6 及以上版本。 安装composer curl -sS https://getcomposer.org/installer | php 安装PHP SDK composer require huaweicloud/huaweicloud-sdk-php 引入 Composer 的自动加载文件 require 'path/to/vendor/autoload.php';

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 返回结果状态 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 octopus_job_name String 临时任务名称 actual_build_number String 实际构建次数 daily_build_number String 构建每日编号 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 执行任务ID为“f9d6c8466d614a9788e9a0acf6c15f46”，代码仓名称为“codeBranch”，代码仓分支为“master”的构建任务 POST https://{endpoint}/v3/jobs/build { "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46", "parameter" : [ { "name" : "codeBranch", "value" : "master" } ], "scm" : { "build_tag" : null, "build_commit_id" : "build_commit_id" } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务接口获取 （响应消息头中X-Subject-Token的值）。 不支持租户全局token，请使用scope为project的region级token。 表2 请求Body参数 参数 是否必选 参数类型 描述 job_id 是 String 构建任务ID；编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串 parameter 否 Array of ParameterItem objects 自定义参数 scm 否 Scm object 代码信息 表3 ParameterItem 参数 是否必选 参数类型 描述 name 是 String 参数名称 value 是 String 参数值 表4 Scm 参数 是否必选 参数类型 描述 build_tag 否 String 代码Tag build_commit_id 否 String 代码提交ID

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 success Boolean 是否停止成功 result String 返回结果 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 新增以下接口： 下载构建日志、下载构建步骤日志、获取构建记录信息、获取构建产物详情信息、更新构建作业配置、查询构建模板、创建构建模板、删除构建模板、创建构建任务、查询通知、更新通知、取消通知、获取构建任务详情 新增以下待下线接口： 下载构建日志（待下线）、获取构建记录的有向无环图（待下线）、获取构建记录信息（待下线）、停止构建任务（待下线） 2023-11-13 新增获取构建记录信息接口。 新增停止构建任务接口。 新增删除构建任务接口。 新增禁用构建任务接口。 新增恢复构建任务接口。 2023-10-19 错误码更新。 2023-03-29 新增根据开始时间和结束时间查看构建任务的构建成功率接口。 修改各接口“X-Auth-Token”参数描述。 2022-04-15 错误码由“DEVCB.00060200”形式改为“CB.00060200”形式。 2021-12-27 新增获取构建历史详情信息接口。 根据开始时间和结束时间查看构建任务的构建历史列表接口新增响应参数。 2021-12-25 新增查询指定代码仓库最近一次成功的构建历史接口。 接口字段类型、描述刷新。 2021-08-11 新增根据开始时间和结束时间查看构建任务的构建历史列表和查看构建任务的构建历史列表两个接口。 2021-03-01 查看项目下用户的构建任务列表响应示例刷新。 2020-11-23 新增应用示例。 2020-08-27 认证鉴权页面刷新。 错误码列表刷新。 2020-08-18 第一次正式发布。 2020-05-26

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success_count Integer 任务成功构建次数 total_count Integer 任务构建总次数 success_ratio Double 任务成功率,精确到小数点后两位 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v3/jobs/{job_id}/success-ratio 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID； 编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 区间开始时间，格式yyyy-MM-dd。 end_time 是 String 区间结束时间，格式yyyy-MM-dd。

响应示例 状态码： 200 OK { "total" : 1, "history_records" : { "record_id" : "20201230.1", "job_id" : "f9d6c8466d614a9788e9a0acf6c15f46", "build_number" : 55, "start_time" : "2020-12-30T17:33:11+08:00", "end_time" : "2020-12-30T17:33:27+08:00", "result" : "FAILURE" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 history_records Array of HistoryRecord objects 构建历史列表 total Integer 记录总数 表5 HistoryRecord 参数 参数类型 描述 record_id String 构建记录id--唯一key job_id String 任务id build_number Integer 构建编号 start_time String 构建开始时间 end_time String 构建结束时间 result String 构建结果 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v3/jobs/{job_id}/history 表1 路径参数 参数 是否必选 参数类型 描述 job_id 是 String 构建的任务ID； 编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 分页页码， 表示从此页开始查询， offset大于等于0 limit 是 Integer 每页显示的条目数量，limit小于等于100 interval 是 Integer 距今天的时间区间（单位：天），interval小于等于30

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result result object 结果 status String 状态信息 表4 result 参数 参数类型 描述 job_id String 构建任务ID project_id String 构建任务所在项目的ID 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "job_name" : "测试任务01", "build_number" : 5, "project_id" : "6ecbc5bac7c8442fb3d2563d53c13582", "project_name" : "test-project", "parameters" : [ { "static_limit_param_name" : "static_limit_param_value_1", "sentive_param_name" : "******", "no_static_param_name" : "no_static_param_value", "static_param_name" : "static_param_value", "no_static_limit_param_name" : "no_static_limit_param_value_1" } ], "build_steps" : [ { "name" : "代码检出", "status" : "success", "build_time" : 8366 }, { "name" : "上传软件包到软件发布库", "status" : "", "build_time" : 0 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 任务运行结果 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 返回结果状态 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "record_id" : "20210722.16", "job_id" : "37be03edd1da430c8079504d546cc499", "job_name" : "测试任务01", "build_number" : 16, "start_time" : "2021-07-22T16:26:52+08:00", "end_time" : "2021-07-22T16:27:15+08:00", "result" : "SUC CES S", "commit_id" : "e311c54476e0e536f0ecdeeba8dc184216fa2057" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 record_id String 构建记录id--唯一key job_id String 构建任务ID job_name String 构建任务名称 build_number Integer 构建编号 start_time String 构建开始时间 end_time String 构建结束时间 result String 构建执行结果 commit_id String commitId 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "total" : 1, "jobs" : [ { "id" : "2a86c3c1ed18416399279fe6........", "job_name" : "demo", "job_creator" : "ae22fd035f354cfa8d82a3f1........", "user_name" : "test", "last_build_time" : 1608004535000, "health_score" : 75, "source_code" : "test", "last_build_status" : "blue", "is_finished" : true, "disabled" : true, "favorite" : true, "is_modify" : true, "is_delete" : true, "is_execute" : true, "is_copy" : true, "is_forbidden" : true, "is_view" : true } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of Job objects 任务列表 total Integer 任务总数 表5 Job 参数 参数类型 描述 id String 任务ID job_name String 任务名称 job_creator String 任务创建者 user_name String 用户名称 last_build_time Number 最新执行时间 health_score Integer 健康分值 source_code String 代码来源 last_build_status String 最新构建状态 is_finished Boolean 是否已结束 disabled Boolean 是否已禁用 favorite Boolean 是否已收藏 is_modify Boolean 是否有修改任务权限 is_delete Boolean 是否有删除任务权限 is_execute Boolean 是否有执行任务权限 is_copy Boolean 是否有复制任务权限 is_forbidden Boolean 是否有禁用任务权限 is_view Boolean 是否有查看任务权限 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v3/{project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String CodeArts项目ID，32位数字、小写字母组合。 表2 Query参数 参数 是否必选 参数类型 描述 page_index 是 Integer 分页页码， 表示从此页开始查询， page_index大于等于0 page_size 是 Integer 每页显示的条目数量，page_size小于等于100

响应示例 状态码： 200 OK { "success" : true, "result" : { "id" : "eb9d73c7-61b3-4823-b476-a7c00c493b8a", "build_project_id" : "31581e9f-5772-4053-a50c-d5690578c8fd", "build_record_id" : "9d6169b9-022d-458c-9dc8-48cc94cc4083", "parent_record_id" : null, "devcloud_project_id" : "b4d3971c3988463b865f6f920846149e", "codeci_job_id" : "68491d9bc97b4774adb93e29b46d2dc6", "user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "build_no" : 532, "daily_build_num" : "20221011.29", "execution_id" : "j_YE1bu9Z7", "repo_name" : "maven", "repo_id" : "2111616838", "branch" : "buildflow_env", "tag" : null, "commit" : null, "commit_message" : null, "commit_create_time" : "2022-10-11T08:28:42.000+00:00", "trigger_type" : "MANUAL", "build_type" : "branch", "status" : "SUCCESS", "domain_id" : "60021bab32fd450aa2cb89226f425e06", "create_time" : "2022-10-11T08:28:42.000+00:00", "schedule_time" : "2022-10-11T08:28:45.000+00:00", "queued_time" : "2022-10-11T08:28:45.000+00:00", "start_time" : "2022-10-11T08:28:47.000+00:00", "runnable_time" : "2022-10-11T08:16:04.000+00:00", "finish_time" : "2022-10-11T08:30:27.000+00:00", "duration" : 100068, "record_status" : null, "use_private_slave" : 0, "region" : "cn-north-7", "err_msg" : null, "build_config_type" : "YAML" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 success Boolean 状态 message String 消息 err_code String 错误码 result result object 结果 表4 result 参数 参数类型 描述 id String id build_project_id String 构建工程ID,唯一对应codeci_job_id build_record_id String 构建记录ID parent_record_id String 父构建记录ID devcloud_project_id String 项目ID codeci_job_id String codeci任务ID,唯一对应build_project_id user_id String 用户ID build_no Integer 构建编号 daily_build_num String 每日构建编号，每日从1开始 execution_id String 八爪鱼任务ID repo_name String 仓库名称 repo_id String 仓库id branch String 仓库分支 tag String 仓库tag commit String 仓库commit ID commit_message String 仓库commit提交信息 commit_create_time String commit创建时间 trigger_type String 触发类型 build_type String 构建类型 status String 构建状态 domain_id String 租户ID create_time String 任务创建时间 schedule_time String 构建下发耗时 queued_time String 构建排队耗时 start_time String 开始构建时间 runnable_time String 八爪鱼真正开始构建时间 finish_time String 构建结束时间 duration Float 构建时长 record_status String record状态 use_private_slave Integer 是否使用自定义执行机 region String 租户所在region err_msg String 错误信息 build_config_type String 构建配置类型，YAML或ACTION 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 构建停止结果 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务接口获取 （响应消息头中X-Subject-Token的值）。 不支持租户全局token，请使用scope为project的region级token。 表2 请求Body参数 参数 是否必选 参数类型 描述 job_id 是 String 构建任务ID；编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串 build_no 是 String 构建任务的构建编号，从1开始，每次构建递增1

响应示例 状态码： 200 OK { "result" : { "package_info" : null, "package_infos" : { "additionalProp1" : { "project_id" : "a287e712be6c404ca26e5f69040fa12b", "name" : "a287e712be6c404ca26e5f69040fa12b", "version" : "a287e712be6c404ca26e5f69040fa12b", "package_type" : "a287e712be6c404ca26e5f69040fa12b", "uri" : "a287e712be6c404ca26e5f69040fa12b", "type" : "a287e712be6c404ca26e5f69040fa12b", "daily_build_number" : "a287e712be6c404ca26e5f69040fa12b" } }, "image_infos" : null }, "error" : null, "status" : "success" }

响应示例 状态码： 200 OK { "success" : true, "result" : { "edges" : [ { "from" : "d5587caf-05d7-42af-8ed2-daa20eb1de1b", "to" : "af81a8ff-1d53-4e0a-9108-fa7880366e73" } ], "vertices" : [ { "id" : "7607d919-6c21-43b3-a06e-ee016ff8e7c7", "status" : "SUCCESS", "display_name" : "job4", "build_duration" : 38156, "start_time" : "2020-12-30T17:33:11+08:00", "finish_time" : "2020-12-30T17:33:27+08:00", "build_no" : "535" } ] } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 success Boolean 状态 message String 消息 err_code String 错误码 result result object 结果 表4 result 参数 参数类型 描述 edges Array of edges objects edges vertices Array of Vertices objects record信息 表5 edges 参数 参数类型 描述 from String 依赖子任务ID to String 被依赖的子任务ID 表6 Vertices 参数 参数类型 描述 id String 子任务构建记录ID status String 子任务执行状态 display_name String 子任务名称 build_duration Integer 子任务构建耗时 start_time String 子任务开始时间 finish_time String 子任务结束时间 build_no String 子任务构建编号 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "status" : "success", "result" : { "id" : "eb9d73c7-61b3-4823-b476-a7c00c493b8a", "build_project_id" : "31581e9f-5772-4053-a50c-d5690578c8fd", "build_record_id" : "9d6169b9-022d-458c-9dc8-48cc94cc4083", "parent_record_id" : null, "devcloud_project_id" : "b4d3971c3988463b865f6f920846149e", "codeci_job_id" : "68491d9bc97b4774adb93e29b46d2dc6", "user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "build_no" : 532, "daily_build_num" : "20221011.29", "execution_id" : "j_YE1bu9Z7", "repo_name" : "maven", "repo_id" : "2111616838", "branch" : "buildflow_env", "tag" : null, "commit" : null, "commit_message" : null, "commit_create_time" : "2022-10-11T08:28:42.000+00:00", "trigger_type" : "MANUAL", "build_type" : "branch", "status" : "SUCCESS", "domain_id" : "60021bab32fd450aa2cb89226f425e06", "create_time" : "2022-10-11T08:28:42.000+00:00", "schedule_time" : "2022-10-11T08:28:45.000+00:00", "queued_time" : "2022-10-11T08:28:45.000+00:00", "start_time" : "2022-10-11T08:28:47.000+00:00", "runnable_time" : "2022-10-11T08:16:04.000+00:00", "finish_time" : "2022-10-11T08:30:27.000+00:00", "duration" : 100068, "record_status" : null, "use_private_slave" : 0, "region" : "cn-north-7", "err_msg" : null, "build_config_type" : "YAML" } }