文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 规则管理/ 根据语言查询规则集 - ListCriterionSetsByLanguage
更新时间:2025-12-30 GMT+08:00
分享

根据语言查询规则集 - ListCriterionSetsByLanguage

功能介绍

该API用于查询项目下某一语言的规则集列表。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartscheck::listRuleSets

List

-

-

-

-

URI

GET /v1/criterionsets/language

表1 Query参数

参数

是否必选

参数类型

描述

language

String

参数解释:

规则集语言。

约束限制:

不涉及。

取值范围:

当前支持的语言有:

  • ARKTS

  • C#

  • CANGJIE

  • C++

  • CSS

  • GO

  • HTML

  • JAVA

  • JAVASCRIPT

  • KOTLIN

  • LUA

  • PHP

  • PYTHON

  • RUST

  • SCALA

  • SHELL

  • SQL

  • TERRAFORM

  • TYPESCRIPT

默认取值:

不涉及。

search

String

参数解释:

搜索关键字。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

page_size

Integer

参数解释:

每页规则集数量。

约束限制:

不涉及。

取值范围:

1-1000

默认取值:

1000

page

Integer

参数解释:

规则集页数。

约束限制:

不涉及。

取值范围:

0-999

默认取值:

1

project_id

String

参数解释:

项目的32位UUID,通过查询项目列表接口获取。

约束限制:

不涉及。

取值范围:

32位UUID。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

长度为[1~100000]个字符。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释:

HTTP响应状态。

取值范围:

  • OK:请求已成功处理,服务器返回了请求的资源或操作结果。

  • ACCEPTED:请求已被服务器接受,但处理尚未完成(通常用于异步操作)。

  • INTERNAL_SERVER_ERROR:接口内部异常。

  • BAD_REQUEST:参数校验异常。

result

CriterionSetsInfo object

参数解释:

规则列表。

取值范围:

不涉及。

status

String

参数解释:

接口响应状态。

取值范围:

  • success:接口响应成功。

  • error:接口响应失败。

表4 CriterionSetsInfo

参数

参数类型

描述

criterionSetList

Array of CriterionSetListV2Body objects

参数解释:

规则列表。

取值范围:

不涉及。

total

Integer

参数解释:

规则总数。

取值范围:

≥0

表5 CriterionSetListV2Body

参数

参数类型

描述

id

String

参数解释:

规则集ID。

取值范围:

不涉及。

name

String

参数解释:

规则集中文名称。

取值范围:

不涉及。

comments

String

参数解释:

规则集中文描述。

取值范围:

不涉及。

type

String

参数解释:

规则集类型。

取值范围:

  • system:系统规则集。

  • custom:自定义规则集。

creator

String

参数解释:

规则集创建者。

取值范围:

用户名。

createTime

String

参数解释:

规则集创建时间。

取值范围:

0时区标准时间。

lastReviser

String

参数解释:

规则集最近一次更新的操作人。

取值范围:

用户名。

lastUpdateTime

String

参数解释:

规则集最近一次更新的时间。

取值范围:

0时区标准时间。

language

String

参数解释:

规则集语言。

取值范围:

  • ARKTS

  • C#

  • CANGJIE

  • C++

  • CSS

  • GO

  • HTML

  • JAVA

  • JAVASCRIPT

  • KOTLIN

  • LUA

  • PHP

  • PYTHON

  • RUST

  • SCALA

  • SHELL

  • SQL

  • TERRAFORM

  • TYPESCRIPT

parentId

String

参数解释:

父规则集ID。

取值范围:

32位UUID组成的字符串。多个ID之间用逗号分隔。

numCriterion

Integer

参数解释:

规则集中已启用的规则数量。

取值范围:

≥0

canEdit

Boolean

参数解释:

当前用户是否具有修改该规则集的权限。

取值范围:

  • true:有编辑的权限。

  • false:没有编辑的权限。

canDelete

Boolean

参数解释:

当前用户是否具有删除该规则集的权限。

