# 查询任务的已选规则集列表V3 - ShowTasksRulesets #### 功能介绍 根据项目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}/rulesets 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]的字符。 **默认取值：** 不涉及。 | | task_id | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | needExtendInfo | 否 | String | **参数解释：** 是否需要扩展信息：未启用语言对应的可选规则集、规则集的名称和使用状态。 **约束限制：** 不涉及。 **取值范围：** - true：需要。 - false：不需要。 **默认取值：** true | | offset | 否 | Integer | **参数解释：** 分页页码，用于指定返回第几页数据，配合limit参数实现分页获取数据。例如，当offset=10且limit=100时，则从第901条数据开始，返回后续100条数据。 **约束限制：** 不涉及。 **取值范围：** 0\~999999 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 每页数量，类似page_size的作用。 **约束限制：** 不涉及。 **取值范围：** 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 [TaskRulesetInfo] objects | **参数解释：** 规则集信息。 | | total | Integer | **参数解释：** 总数。 **取值范围:** 不涉及。 | 表5TaskRulesetInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | template_id | String | **参数解释：** 规则集ID。 **取值范围:** 长度为\[1\~32\]个字符。 | | language | String | **参数解释：** 规则集语言。 **取值范围:** 自定义语言或者系统内置语言，当前支持的系统内置语言有： - ARKTS - C# - CANGJIE - C++ - CSS - GO - HTML - JAVA - JAVASCRIPT - KOTLIN - LUA - PHP - PYTHON - RUST - SCALA - SHELL - SQL - TERRAFORM - TYPESCRIPT - AZURERESOURCEMANAGER - DOCKER - KUBERNETES | | template_name | String | **参数解释：** 规则集名称。 **取值范围:** 任意中英文，数字，点，连字符-及下划线_。长度为\[1\~128\]个字符。 | | type | String | **参数解释：** 规则集选取状态。 **取值范围:** - selected：已选。 - optional：可选，指未开启的语言在当前项目下的默认规则集。 | | status | String | **参数解释：** 规则集属性。 **取值范围:** - 0：用户自定义规则集。 - 1：系统规则集。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/rulesets ``` #### 响应示例 **状态码：200** 请求成功! ``` { "total" : 1, "data" : [ { "template_id" : "111111xxxx3246", "language" : "java", "type" : "selected", "template_name" : "通用检查规则集", "status" : "1" } ] } ``` **状态码：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)。