查询规则集列表-V3
功能介绍
根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/rulesets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,通过查询项目列表接口查询项目列表获取 约束限制: 不涉及。 取值范围: 32位uuid。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
category |
否 |
String |
参数解释: 规则集类别。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
offset |
否 |
Integer |
参数解释: 分页索引,偏移量 约束限制: 不涉及 取值范围: 0-999 |
|
limit |
否 |
Integer |
参数解释: 分页查询,每页显示的数量 约束限制: 不涉及 取值范围: 0-50 |
|
need_selected_status |
否 |
String |
参数解释: 是否查询规则集使用状态。 约束限制: 不涉及。 取值范围:
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
info |
Array of RulesetItem objects |
参数解释: 规则集列表信息。 取值范围: 不涉及。 |
|
total |
Integer |
参数解释: 规则集总数。 取值范围: 大于等于0。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_id |
String |
参数解释: 规则集id。 取值范围: 32位uuid。 |
|
language |
String |
参数解释: 规则集语言。 取值范围: 当前支持的语言有:ARKTS,C#,C++,CSS,GO,HTML,JAVA,JAVASCRIPT,KOTLIN,LUA,PHP,PYTHON,RUST,SCALA,SHELL,SQL,TYPESCRIPT。 |
|
template_name |
String |
参数解释: 规则集语言。 取值范围: 任意中英文,数字,点,连字符-及下划线_组成的字符串。 |
|
creator_id |
String |
参数解释: 创建者的user_id,值来源于iam的用户id。 取值范围: 32位uuid。 |
|
creator_name |
String |
参数解释: 创建人名称,值来源于IAM用户名称。 取值范围: IAM用户名称。 |
|
template_create_time |
String |
参数解释: 创建时间,时区统一为0时区。 取值范围: 0时区时间。 |
|
is_used |
String |
参数解释: 使用状态。 取值范围:
|
|
rule_ids |
String |
参数解释: 规则集包含的规则id,每条规则都有1个唯一的规则id。 取值范围: 32位uuid列表,多个uuid以英文逗号分隔。 |
|
is_default |
String |
参数解释: 规则集是否是该语言默认规则集。 取值范围:
|
|
is_devcloud_project_default |
String |
参数解释: 规则集是否是项目下该语言默认规则集。 取值范围:
|
|
is_default_template |
String |
参数解释: 规则集是否是系统规则集。 取值范围:
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v3/{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 |
错误码
请参见错误码。