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

查看系统预定义参数

功能介绍

查看系统预定义参数

调用方法

请参见如何调用API。

URI

GET /v1/job/system-parameters

请求参数

无

响应参数

状态码： 200

表1 响应Body参数

参数

参数类型

描述

status

String

状态

error

Object

错误

result

Array of result objects

本次任务的构建步骤详情，返回的步骤为页面可见步骤
表2 result

参数

参数类型

描述

id

String

编号

parameter_name

String

参数名称

description

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

错误描述

请求示例

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

响应示例

状态码： 200

OK

{
  "result" : [ {
    "id" : 6,
    "parameter_name" : "BUILDNUMBER",
    "description" : "In the format of Date.Builds run on that day"
  } ],
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档