查询规则集列表
功能介绍
根据项目ID、语言等条件查询规则集列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/rulesets
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
category |
否 |
String |
规则集类别 '0只查询系统规则集，1只查询当前用户自定义规则集，2只查询其他用户自定义规则集，'0,1,2'或''查所有' |
offset |
否 |
Integer |
分页索引，偏移量 最小值：0 缺省值：0 |
limit |
否 |
Integer |
每页显示的数量 最小值：1 最大值：1000 缺省值：100 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
info |
Array of RulesetItem objects |
规则集列表信息 |
total |
Integer |
总数 |
参数 |
参数类型 |
描述 |
|---|---|---|
template_id |
String |
规则集id |
language |
String |
规则集语言 |
template_name |
String |
规则集名称 |
creator_id |
String |
创建者id |
creator_name |
String |
创建人名称 |
template_create_time |
String |
创建人时间 |
is_used |
String |
使用状态1使用中，0空闲中 |
rule_ids |
String |
规则集包含的规则id |
is_default |
String |
是否该语言默认规则集，0不是，1是 |
is_devcloud_project_default |
String |
是否是项目下语言默认规则集，0不是，1是 |
is_default_template |
String |
是否是系统规则集，0不是，1是 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v2/{project_id}/rulesets
响应示例
状态码： 200
Request succeeded!
{
"info" : [ {
"template_id" : "9698e0cb9d2441c3bd8cec5f8641696e",
"language" : "Java",
"template_name" : "test1111",
"creator_id" : "ae161856f2604229ae12056478a7919f",
"creator_name" : "杨老板",
"template_create_time" : "2021-10-21T02:14:55Z",
"is_used" : "0",
"rule_ids" : "",
"is_default" : "0",
"is_default_template" : "1",
"is_devcloud_project_default" : "0"
}, {
"template_id" : "9698e0cb9d2441c3bd8cec5f8641696e",
"language" : "cpp",
"template_name" : "test222",
"creator_id" : "ae161856f2604229ae12056478a7919f",
"creator_name" : "杨老板",
"template_create_time" : "2021-10-21T02:14:55Z",
"is_used" : "1",
"rule_ids" : "11152,11153,11154,11155",
"is_default" : "0",
"is_default_template" : "1",
"is_devcloud_project_default" : "1"
} ],
"total" : 2
}
状态码： 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 |
错误码
请参见错误码。
