文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 获取构建任务详情
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取构建任务详情

功能介绍

获取构建任务详情

调用方法

请参见如何调用API。

URI

GET /v1/job/{job_id}/config

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

构建的任务ID；

编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。
表2 Query参数

参数

是否必选

参数类型

描述

get_all_params

否

String

输入"true"或者"false"来控制返回参数是不是完整的

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

result

CreateBuildJobRequestBody object

查询模板结果

error

String

返回错误信息

status

String

返回状态信息
表4 CreateBuildJobRequestBody

参数

参数类型

描述

arch

String

使用机器的架构

project_id

String

构建任务所在项目的ID

job_name

String

任务名称

auto_update_sub_module

String

是否自动更新子模块

flavor

String

执行机规格

host_type

String

host类型

build_config_type

String

构建任务配置类型

build_if_code_updated

String

提交代码触发构建开关

parameters

Array of CreateBuildJobParameter objects

构建执行参数列表

scms

Array of CreateBuildJobScm objects

构建执行SCM

steps

Array of CreateBuildJobSteps objects

构建执行的步骤

triggers

Array of Trigger objects

定时任务触发器集合
表5 CreateBuildJobParameter

参数

参数类型

描述

name

String

参数定义名，默认为hudson.model.StringParameterDefinition

params

Array of CreateBuildJobParameterParam objects

构建执行参数子参数
表6 CreateBuildJobParameterParam

参数

参数类型

描述

name

String

参数字段名

value

String

参数字段值

limits

Array of LimitsParam objects

枚举类参数限制
表7 LimitsParam

参数

参数类型

描述

disable

String

是否生效，默认为"0"，为生效状态

display_name

String

参数展示的名字

name

String

参数名字
表8 CreateBuildJobScm

参数

参数类型

描述

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

仓库名称
表9 CreateBuildJobSteps

参数

参数类型

描述

properties

Map<String,Object>

构建步骤属性参数

module_id

String

构建步骤id

name

String

构建步骤名称

version

String

构建步骤版本

enable

Boolean

是否开启
表10 Trigger

参数

参数类型

描述

parameters

Array of ParameterItem objects

自定义参数

name

String

触发器类型
表11 ParameterItem

参数

参数类型

描述

name

String

参数名称

value

String

参数值

状态码： 400

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/job/48c66c6002964721be537cdc6ce0297b/config

响应示例

状态码： 200

OK

{
  "result" : {
    "steps" : null,
    "arch" : "x86-64",
    "project_id" : "a287e712be6c404ca26e5f69040fa12b",
    "job_name" : "oychap213i2",
    "auto_update_sub_module" : "false",
    "flavor" : "2u8g",
    "parameters" : [ {
      "name" : "hudson.model.StringParameterDefinition",
      "params" : [ {
        "name" : "name",
        "value" : "codeBranch",
        "limits" : null
      }, {
        "name" : "type",
        "value" : "normalparam",
        "limits" : null
      }, {
        "name" : "defaultValue",
        "value" : "master",
        "limits" : null
      }, {
        "name" : "description",
        "value" : "Code branch, predefined parameters",
        "limits" : null
      }, {
        "name" : "deletion",
        "value" : "false",
        "limits" : null
      }, {
        "name" : "defaults",
        "value" : "true",
        "limits" : null
      }, {
        "name" : "staticVar",
        "value" : "false",
        "limits" : null
      }, {
        "name" : "sensitiveVar",
        "value" : "false",
        "limits" : null
      } ]
    } ],
    "scms" : [ {
      "branch" : "master",
      "url" : "git@codehub.devcloud.cn-north-7.ulanqab.huawei.com:soso-test00001/an.git",
      "is_auto_build" : false,
      "scm_type" : "codehub",
      "end_point_id" : null,
      "web_url" : "https://devcloud.cn-north-7.ulanqab.huawei.com/codehub/2111746211/home",
      "source" : null,
      "build_type" : "branch",
      "depth" : "1",
      "repo_id" : "2111746211"
    } ],
    "host_type" : "devcloud"
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档