取值范围:

  • true:有删除的权限。

  • false:没有删除的权限。

managers

String

参数解释:

规则集管理员。

取值范围:

用户ID。多个ID用逗号分隔。

parentSetNames

String

参数解释:

父规则集的名称。

取值范围:

多个规则集名称之间用逗号分隔。

domainId

String

参数解释:

租户ID。

取值范围:

32位UUID。

inheritMode

String

参数解释:

继承类型。

取值范围:

  • strong:继承。

  • null:非继承。

creatorId

String

参数解释:

创建者用户ID。

取值范围:

32位UUID。

isSystemDefault

String

参数解释:

是否为系统默认规则集。

取值范围:

  • 0:否。

  • 1:是。

isProjectDefault

String

参数解释:

是否为项目默认规则集。

取值范围:

  • 0:否。

  • 1:是。

isSystemSet

String

参数解释:

是否为系统规则集。

取值范围:

  • 0:否。

  • 1:是。

ruleIds

String

参数解释:

规则集中已启用的能力规则unique_id。

取值范围:

unique_id为32位UUID。多个unique_id之间用逗号分隔。

region

String

参数解释:

规则集所在局点。

取值范围:

不涉及。

canSetDefault

Boolean

参数解释:

是否具有设置默认规则集的权限。

取值范围:

  • true:有权限。

  • false:没有权限。

isUsed

Boolean

参数解释:

规则集是否被使用。

取值范围:

  • true:是。

  • false:否。

childSets

Array of strings

参数解释:

子规则集。

取值范围:

不涉及。

isReliable

Boolean

参数解释:

是否为可信规则集。该字段已弃用。

取值范围:

  • true:是。

  • false:否。

isRecommand

String

参数解释:

是否为推荐规则集。该字段已弃用。

取值范围:

  • 1:是。

  • 0:否。

isDefault

Boolean

参数解释:

是否为默认规则集。该字段已弃用。

取值范围:

  • true:是。

  • false:否。

defaultSet

String

参数解释:

是否为默认规则集。该字段已弃用。

取值范围:

  • "true":是。

  • "false":否。

deptId

String

参数解释:

该字段已弃用。

取值范围:

不涉及。

deptName

String

参数解释:

该字段已弃用。

取值范围:

不涉及。

reliableTag

String

参数解释:

该字段已弃用。

取值范围:

不涉及。

recommandType

String

参数解释:

该字段已弃用。

取值范围:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v1/criterionsets/language?project_id=8c7c74775f4f496596e4a39d34b209c3&language=JAVA

响应示例

状态码:200

Request Succeeded!

{
  "httpStatus" : "OK",
  "result" : {
    "criterionSetList" : [ {
      "canDelete" : false,
      "canEdit" : false,
      "childSets" : [ ],
      "comments" : "",
      "createTime" : "2020-11-13 15:36:01.0",
      "creator" : "SYSTEM",
      "creatorId" : "",
      "deptId" : "",
      "deptName" : "",
      "folder" : "三层运营规则集/JAVA语言原生工具规则集/",
      "id" : "8dd7fcc36f4b497f874984644deea64a",
      "isProjectDefault" : "0",
      "isRecommand" : "0",
      "isReliable" : true,
      "isSystemDefault" : "0",
      "isSystemSet" : "0",
      "language" : "JAVA",
      "lastReviser" : "SYSTEM",
      "lastUpdateTime" : "2020-11-13 15:36:01",
      "managers" : "",
      "name" : "Checkstyle",
      "numCriterion" : 0,
      "order" : 37,
      "parentFolderId" : "891db33c55e944b7b418bb2423af5491",
      "parentId" : "891db33c55e944b7b418bb2423af5491",
      "parentSetNames" : "",
      "recommandType" : "0",
      "reliableTag" : "",
      "type" : "tool"
    } ],
    "total" : 1
  },
  "status" : "success"
}

状态码:400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确。"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期。"
}

状态码

状态码

描述

200

Request Succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档