更新构建任务
功能介绍
更新构建任务
调用方法
请参见如何调用API。
URI
POST /v1/job/update
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
arch |
是 |
String |
使用机器的架构 |
|
project_id |
是 |
String |
构建任务所在项目的ID |
|
job_name |
是 |
String |
任务名称 |
|
job_id |
是 |
String |
构建任务ID |
|
auto_update_sub_module |
否 |
String |
是否自动更新子模块 |
|
flavor |
否 |
String |
执行机规格 |
|
parameters |
否 |
Array of CreateBuildJobParameter objects |
构建执行参数列表 |
|
group_id |
否 |
String |
任务分组id |
|
timeout |
否 |
CreateBuildTimeout object |
构建任务超时时间 |
|
scms |
否 |
Array of CreateBuildJobScm objects |
构建执行SCM |
|
steps |
是 |
Array of CreateBuildJobSteps objects |
构建执行的步骤 |
|
host_type |
否 |
String |
host类型 |
|
build_config_type |
否 |
String |
构建的配置类型 |
|
triggers |
否 |
Array of Trigger objects |
定时任务触发器集合 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数定义名，默认为hudson.model.StringParameterDefinition |
|
params |
否 |
Array of CreateBuildJobParameterParam objects |
构建执行参数子参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
参数字段名 |
|
value |
否 |
String |
参数字段值 |
|
limits |
否 |
Array of LimitsParam objects |
枚举类参数限制 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
disable |
否 |
String |
是否生效，默认为"0"，为生效状态 |
|
display_name |
否 |
String |
参数展示的名字 |
|
name |
否 |
String |
参数名字 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
branch |
否 |
String |
代码分支 |
|
url |
是 |
String |
代码仓地址 |
|
repo_id |
是 |
String |
repo的id |
|
web_url |
是 |
String |
代码仓http地址 |
|
scm_type |
是 |
String |
仓库类别，Repo、Github等 |
|
is_auto_build |
否 |
Boolean |
是否自动构建 |
|
enable_git_lfs |
否 |
Boolean |
是否启用gitlfs |
|
build_type |
否 |
String |
构建类型，分支构建、TAG构建等 |
|
depth |
否 |
String |
克隆深度 |
|
end_point_id |
否 |
String |
通用git等代码拉取扩展点ID |
|
source |
否 |
String |
来源类型 |
|
group_name |
否 |
String |
仓库分组 |
|
repo_name |
否 |
String |
仓库名称 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
result object |
结果 |
|
status |
String |
状态信息 |
|
error |
String |
错误信息 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
POST https://{endpoint}/v1/job/update
{
"job_id" : "db8467d972cc47f7a1bd2a3a3e77596a",
"arch" : "x86-64",
"project_id" : "a287e712be6c404ca26e5f69040fa12b",
"job_name" : "examplejob",
"auto_update_sub_module" : "false",
"flavor" : "2u8g",
"parameters" : [ {
"name" : "hudson.model.StringParameterDefinition",
"params" : [ {
"name" : "name",
"value" : "codeBranch"
}, {
"name" : "type",
"value" : "normalparam"
}, {
"name" : "defaultValue",
"value" : "master"
}, {
"name" : "description",
"value" : "description"
}, {
"name" : "deletion",
"value" : "false"
}, {
"name" : "defaults",
"value" : "true"
}, {
"name" : "staticVar",
"value" : "false"
}, {
"name" : "sensitiveVar",
"value" : "false"
} ]
} ],
"scms" : [ {
"branch" : "master",
"url" : "git@codehub.devcloud.cn-north-7.ulanqab.huawei.com:soso-test00001/an.git",
"repo_id" : "2111746211",
"web_url" : "https://codehub.devcloud.cn-north-7.ulanqab.huawei.com/codehub/2111746211/home",
"scm_type" : "codehub",
"is_auto_build" : false,
"build_type" : "branch",
"depth" : "1"
} ],
"steps" : [ {
"properties" : null,
"module_id" : "devcloud2018.codeci_action_20043.action",
"name" : "Maven构建",
"version" : "20231001.6",
"enable" : true
} ],
"host_type" : "devcloud"
}响应示例
状态码：200
OK
{
"result" : {
"job_id" : "db8467d972cc47f7a1bd2a3a3e77596a"
},
"error" : null,
"status" : "success"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
