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

获取编译构建默认参数

功能介绍

获取编译构建默认参数

调用方法

请参见如何调用API。

URI

GET /v1/job/default-parameters

请求参数

无

响应参数

状态码： 200

表1 响应Body参数

参数

参数类型

描述

result

Array of result objects

参数

status

String

返回状态信息
表2 result

参数

参数类型

描述

name

String

参数定义

params

Array of params objects

参数元数据列表
表3 params

参数

参数类型

描述

name

String

参数元数据

value

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

错误描述

请求示例

GET https://{endpoint}/v1/job/default-parameters

响应示例

状态码： 200

OK

{
  "result" : [ {
    "name" : "hudson.model.StringParameterDefinition",
    "params" : [ {
      "name" : "name",
      "value" : "codeBranch"
    }, {
      "name" : "type",
      "value" : "normalparam"
    }, {
      "name" : "defaultValue",
      "value" : "master"
    }, {
      "name" : "description",
      "value" : "Code branch, predefined parameters"
    }, {
      "name" : "deletion",
      "value" : "false"
    }, {
      "name" : "defaults",
      "value" : "true"
    } ]
  } ],
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档