# 查询任务规则集的检查参数v3 - CheckRulesetParameters #### 功能介绍 根据项目ID、任务ID、规则集ID和规则集语言分页查询任务规则集的检查参数，返回检查工具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:task:get | Read | task \* | - | - | - | | codeartscheck:task:get | Read | - | codeartscheck:ProjectId | - | - | #### URI GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 32位项目ID。 **默认取值：** 不涉及。 | | task_id | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | ruleset_id | 是 | String | **参数解释:** 规则集ID，通过[查询规则集列表](https://support.huaweicloud.com/api-codecheck/ListRulesets.html)接口可获取到规则集ID。 **约束限制:** 不涉及。 **取值范围:** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | language | 是 | String | **参数解释：** 规则集语言。 **约束限制:** 不涉及。 **取值范围：** - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 偏移量。 **约束限制：** 不涉及。 **取值范围：** ≥0 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 每页显示的数量。 **约束限制：** 不涉及。 **取值范围：** 1\~1000 **默认取值：** 10 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Array of [TaskCheckParameters] objects | **参数解释：** 历史记录数据。 | | total | Integer | **参数解释：** 总数。 **取值范围:** ≥0 | 表5TaskCheckParameters | 参数 | 参数类型 | 描述 | |:---|:---|:---| | check_id | Integer | **参数解释：** 检查工具ID。 **取值范围:** ≥0 | | name | String | **参数解释：** 编译参数名称。 **取值范围:** 不涉及。 | | checker_configs | Array of [CheckConfigInfo] objects | **参数解释：** 检查参数配置信息。 | 表6CheckConfigInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 检查参数名称。 **取值范围:** 不涉及。 | | cfg_key | String | **参数解释：** 检查参数对应的Key值。 **取值范围:** 不涉及。 | | default_value | String | **参数解释：** 检查参数默认值。 **取值范围:** 不涉及。 | | option_value | String | **参数解释：** 检查参数可选项。 **取值范围:** 不涉及。 | | is_required | Integer | **参数解释：** 是否必填参数。 **取值范围:** - 0：非必填。 - 1：必填。 | | description | String | **参数解释：** 检查参数说明。 **取值范围:** 不涉及。 | | type | Integer | **参数解释：** 参数类型。 **取值范围:** - 0：文本。 - 2：有可选项。 | | status | String | **参数解释：** 参数状态。 **取值范围:** - on：启用。 - off：未启用。 | | value | String | **参数解释：** 检查参数值。 **取值范围:** 不涉及。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters ``` #### 响应示例 **状态码：200** 请求成功! ``` { "total" : 1, "data" : [ { "check_id" : 0, "name" : "compile_tool", "checker_configs" : [ { "value" : "", "name" : "编译命令", "cfg_key" : "", "default_value" : "", "option_value" : "", "is_required" : 0, "description" : "编译命令", "type" : 0, "status" : "on" } ] } ] } ``` **状态码：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)。