
# 查询检测规则列表 - ListCheckFeatureRule
#### 功能介绍
查询检测规则列表：查询默认检测规则信息，包含14种检测规则，默认都不开启。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
GET /v5/{project_id}/rasp/rule
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述   |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID |
   
表2Query参数 
| 参数                    | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| enterprise_project_id | 是    | String | 企业项目ID，查询所有企业项目时填写：all_granted_eps                                                                                                                                                                                                                                                                                                                                                                        |
| os_type               | 否    | String | 操作系统类型，包含如下2种。 - Linux   - Windows    |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                               |
|:---|:---|:---|:---|
| x-auth-token | 是    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数        | 参数类型                                                                                | 描述       |
|:---|:---|:---|
| total_num | Integer                                                                             | 总数       |
| data_list | Array of [FeatureRuleInfo] objects | 检测特性规则列表 |
   
 表5FeatureRuleInfo 
| 参数                         | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|
| chk_feature_id             | Integer | 检测特性规则ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| chk_feature_name           | String  | 检测特性规则标识                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| chk_feature_desc           | String  | 检测特性规则描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| os_type                    | String  | **参数解释**: 策略支持的操作系统 **取值范围**: 包含如下： - Windows : Windows系统   - Linux : Linux系统    |
| feature_configure          | String  | 检测特性规则配置信息                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| optional_protective_action | Integer | 可选防护动作，包含如下 -1 检测 -2 检测并阻断/拦截 -3 都可以                                                                                                                                                                                                                                                                                                                                                                                                                 |
| protective_action          | Integer | 默认防护动作，包含如下 -1 检测 -2 检测并阻断/拦截                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| editable                   | Integer | 是否可编辑配置信息，包含如下 -0 否 -1 是                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
请求已成功
```
{
  "total_num" : 2,
  "data_list" : [ {
    "chk_feature_id" : 1,
    "chk_feature_name" : "zeroDay",
    "chk_feature_desc" : "command's stacks in the zeroDay blackList",
    "feature_configure" : "/guiserver/rule/create;/guiserver/rule/update",
    "optional_protective_action" : 3,
    "protective_action" : 1,
    "editable" : 1,
    "os_type" : "Linux"
  } ]
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.BasicCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.hss.v5.region.HssRegion;
  import com.huaweicloud.sdk.hss.v5.*;
  import com.huaweicloud.sdk.hss.v5.model.*;
  public class ListCheckFeatureRuleSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          String projectId = "{project_id}";
          ICredential auth = new BasicCredentials()
                  .withProjectId(projectId)
                  .withAk(ak)
                  .withSk(sk);
          HssClient client = HssClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                  .build();
          ListCheckFeatureRuleRequest request = new ListCheckFeatureRuleRequest();
          try {
              ListCheckFeatureRuleResponse response = client.listCheckFeatureRule(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import BasicCredentials
  from huaweicloudsdkhss.v5.region.hss_region import HssRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdkhss.v5 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      projectId = "{project_id}"
      credentials = BasicCredentials(ak, sk, projectId)
      client = HssClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(HssRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = ListCheckFeatureRuleRequest()
          response = client.list_check_feature_rule(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
      hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      projectId := "{project_id}"
      auth, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := hss.HssClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := hss.NewHssClient(hcClient)
      request := &model.ListCheckFeatureRuleRequest{}
  response, err := client.ListCheckFeatureRule(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListCheckFeatureRule&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 请求已成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。
