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

流水线查看构建任务信息

功能介绍

流水线查看构建任务信息

调用方法

请参见如何调用API。

URI

GET /v1/job/{job_id}/pipeline-info

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

构建的任务ID；

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

参数

是否必选

参数类型

描述

all

否

String

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

check_param_used

否

String

移除未使用的参数

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

result

JobPipelineInfoItems object

流水线查看构建任务信息结果

error

String

返回错误信息

status

String

返回状态信息
表4 JobPipelineInfoItems

参数

参数类型

描述

scms

Array of CreateBuildJobScm objects

构建执行SCM

parameters

parameters object

参数

job_name

String

任务名称

job_name_massage

String

任务名称信息

job_name_regex

String

任务名称正则

source_code

String

任务名称正则
表5 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

仓库名称
表6 parameters

参数

参数类型

描述

region

String

地域

language

String

语言

name

String

名称

params

Array of JobPipelineInfoParamsItems objects

参数值
表7 JobPipelineInfoParamsItems

参数

参数类型

描述

name

String

参数名称

value

String

参数值

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/job/901878212b1a49be9c1a1054c272762a/pipeline-info

响应示例

状态码： 200

OK

{
  "result" : {
    "scms" : [ {
      "url" : "git@codehub.devcloud.cn-north-7.ulanqab.huawei.com:b4d3971c3988463b865f6f920846149e/aaa/Unit.git",
      "branch" : "master",
      "depth" : "1",
      "is_auto_build" : false,
      "repo_id" : "2111898074",
      "scm_type" : "codehub",
      "build_type" : "branch",
      "group_name" : "b4d3971c3988463b865f6f920846149e/aaa",
      "repo_name" : "Unit",
      "web_url" : "https://devcloud.cn-north-7.ulanqab.huawei.com/codehub/2111898074/home"
    } ],
    "parameters" : {
      "name" : "hudson.model.StringParameterDefinition",
      "params" : [ {
        "name" : "name",
        "value" : "codeBranch"
      } ]
    },
    "job_name" : "testJobName",
    "job_name_massage" : "Enter a maximum of 115 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.",
    "job_name_regex" : "",
    "source_code" : "codeci"
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档