批量根据规则集id查询配置项
功能介绍
批量根据规则集id查询配置项。
调用方法
请参见如何调用API。
URI
POST /v1/config-items
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ids |
是 |
Array of strings |
参数解释： 规则集id列表。通过查询规则集列表接口可获取到规则集ID。 约束限制： 不涉及。 取值范围： 32位字符串列表。 默认取值： 不涉及。 |
|
toolVersion |
否 |
String |
参数解释： 工具版本。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 当前环境最新版本。 |
|
arch |
否 |
String |
参数解释： 当前环境类型。 约束限制： 不涉及。 取值范围：
默认取值： X86 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
httpStatus |
String |
参数解释： HTTP响应状态，接口响应成功时为"OK"，接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常，BAD_REQUEST是参数校验异常。 取值范围：
|
|
result |
ConfigItemInfo object |
参数解释： 编译参数列表。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 接口响应状态。 取值范围：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释： 配置参数key。 取值范围： 不涉及。 |
|
name |
String |
参数解释： 配置参数名称。 取值范围： 不涉及。 |
|
defaulValue |
String |
参数解释： 参数默认值。 取值范围： 不涉及。 |
|
description |
String |
参数解释： 参数解释。 取值范围： 不涉及。 |
|
toolNames |
String |
参数解释： 关联的引擎名称。 取值范围： 不涉及。 |
|
options |
Array of strings |
参数解释： 参数选项。 取值范围： 不涉及。 |
|
option |
String |
参数解释： 参数选项，多个选项用逗号分隔。 取值范围： 不涉及。 |
|
setIds |
String |
参数解释： 规则集id，多个id用逗号分隔。 取值范围： 不涉及。 |
|
languages |
String |
参数解释： 编译参数对应的语言。 取值范围： 不涉及。 |
|
compileMap |
Map<String,String> |
参数解释： map格式。
取值范围： 不涉及。 |
|
descriptionMap |
Map<String,String> |
参数解释： map格式。
取值范围： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
POST https://{endpoint}/v1/config-items
{
"ids" : [ "24b97exxxxxxxxfb912625b14cxxxxxx", "24b97exxxxxxxxfb91cc25b14cxxxxxx" ],
"toolVersion" : "202507",
"arch" : "X86"
}
响应示例
状态码：200
Request Succeeded!
{
"httpStatus" : "OK",
"result" : [ {
"configId" : "73dc3cb0bd3811ebad2ffa163efbc7ea",
"defaulValue" : "jdk8",
"description" : "检查时会使用配置的jdk版本来运行工具。可选值为jdk8、jdk11、jdk17。不填则缺省值为jdk8\r\n。<br>详情请参考：https://his.huawei.com/doc/#/page.html?service_code=hrn:his:servicemarket::service:codecheck&group_id=c86dec7aec984218a65a9c7c4f24b572&lang=zh_CN</br>",
"id" : "d2a19e9ef62649d3bc69a0faa162fdf0",
"isRequired" : false,
"isShowInIDE" : false,
"key" : "jdkVersion",
"name" : "[spotbugs]jdk版本",
"required" : false,
"showInIDE" : false,
"toolName" : "spotbugs",
"toolNames" : "spotbugs",
"type" : "0"
} ],
"status" : "success"
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试。"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request Succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
