根据语言查询规则集
功能介绍
根据语言查询规则集。
调用方法
请参见如何调用API。
URI
GET /v1/criterionsets/language
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
language |
是 |
String |
参数解释: 规则集语言。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
search |
否 |
String |
参数解释: 搜索关键字。 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 每页规则集数量。 约束限制: 不涉及。 取值范围: 1-1000 默认取值: 1000 |
|
page |
否 |
Integer |
参数解释: 规则集页数。 约束限制: 不涉及。 取值范围: 0-999 默认取值: 1 |
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,通过查询项目列表接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 32位uuid。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
httpStatus |
String |
参数解释: HTTP响应状态,接口响应成功时为"OK",接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常,BAD_REQUEST是参数校验异常。 取值范围:
|
|
result |
CriterionSetsInfo object |
参数解释: 规则列表。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 接口响应状态。 取值范围:
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
criterionSetList |
Array of CriterionSetListV2Body objects |
参数解释: 规则列表。 取值范围: 不涉及。 |
|
total |
Integer |
参数解释: 规则总数。 取值范围: 大于等于0。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 规则集id。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 规则集中文名称。 取值范围: 不涉及。 |
|
comments |
String |
参数解释: 规则集中文描述。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 规则集类型。 取值范围:
|
|
creator |
String |
参数解释: 规则集创建者。 取值范围: 用户名。 |
|
createTime |
String |
参数解释: 规则集创建时间。 取值范围: 0时区标准时间。 |
|
lastReviser |
String |
参数解释: 规则集最近一次更新的操作人。 取值范围: 用户名。 |
|
lastUpdateTime |
String |
参数解释: 规则集最近一次更新的时间。 取值范围: 0时区标准时间。 |
|
language |
String |
参数解释: 规则集语言。 取值范围:
|
|
parentId |
String |
参数解释: 父规则集id。 取值范围: 32位uuid组成的字符串。多个id之间用逗号分隔。 |
|
numCriterion |
Integer |
参数解释: 规则集中已启用的规则数量。 取值范围: 大于等于0。 |
|
canEdit |
Boolean |
参数解释: 当前用户是否具有修改该规则集的权限。 取值范围:
|
|
canDelete |
Boolean |
参数解释: 当前用户是否具有删除该规则集的权限。 取值范围:
|
|
managers |
String |
参数解释: 规则集管理员。 取值范围: 用户id。多个id由逗号分隔。 |
|
parentSetNames |
String |
参数解释: 父规则集的名称。 取值范围: 多个规则集名称之间用逗号分隔。 |
|
domainId |
String |
参数解释: 租户id。 取值范围: 32位uuid。 |
|
inheritMode |
String |
参数解释: 继承类型。 取值范围:
|
|
creatorId |
String |
参数解释: 创建者用户id。 取值范围: 32位uuid。 |
|
isSystemDefault |
String |
参数解释: 是否为系统默认规则集。 取值范围:
|
|
isProjectDefault |
String |
参数解释: 是否为项目默认规则集。 取值范围:
|
|
isSystemSet |
String |
参数解释: 是否为系统规则集。 取值范围:
|
|
ruleIds |
String |
参数解释: 规则集中已启用的能力规则unique_id。 取值范围: unique_id为32位uuid。多个unique_id之间用逗号分隔。 |
|
region |
String |
参数解释: 规则集所在局点。 取值范围: 不涉及。 |
|
canSetDefault |
Boolean |
参数解释: 是否具有设置默认规则集的权限。 取值范围:
|
|
isUsed |
Boolean |
参数解释: 规则集是否被使用。 取值范围:
|
|
childSets |
Array of strings |
参数解释: 子规则集。 取值范围: 不涉及。 |
|
isReliable |
Boolean |
参数解释: 是否为可信规则集。该字段已弃用。 取值范围:
|
|
isRecommand |
String |
参数解释: 是否为推荐规则集。该字段已弃用。 取值范围:
|
|
isDefault |
Boolean |
参数解释: 是否为默认规则集。该字段已弃用。 取值范围:
|
|
defaultSet |
String |
参数解释: 是否为默认规则集。该字段已弃用。 取值范围:
|
|
deptId |
String |
参数解释: 该字段已弃用。 取值范围: 不涉及。 |
|
deptName |
String |
参数解释: 该字段已弃用。 取值范围: 不涉及。 |
|
reliableTag |
String |
参数解释: 该字段已弃用。 取值范围: 不涉及。 |
|
recommandType |
String |
参数解释: 该字段已弃用。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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.00000000",
"error_msg" : "网络繁忙,请稍后再试。"
}
状态码:401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request Succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。