# 根据规则集ID列表查询配置项 - ListConfigItemsByCriSetIds #### 功能介绍 该API用于查询规则集里的规则关联的配置信息。该接口支持传多个规则集ID。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck::getRuleSet | Read | - | - | - | - | #### URI POST /v1/config-items #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ids | 是 | Array of strings | **参数解释：** 规则集ID列表。通过[查询规则集列表](https://support.huaweicloud.com/api-codecheck/ListRulesets.html)接口可获取到规则集ID。 **约束限制：** 不涉及。 **取值范围：** 32位字符串列表。 **默认取值：** 不涉及。 | | toolVersion | 否 | String | **参数解释：** 工具版本。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 当前环境最新版本。 | | arch | 否 | String | **参数解释：** 当前环境类型。 **约束限制：** 不涉及。 **取值范围：** - X86：X86环境。 - ARM：ARM环境。 **默认取值：** X86 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | httpStatus | String | **参数解释：** HTTP响应状态。 **取值范围：** - OK：请求已成功处理，服务器返回了请求的资源或操作结果。 - ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。 - INTERNAL_SERVER_ERROR：接口内部异常。 - BAD_REQUEST：参数校验异常。 | | result | [ConfigItemInfo] object | **参数解释：** 编译参数列表。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 接口响应状态。 **取值范围：** - success：接口响应成功。 - error：接口响应失败。 | 表4ConfigItemInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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\ | **参数解释：** map格式。 - key：编译工具名称。 - value：编译工具版本或者编译命令。 **取值范围：** 不涉及。 | | descriptionMap | Map\ | **参数解释：** map格式。 - key：编译工具名称。 - value：编译命令提示信息。 **取值范围：** 不涉及。 | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v1/config-items { "ids" : [ "24b97exxxxxxxxfb912625b14cxxxxxx", "24b97exxxxxxxxfb91cc25b14cxxxxxx" ], "toolVersion" : "202507", "arch" : "X86" } ``` #### 响应示例 **状态码：200** 请求成功! ``` { "httpStatus" : "OK", "result" : [ { "configId" : "73dc3cb0bd3811ebad2ffa163efbc7ea", "defaulValue" : "jdk8", "description" : "检查时会使用配置的jdk版本来运行工具。可选值为jdk8、jdk11、jdk17。不填则缺省值为jdk8\r\n。
详情请参考：https://his.huawei.com/doc/#/page.html?service_code=hrn:his:servicemarket::service:codecheck&group_id=c86dec7aec984218a65a9c7c4f24b572&lang=zh_CN
", "id" : "d2a19e9ef62649d3bc69a0faa162fdf0", "isRequired" : false, "isShowInIDE" : false, "key" : "jdkVersion", "name" : "[spotbugs]jdk版本", "required" : false, "showInIDE" : false, "toolName" : "spotbugs", "toolNames" : "spotbugs", "type" : "0" } ], "status" : "success" } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确。" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期。" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。