# 查询规则基础信息列表 - ListScanRules
#### 功能介绍
功能介绍：查询规则基础信息列表
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
GET /v1/{project_id}/scan-rules
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32。 **默认取值：** 不涉及 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| limit  | 否    | Integer | **参数解释：** 每页数量限制 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 10 |
| offset | 否    | Integer | **参数解释：** 分页偏移 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 0    |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数              | 参数类型                                                                                     | 描述                                                                                                                                |
|:---|:---|:---|
| total           | Long                                                                                     | **参数解释：** 总记录数 **取值范围：** 不涉及   |
| scan_rules_list | Array of [ShowScanRuleBasicInfo] objects | **参数解释：** 扫描规则列表 **取值范围：** 不涉及 |
   
 表5ShowScanRuleBasicInfo 
| 参数            | 参数类型    | 描述                                                                                                                                           |
|:---|:---|:---|
| 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/2b31ed520xxxxxxebedb6e57xxxxxxxx/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 | 请求已成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。