获取系统参数
功能介绍
获取全局默认的系统参数。
调用方法
请参见如何调用API。
URI
GET /v3/system/configs
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of QuerySystemConfig objects |
参数解释: 系统参数列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 系统参数名称。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 系统参数类型。 取值范围: text: 文本类型。 |
|
description |
String |
参数解释: 系统参数描述。 取值范围: 不涉及。 |
|
pipeline_source |
String |
参数解释: 流水线传递的来源信息。 取值范围: Artifact: 来源信息为CodeArtsArtifact。 |
|
pipeline_source_type |
String |
参数解释: 流水线源的制品仓库类型。 取值范围:
|
|
static_status |
Boolean |
参数解释: 系统参数是否静态参数。 取值范围:
|
请求示例
获取全局默认的系统参数。
https://{endpoint}/v3/system/configs
响应示例
状态码:200
OK,查询系统参数响应成功。
[ {
"name" : "CODEARTS_ARTIFACT_FILE",
"type" : "text",
"description" : "部署来源软件发布库中的首层目录",
"pipeline_source" : "Artifact",
"pipeline_source_type" : "generic",
"static_status" : false
} ]
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK,查询系统参数响应成功。 |
错误码
请参见错误码。