查询规则基础信息列表 - ListScanRules
功能介绍
功能介绍：查询识别规则基础信息列表，支持分页。 关键参数说明：limit每页数量（默认10），offset分页偏移（默认0）。 返回值说明：返回规则总数及规则基础信息列表（规则ID、名称、类型、类别、是否含白名单）。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/scan-rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID，标识用户在数据安全中心控制台中创建的项目 约束限制： 不涉及 取值范围： 长度为32个字符的字符串 默认取值： 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释： 每页数量限制 约束限制： 不涉及 取值范围： 不涉及 默认取值： 10 |
| offset | 否 | Integer | 参数解释： 分页偏移 约束限制： 不涉及 取值范围： 不涉及 默认取值： 0 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token，用于接口请求鉴权，可通过调用IAM服务查询用户Token接口获取 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释： 总记录数 取值范围： 不涉及 |
| scan_rules_list | Array of ShowScanRuleBasicInfo objects | 参数解释： 扫描规则列表 取值范围： 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rule_id | String | 参数解释： 规则ID 取值范围： 不涉及 |
| project_id | String | 参数解释： 项目ID 取值范围： 不涉及 |
| rule_name | String | 参数解释： 规则名称 取值范围： 不涉及 |
| rule_desc | String | 参数解释： 规则描述 取值范围： 不涉及 |
| rule_type | String | 参数解释： 扫描规则基础信息类型 取值范围： 不涉及 |
| category | String | 参数解释： 类别 取值范围： 不涉及 |
| has_whitelist | Boolean | 参数解释： 是否有白名单 取值范围： true-是，false-否 |
请求示例
查询规则基础信息列表
/v1/2b31ed520aabbccddeedb6e5712345678/scan-rules
响应示例
状态码：200
{
"total" : 2,
"scan_rules_list" : [ {
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"project_id" : "2d52d09a-f0d3-4c1a-86b4-fc7e435e9c7a",
"rule_name" : "classification-rule-01",
"rule_desc" : "scan-rule-01",
"rule_type" : "KEYWORD",
"category" : "BUILT_IN",
"has_whitelist" : true
}, {
"rule_id" : "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e",
"project_id" : "2d52d09a-f0d3-4c1a-86b4-fc7e435e9c7a",
"rule_name" : "classification-rule-01",
"rule_desc" : "scan-rule-01",
"rule_type" : "KEYWORD",
"category" : "BUILT_IN",
"has_whitelist" : true
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。
