更新时间:2024-11-08 GMT+08:00
分享

查询防护策略列表

功能介绍

查询防护策略列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/waf/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

page

Integer

分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。

pagesize

Integer

分页查询时,每页包含多少条结果。范围1-100,默认值为10,表示每页包含10条结果。

name

String

策略名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

防护策略的数量

items

Array of PolicyResponse objects

防护策略的具体内容

表5 PolicyResponse

参数

参数类型

描述

id

String

防护策略id

name

String

防护策略名

level

Integer

Web基础防护等级

  • 1 : 宽松,防护粒度较粗,只拦截攻击特征比较明显的请求。当误报情况较多的场景下,建议选择“宽松”模式。

  • 2:中等,默认为“中等”防护模式,满足大多数场景下的Web防护需求。

  • 3:严格,防护粒度最精细,可以拦截具有复杂的绕过特征的攻击请求,例如jolokia网络攻击、探测CGI漏洞、探测 Druid SQL注入攻击

full_detection

Boolean

精准防护中的检测模式。

  • false:短路检测,当用户的请求符合精准防护中的拦截条件时,便立刻终止检测,进行拦截

  • true :全检测,请求符合精准防护中的拦截条件时,全检测不会立即拦截,会继续执行其他防护的检测,最后进行拦截。

robot_action

Action object

用于存放网站反爬虫中特征反爬虫动作信息

action

PolicyAction object

防护动作信息

options

PolicyOption object

该参数存放防护策略里防护项的开关信息

modulex_options

Map<String,Object>

智能访问控制防护项相关配置信息,目前该特性还处于公测阶段,只有部分局点支持该特性

hosts

Array of strings

与防护策略绑定的防护的域名id数组

bind_host

Array of BindHost objects

与防护策略绑定的防护的域名信息数组,相对于hosts字段,包含更详细的域名信息

extend

Map<String,String>

扩展字段,用于存放Web基础防护中一些开关配置等信息

timestamp

Long

创建防护策略的时间

表6 Action

参数

参数类型

描述

category

String

特征反爬虫中防护动作信息

  • log:仅记录

  • block:拦截

表7 PolicyAction

参数

参数类型

描述

category

String

web基础防护动作(log为仅记录、block为拦截)

followed_action_id

String

攻击惩罚规则ID

表8 PolicyOption

参数

参数类型

描述

webattack

Boolean

基础防护是否开启

common

Boolean

常规检测是否开启

crawler

Boolean

预留参数,该参数值一直为true,用户可忽略该参数值

crawler_engine

Boolean

搜索engine是否开启

crawler_scanner

Boolean

反爬虫检测是否开启

crawler_script

Boolean

脚本反爬虫是否开启

crawler_other

Boolean

其他爬虫是否开启

webshell

Boolean

Webshell检测是否开启

cc

Boolean

cc规则是否开启

custom

Boolean

精准防护是否开启

whiteblackip

Boolean

黑白名单防护是否开启

geoip

Boolean

地理位置访问控制规则是否开启

ignore

Boolean

误报屏蔽是否开启

privacy

Boolean

隐私屏蔽是否开启

antitamper

Boolean

网页防篡改规则是否开启

antileakage

Boolean

防敏感信息泄露规则是否开启

bot_enable

Boolean

网站反爬虫总开关是否开启

modulex_enabled

Boolean

modulex智能cc防护是否开启,该特性是公测特性,在公测期间,只支持仅记录模式。

表9 BindHost

参数

参数类型

描述

id

String

域名ID

hostname

String

域名

waf_type

String

域名对应模式:cloud(云模式)/premium(独享模式)

mode

String

仅独享模式涉及特殊域名模式

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表13 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表15 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

获取项目id为project_id的防护策略列表。

GET https://{Endpoint}/v1/{project_id}/waf/policy?enterprise_project_id=0

响应示例

状态码: 200

请求成功

{
  "total" : 1,
  "items" : [ {
    "id" : "41cba8aee2e94bcdbf57460874205494",
    "name" : "policy_2FHwFOKz",
    "level" : 2,
    "action" : {
      "category" : "log"
    },
    "options" : {
      "webattack" : true,
      "common" : true,
      "crawler" : true,
      "crawler_engine" : false,
      "crawler_scanner" : true,
      "crawler_script" : false,
      "crawler_other" : false,
      "webshell" : false,
      "cc" : true,
      "custom" : true,
      "whiteblackip" : true,
      "geoip" : true,
      "ignore" : true,
      "privacy" : true,
      "antitamper" : true,
      "antileakage" : false,
      "bot_enable" : true,
      "modulex_enabled" : false
    },
    "hosts" : [ ],
    "extend" : { },
    "timestamp" : 1650527546218,
    "full_detection" : false,
    "bind_host" : [ ]
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class ListPolicySolution {

    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);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPolicyRequest request = new ListPolicyRequest();
        try {
            ListPolicyResponse response = client.listPolicy(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPolicyRequest()
        response = client.list_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPolicyRequest{}
	response, err := client.ListPolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

相关文档